Merge pull request #2 from girishgoudapatil/master

Added API Documentation
monkeypants · Aug 2, 2016 · 9646694 · 9646694
2 parents 1ec26f2 + 8ba4e3a
commit 9646694
Show file tree

Hide file tree

Showing 72 changed files with 3,649 additions and 0 deletions.
diff --git a/etherium/api/apidoc.json b/etherium/api/apidoc.json
@@ -0,0 +1,8 @@
+{
+  "name": "blockchain-ack",
+  "version": "1.0.0",
+  "description": "Blockchain API Documentation",
+  "title": "Blockchain API Documentation",
+  "url" : "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api",
+  "sampleUrl": "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api"
+}
diff --git a/etherium/api/apidoc/api_data.js b/etherium/api/apidoc/api_data.js
diff --git a/etherium/api/apidoc/api_data.json b/etherium/api/apidoc/api_data.json
@@ -0,0 +1 @@
+[  {    "type": "get",    "url": "/ack/:address",    "title": "Get Ack data",    "name": "GetAckData",    "group": "ACK",    "parameter": {      "fields": {        "Parameter": [          {            "group": "Parameter",            "type": "String",            "optional": false,            "field": "address",            "description": "<p>ack contract address</p>"          }        ]      }    },    "success": {      "fields": {        "Success 200": [          {            "group": "Success 200",            "type": "String",            "optional": false,            "field": "payload_hash",            "description": "<p>Hashed payload of the invoice</p>"          },          {            "group": "Success 200",            "type": "String",            "optional": false,            "field": "url",            "description": "<p>URL to the ack</p>"          },          {            "group": "Success 200",            "type": "Number",            "optional": false,            "field": "code",            "description": "<p>Ack State.</p>"          },          {            "group": "Success 200",            "type": "Number",            "optional": false,            "field": "gw_datetime",            "description": "<p>Gateway datetime</p>"          },          {            "group": "Success 200",            "type": "String",            "optional": false,            "field": "address",            "description": "<p>Address of the ack contract.</p>"          }        ]      },      "examples": [        {          "title": "Success-Response:",          "content": "    HTTP/1.1 200\n  {\n\t\tpayload_hash : \"odihodhodh;odhodhohocnkcich\",\n\t\turl : \"http://govhack.org\",\n\t\tcode : 1,\n\t\tgw_datetime : 6963963963\n\t}",          "type": "json"        }      ]    },    "version": "0.0.0",    "filename": "routes/ack.js",    "groupTitle": "ACK",    "sampleRequest": [      {        "url": "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api/ack/:address"      }    ]  },  {    "type": "get",    "url": "/ack/codes",    "title": "Get invoice state codes",    "name": "GetStateCodes",    "group": "ACK",    "success": {      "fields": {        "Success 200": [          {            "group": "Success 200",            "type": "Map",            "optional": false,            "field": "state",            "description": "<p>code:stateName set</p>"          }        ]      },      "examples": [        {          "title": "Success-Response:",          "content": "    HTTP/1.1 200\n{\n\t1 : 'created',\n\t2 : 'received',\n\t3 : 'approved',\n\t4 : 'disputed',\n\t5 : 'cancelled',\n\t6 : 'paid'\n}",          "type": "json"        }      ]    },    "version": "0.0.0",    "filename": "routes/ack.js",    "groupTitle": "ACK",    "sampleRequest": [      {        "url": "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api/ack/codes"      }    ]  },  {    "type": "post",    "url": "/ack",    "title": "Create ack contract",    "name": "PostAck",    "group": "ACK",    "parameter": {      "fields": {        "Parameter": [          {            "group": "Parameter",            "type": "String",            "optional": false,            "field": "payload_hash",            "description": "<p>Hashed payload of the invoice</p>"          },          {            "group": "Parameter",            "type": "String",            "optional": false,            "field": "url",            "description": "<p>URL to the ack</p>"          },          {            "group": "Parameter",            "type": "Number",            "optional": false,            "field": "code",            "description": "<p>Ack State.</p>"          },          {            "group": "Parameter",            "type": "Number",            "optional": false,            "field": "gw_datetime",            "description": "<p>Gateway datetime</p>"          }        ]      }    },    "success": {      "fields": {        "Success 200": [          {            "group": "Success 200",            "type": "String",            "optional": false,            "field": "address",            "description": "<p>Address of the ack contract.</p>"          }        ]      },      "examples": [        {          "title": "Success-Response:",          "content": "HTTP/1.1 200 0x7b49e2c3b3416b66b33b2d77a88d76c073b28a29",          "type": "json"        }      ]    },    "version": "0.0.0",    "filename": "routes/ack.js",    "groupTitle": "ACK",    "sampleRequest": [      {        "url": "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api/ack"      }    ]  }]

diff --git a/etherium/api/apidoc/api_project.js b/etherium/api/apidoc/api_project.js
diff --git a/etherium/api/apidoc/api_project.json b/etherium/api/apidoc/api_project.json
@@ -0,0 +1 @@
+{  "name": "blockchain-ack",  "version": "1.0.0",  "description": "Blockchain API Documentation",  "title": "Blockchain API Documentation",  "url": "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api",  "sampleUrl": "http://ec2-52-63-123-136.ap-southeast-2.compute.amazonaws.com:3000/api",  "apidoc": "0.2.0",  "generator": {    "name": "apidoc",    "time": "2016-07-31T04:50:39.281Z",    "url": "http://apidocjs.com",    "version": "0.16.1"  }}