{"action":"created","comment":{"url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/comments/77169924","id":77169924,"diff_hunk":"@@ -1,2 +1,230 @@\n-# coalaip-http-api\n-An HTTP wrapper for CoalaIP\n+# COALA IP HTTP Wrapper\n+\n+> A HTTP wrapper for [pycoalaip](https://github.com/bigchaindb/pycoalaip).\n+\n+\n+## Why?\n+\n+[pycoalaip](https://github.com/bigchaindb/pycoalaip) is Python-specific.\n+Furthermore all underlying dependencies are written in Python, which means\n+that parties interested in COALA IP would have to re-implement large parts of\n+their logic in their programming language to make use of COALA IP.\n+To solve this problem in the short-term, this library exposes a RESTful web\n+interface (runnable in Docker) of the functionalities provided in\n+[pycoalaip](https://github.com/bigchaindb/pycoalaip).\n+\n+\n+## Whats the status of this?\n+\n+Super-pre-alpha. At the moment all you can do is hit against two endpoints that\n+are being exposed. Minimal error paths are provided.\n+This package and [pycoalaip](https://github.com/bigchaindb/pycoalaip)\n+will probably mature rather quickly as we're actively developing them\n+currently.\n+\n+\n+## Can I use this in production?\n+\n+No. Currently we're hitting against a BigchainDB instance running in\n+quasi \"regtest\" mode. Its never been used in production either.\n+In its current state, this package can and should be used to experiment with\n+COALA IP.\n+\n+\n+## OK, how can I start experimenting?\n+\n+1. Read the installation section on how to install with Docker.\n+2. Get familiar with the REST API provided at the end of this document.\n+3. Hit against a running Docker container with a HTTP client of your choice.\n+\n+\n+## Should I expose this server to the internet?\n+\n+NO! Think of this library more like a shell-command. The flask server should at\n+least be run behind a reverse-proxy like nginx, so that its interface is NOT\n+exposed to the world wide web.\n+\n+\n+## Can I just have a shell-command for this?\n+\n+Yes, [curl](https://curl.haxx.se/).\n+\n+\n+## Installation and Usage\n+\n+\n+### For development on Linux\n+\n+```\n+$ git clone git@github.com:bigchaindb/coalaip-http-api.git\n+$ virtualenv --python=python3 venv\n+$ source venv/bin/activate\n+$ pip install -r requirements_dev.txt\n+$ python web/server.py\n+```","path":"README.md","position":71,"original_position":66,"commit_id":"8d78073ad33be5e3c8198dfd94e2d051a8e69f01","original_commit_id":"bec75b4d9fa50932497db099104c7e8032a3d115","user":{"login":"TimDaub","id":2758453,"avatar_url":"https://avatars.githubusercontent.com/u/2758453?v=3","gravatar_id":"","url":"https://api.github.com/users/TimDaub","html_url":"https://github.com/TimDaub","followers_url":"https://api.github.com/users/TimDaub/followers","following_url":"https://api.github.com/users/TimDaub/following{/other_user}","gists_url":"https://api.github.com/users/TimDaub/gists{/gist_id}","starred_url":"https://api.github.com/users/TimDaub/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TimDaub/subscriptions","organizations_url":"https://api.github.com/users/TimDaub/orgs","repos_url":"https://api.github.com/users/TimDaub/repos","events_url":"https://api.github.com/users/TimDaub/events{/privacy}","received_events_url":"https://api.github.com/users/TimDaub/received_events","type":"User","site_admin":false},"body":"Updated in https://github.com/bigchaindb/coalaip-http-api/pull/2/commits/8d78073ad33be5e3c8198dfd94e2d051a8e69f01","created_at":"2016-09-01T13:11:34Z","updated_at":"2016-09-01T13:11:34Z","html_url":"https://github.com/bigchaindb/coalaip-http-api/pull/2#discussion_r77169924","pull_request_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2","_links":{"self":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/comments/77169924"},"html":{"href":"https://github.com/bigchaindb/coalaip-http-api/pull/2#discussion_r77169924"},"pull_request":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2"}}},"pull_request":{"url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2","id":83438076,"html_url":"https://github.com/bigchaindb/coalaip-http-api/pull/2","diff_url":"https://github.com/bigchaindb/coalaip-http-api/pull/2.diff","patch_url":"https://github.com/bigchaindb/coalaip-http-api/pull/2.patch","issue_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/2","number":2,"state":"open","locked":false,"title":"Api/1/initial api spec","user":{"login":"TimDaub","id":2758453,"avatar_url":"https://avatars.githubusercontent.com/u/2758453?v=3","gravatar_id":"","url":"https://api.github.com/users/TimDaub","html_url":"https://github.com/TimDaub","followers_url":"https://api.github.com/users/TimDaub/followers","following_url":"https://api.github.com/users/TimDaub/following{/other_user}","gists_url":"https://api.github.com/users/TimDaub/gists{/gist_id}","starred_url":"https://api.github.com/users/TimDaub/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/TimDaub/subscriptions","organizations_url":"https://api.github.com/users/TimDaub/orgs","repos_url":"https://api.github.com/users/TimDaub/repos","events_url":"https://api.github.com/users/TimDaub/events{/privacy}","received_events_url":"https://api.github.com/users/TimDaub/received_events","type":"User","site_admin":false},"body":"@sohkai See TODOs for coalaip","created_at":"2016-08-31T11:54:02Z","updated_at":"2016-09-01T13:11:34Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4904f3584634237f09d940b3ecab7e37f1c1e7ff","assignee":{"login":"sohkai","id":4166642,"avatar_url":"https://avatars.githubusercontent.com/u/4166642?v=3","gravatar_id":"","url":"https://api.github.com/users/sohkai","html_url":"https://github.com/sohkai","followers_url":"https://api.github.com/users/sohkai/followers","following_url":"https://api.github.com/users/sohkai/following{/other_user}","gists_url":"https://api.github.com/users/sohkai/gists{/gist_id}","starred_url":"https://api.github.com/users/sohkai/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sohkai/subscriptions","organizations_url":"https://api.github.com/users/sohkai/orgs","repos_url":"https://api.github.com/users/sohkai/repos","events_url":"https://api.github.com/users/sohkai/events{/privacy}","received_events_url":"https://api.github.com/users/sohkai/received_events","type":"User","site_admin":false},"assignees":[{"login":"sohkai","id":4166642,"avatar_url":"https://avatars.githubusercontent.com/u/4166642?v=3","gravatar_id":"","url":"https://api.github.com/users/sohkai","html_url":"https://github.com/sohkai","followers_url":"https://api.github.com/users/sohkai/followers","following_url":"https://api.github.com/users/sohkai/following{/other_user}","gists_url":"https://api.github.com/users/sohkai/gists{/gist_id}","starred_url":"https://api.github.com/users/sohkai/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sohkai/subscriptions","organizations_url":"https://api.github.com/users/sohkai/orgs","repos_url":"https://api.github.com/users/sohkai/repos","events_url":"https://api.github.com/users/sohkai/events{/privacy}","received_events_url":"https://api.github.com/users/sohkai/received_events","type":"User","site_admin":false},{"login":"diminator","id":6178597,"avatar_url":"https://avatars.githubusercontent.com/u/6178597?v=3","gravatar_id":"","url":"https://api.github.com/users/diminator","html_url":"https://github.com/diminator","followers_url":"https://api.github.com/users/diminator/followers","following_url":"https://api.github.com/users/diminator/following{/other_user}","gists_url":"https://api.github.com/users/diminator/gists{/gist_id}","starred_url":"https://api.github.com/users/diminator/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/diminator/subscriptions","organizations_url":"https://api.github.com/users/diminator/orgs","repos_url":"https://api.github.com/users/diminator/repos","events_url":"https://api.github.com/users/diminator/events{/privacy}","received_events_url":"https://api.github.com/users/diminator/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2/commits","review_comments_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2/comments","review_comment_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/comments{/number}","comments_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/2/comments","statuses_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/statuses/8d78073ad33be5e3c8198dfd94e2d051a8e69f01","head":{"label":"bigchaindb:api/1/initial-api-spec","ref":"api/1/initial-api-spec","sha":"8d78073ad33be5e3c8198dfd94e2d051a8e69f01","user":{"login":"bigchaindb","id":17097586,"avatar_url":"https://avatars.githubusercontent.com/u/17097586?v=3","gravatar_id":"","url":"https://api.github.com/users/bigchaindb","html_url":"https://github.com/bigchaindb","followers_url":"https://api.github.com/users/bigchaindb/followers","following_url":"https://api.github.com/users/bigchaindb/following{/other_user}","gists_url":"https://api.github.com/users/bigchaindb/gists{/gist_id}","starred_url":"https://api.github.com/users/bigchaindb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bigchaindb/subscriptions","organizations_url":"https://api.github.com/users/bigchaindb/orgs","repos_url":"https://api.github.com/users/bigchaindb/repos","events_url":"https://api.github.com/users/bigchaindb/events{/privacy}","received_events_url":"https://api.github.com/users/bigchaindb/received_events","type":"Organization","site_admin":false},"repo":{"id":66933251,"name":"coalaip-http-api","full_name":"bigchaindb/coalaip-http-api","owner":{"login":"bigchaindb","id":17097586,"avatar_url":"https://avatars.githubusercontent.com/u/17097586?v=3","gravatar_id":"","url":"https://api.github.com/users/bigchaindb","html_url":"https://github.com/bigchaindb","followers_url":"https://api.github.com/users/bigchaindb/followers","following_url":"https://api.github.com/users/bigchaindb/following{/other_user}","gists_url":"https://api.github.com/users/bigchaindb/gists{/gist_id}","starred_url":"https://api.github.com/users/bigchaindb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bigchaindb/subscriptions","organizations_url":"https://api.github.com/users/bigchaindb/orgs","repos_url":"https://api.github.com/users/bigchaindb/repos","events_url":"https://api.github.com/users/bigchaindb/events{/privacy}","received_events_url":"https://api.github.com/users/bigchaindb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/bigchaindb/coalaip-http-api","description":"An HTTP wrapper for COALA IP","fork":false,"url":"https://api.github.com/repos/bigchaindb/coalaip-http-api","forks_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/forks","keys_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/keys{/key_id}","collaborators_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/teams","hooks_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/hooks","issue_events_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/events{/number}","events_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/events","assignees_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/assignees{/user}","branches_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/branches{/branch}","tags_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/tags","blobs_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/refs{/sha}","trees_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/trees{/sha}","statuses_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/statuses/{sha}","languages_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/languages","stargazers_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/stargazers","contributors_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/contributors","subscribers_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/subscribers","subscription_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/subscription","commits_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/commits{/sha}","git_commits_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/commits{/sha}","comments_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/comments{/number}","issue_comment_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/comments{/number}","contents_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/contents/{+path}","compare_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/compare/{base}...{head}","merges_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/merges","archive_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/downloads","issues_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues{/number}","pulls_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls{/number}","milestones_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/milestones{/number}","notifications_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/labels{/name}","releases_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/releases{/id}","deployments_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/deployments","created_at":"2016-08-30T11:06:11Z","updated_at":"2016-08-30T12:26:05Z","pushed_at":"2016-09-01T13:11:11Z","git_url":"git://github.com/bigchaindb/coalaip-http-api.git","ssh_url":"git@github.com:bigchaindb/coalaip-http-api.git","clone_url":"https://github.com/bigchaindb/coalaip-http-api.git","svn_url":"https://github.com/bigchaindb/coalaip-http-api","homepage":"","size":35,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":2,"forks":0,"open_issues":2,"watchers":0,"default_branch":"master"}},"base":{"label":"bigchaindb:master","ref":"master","sha":"fd9cb49e94a04f3789c22505cf52efddbe51868e","user":{"login":"bigchaindb","id":17097586,"avatar_url":"https://avatars.githubusercontent.com/u/17097586?v=3","gravatar_id":"","url":"https://api.github.com/users/bigchaindb","html_url":"https://github.com/bigchaindb","followers_url":"https://api.github.com/users/bigchaindb/followers","following_url":"https://api.github.com/users/bigchaindb/following{/other_user}","gists_url":"https://api.github.com/users/bigchaindb/gists{/gist_id}","starred_url":"https://api.github.com/users/bigchaindb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bigchaindb/subscriptions","organizations_url":"https://api.github.com/users/bigchaindb/orgs","repos_url":"https://api.github.com/users/bigchaindb/repos","events_url":"https://api.github.com/users/bigchaindb/events{/privacy}","received_events_url":"https://api.github.com/users/bigchaindb/received_events","type":"Organization","site_admin":false},"repo":{"id":66933251,"name":"coalaip-http-api","full_name":"bigchaindb/coalaip-http-api","owner":{"login":"bigchaindb","id":17097586,"avatar_url":"https://avatars.githubusercontent.com/u/17097586?v=3","gravatar_id":"","url":"https://api.github.com/users/bigchaindb","html_url":"https://github.com/bigchaindb","followers_url":"https://api.github.com/users/bigchaindb/followers","following_url":"https://api.github.com/users/bigchaindb/following{/other_user}","gists_url":"https://api.github.com/users/bigchaindb/gists{/gist_id}","starred_url":"https://api.github.com/users/bigchaindb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bigchaindb/subscriptions","organizations_url":"https://api.github.com/users/bigchaindb/orgs","repos_url":"https://api.github.com/users/bigchaindb/repos","events_url":"https://api.github.com/users/bigchaindb/events{/privacy}","received_events_url":"https://api.github.com/users/bigchaindb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/bigchaindb/coalaip-http-api","description":"An HTTP wrapper for COALA IP","fork":false,"url":"https://api.github.com/repos/bigchaindb/coalaip-http-api","forks_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/forks","keys_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/keys{/key_id}","collaborators_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/teams","hooks_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/hooks","issue_events_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/events{/number}","events_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/events","assignees_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/assignees{/user}","branches_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/branches{/branch}","tags_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/tags","blobs_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/refs{/sha}","trees_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/trees{/sha}","statuses_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/statuses/{sha}","languages_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/languages","stargazers_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/stargazers","contributors_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/contributors","subscribers_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/subscribers","subscription_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/subscription","commits_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/commits{/sha}","git_commits_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/git/commits{/sha}","comments_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/comments{/number}","issue_comment_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/comments{/number}","contents_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/contents/{+path}","compare_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/compare/{base}...{head}","merges_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/merges","archive_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/downloads","issues_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues{/number}","pulls_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls{/number}","milestones_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/milestones{/number}","notifications_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/labels{/name}","releases_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/releases{/id}","deployments_url":"https://api.github.com/repos/bigchaindb/coalaip-http-api/deployments","created_at":"2016-08-30T11:06:11Z","updated_at":"2016-08-30T12:26:05Z","pushed_at":"2016-09-01T13:11:11Z","git_url":"git://github.com/bigchaindb/coalaip-http-api.git","ssh_url":"git@github.com:bigchaindb/coalaip-http-api.git","clone_url":"https://github.com/bigchaindb/coalaip-http-api.git","svn_url":"https://github.com/bigchaindb/coalaip-http-api","homepage":"","size":35,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":2,"forks":0,"open_issues":2,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2"},"html":{"href":"https://github.com/bigchaindb/coalaip-http-api/pull/2"},"issue":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/2"},"comments":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/issues/2/comments"},"review_comments":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2/comments"},"review_comment":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/pulls/2/commits"},"statuses":{"href":"https://api.github.com/repos/bigchaindb/coalaip-http-api/statuses/8d78073ad33be5e3c8198dfd94e2d051a8e69f01"}}}}
{"actor":{"display_login":"TimDaub"}}