{"action":"created","comment":{"url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/comments/27052648","id":27052648,"diff_hunk":"@@ -1,31 +1,348 @@\n # Hyperion\n \n-TODO: Write a gem description\n+Hyperion is a Ruby REST client that follows certain conventions\n+layered on top of HTTP. The conventions implement best practices\n+surrounding versioning, error handling, and crafting an API for\n+consumption by third parties. Hyperion provides abstractions that\n+make it easy to follow these conventions consistently across\n+projects.\n \n-## Installation\n+This document describes the conventions, then demonstrates how to\n+use the API, and finally shows how to test your client-side code.\n \n-Add this line to your application's Gemfile:\n+## Conventions\n+\n+### Versioning\n+\n+_TODO_\n+\n+### Errors\n+\n+400-level errors are always returned as exactly 400; no distinction is\n+made in the error code. Instead, a well-defined structure is returned\n+that contains\n+\n+- a human-oriented error message, and\n+- a machine-oriented list of `ErrorInfo`s.","path":"README.md","position":30,"original_position":29,"commit_id":"a1c9eab54d6043fec681b5af0905aba7f2251e4b","original_commit_id":"44456894e62acc1aa514b8ddf08ed26b7cd2dfe9","user":{"login":"wintonpc","id":2847818,"avatar_url":"https://avatars.githubusercontent.com/u/2847818?v=3","gravatar_id":"","url":"https://api.github.com/users/wintonpc","html_url":"https://github.com/wintonpc","followers_url":"https://api.github.com/users/wintonpc/followers","following_url":"https://api.github.com/users/wintonpc/following{/other_user}","gists_url":"https://api.github.com/users/wintonpc/gists{/gist_id}","starred_url":"https://api.github.com/users/wintonpc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wintonpc/subscriptions","organizations_url":"https://api.github.com/users/wintonpc/orgs","repos_url":"https://api.github.com/users/wintonpc/repos","events_url":"https://api.github.com/users/wintonpc/events{/privacy}","received_events_url":"https://api.github.com/users/wintonpc/received_events","type":"User","site_admin":false},"body":"Fixed it to be more abstract about \"error info\" rather than `ErrorInfo`. I shouldn't be mentioning code concepts here. So I'm not adding a link. It would be brittle anyway.","created_at":"2015-03-24T17:34:43Z","updated_at":"2015-03-24T17:34:43Z","html_url":"https://github.com/indigo-biosystems/hyperion/pull/1#discussion_r27052648","pull_request_url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1","_links":{"self":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/comments/27052648"},"html":{"href":"https://github.com/indigo-biosystems/hyperion/pull/1#discussion_r27052648"},"pull_request":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1"}}},"pull_request":{"url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1","id":31241100,"html_url":"https://github.com/indigo-biosystems/hyperion/pull/1","diff_url":"https://github.com/indigo-biosystems/hyperion/pull/1.diff","patch_url":"https://github.com/indigo-biosystems/hyperion/pull/1.patch","issue_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/1","number":1,"state":"open","locked":false,"title":"Hyperion","user":{"login":"wintonpc","id":2847818,"avatar_url":"https://avatars.githubusercontent.com/u/2847818?v=3","gravatar_id":"","url":"https://api.github.com/users/wintonpc","html_url":"https://github.com/wintonpc","followers_url":"https://api.github.com/users/wintonpc/followers","following_url":"https://api.github.com/users/wintonpc/following{/other_user}","gists_url":"https://api.github.com/users/wintonpc/gists{/gist_id}","starred_url":"https://api.github.com/users/wintonpc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wintonpc/subscriptions","organizations_url":"https://api.github.com/users/wintonpc/orgs","repos_url":"https://api.github.com/users/wintonpc/repos","events_url":"https://api.github.com/users/wintonpc/events{/privacy}","received_events_url":"https://api.github.com/users/wintonpc/received_events","type":"User","site_admin":false},"body":"Please leave feedback on both the code and documentation.\r\n\r\nI'm working on getting a build job set up on TravisCI.\r\n","created_at":"2015-03-16T13:05:12Z","updated_at":"2015-03-24T17:34:43Z","closed_at":null,"merged_at":null,"merge_commit_sha":"9a14ceead8f640da513fb6dbd262beb28d174bd3","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1/commits","review_comments_url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1/comments","review_comment_url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/comments{/number}","comments_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/1/comments","statuses_url":"https://api.github.com/repos/indigo-biosystems/hyperion/statuses/a1c9eab54d6043fec681b5af0905aba7f2251e4b","head":{"label":"indigo-biosystems:master","ref":"master","sha":"a1c9eab54d6043fec681b5af0905aba7f2251e4b","user":{"login":"indigo-biosystems","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigo-biosystems","html_url":"https://github.com/indigo-biosystems","followers_url":"https://api.github.com/users/indigo-biosystems/followers","following_url":"https://api.github.com/users/indigo-biosystems/following{/other_user}","gists_url":"https://api.github.com/users/indigo-biosystems/gists{/gist_id}","starred_url":"https://api.github.com/users/indigo-biosystems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigo-biosystems/subscriptions","organizations_url":"https://api.github.com/users/indigo-biosystems/orgs","repos_url":"https://api.github.com/users/indigo-biosystems/repos","events_url":"https://api.github.com/users/indigo-biosystems/events{/privacy}","received_events_url":"https://api.github.com/users/indigo-biosystems/received_events","type":"Organization","site_admin":false},"repo":{"id":27606837,"name":"hyperion","full_name":"indigo-biosystems/hyperion","owner":{"login":"indigo-biosystems","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigo-biosystems","html_url":"https://github.com/indigo-biosystems","followers_url":"https://api.github.com/users/indigo-biosystems/followers","following_url":"https://api.github.com/users/indigo-biosystems/following{/other_user}","gists_url":"https://api.github.com/users/indigo-biosystems/gists{/gist_id}","starred_url":"https://api.github.com/users/indigo-biosystems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigo-biosystems/subscriptions","organizations_url":"https://api.github.com/users/indigo-biosystems/orgs","repos_url":"https://api.github.com/users/indigo-biosystems/repos","events_url":"https://api.github.com/users/indigo-biosystems/events{/privacy}","received_events_url":"https://api.github.com/users/indigo-biosystems/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/indigo-biosystems/hyperion","description":"All the things go RESTfully","fork":false,"url":"https://api.github.com/repos/indigo-biosystems/hyperion","forks_url":"https://api.github.com/repos/indigo-biosystems/hyperion/forks","keys_url":"https://api.github.com/repos/indigo-biosystems/hyperion/keys{/key_id}","collaborators_url":"https://api.github.com/repos/indigo-biosystems/hyperion/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/indigo-biosystems/hyperion/teams","hooks_url":"https://api.github.com/repos/indigo-biosystems/hyperion/hooks","issue_events_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/events{/number}","events_url":"https://api.github.com/repos/indigo-biosystems/hyperion/events","assignees_url":"https://api.github.com/repos/indigo-biosystems/hyperion/assignees{/user}","branches_url":"https://api.github.com/repos/indigo-biosystems/hyperion/branches{/branch}","tags_url":"https://api.github.com/repos/indigo-biosystems/hyperion/tags","blobs_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/refs{/sha}","trees_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/trees{/sha}","statuses_url":"https://api.github.com/repos/indigo-biosystems/hyperion/statuses/{sha}","languages_url":"https://api.github.com/repos/indigo-biosystems/hyperion/languages","stargazers_url":"https://api.github.com/repos/indigo-biosystems/hyperion/stargazers","contributors_url":"https://api.github.com/repos/indigo-biosystems/hyperion/contributors","subscribers_url":"https://api.github.com/repos/indigo-biosystems/hyperion/subscribers","subscription_url":"https://api.github.com/repos/indigo-biosystems/hyperion/subscription","commits_url":"https://api.github.com/repos/indigo-biosystems/hyperion/commits{/sha}","git_commits_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/commits{/sha}","comments_url":"https://api.github.com/repos/indigo-biosystems/hyperion/comments{/number}","issue_comment_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/comments{/number}","contents_url":"https://api.github.com/repos/indigo-biosystems/hyperion/contents/{+path}","compare_url":"https://api.github.com/repos/indigo-biosystems/hyperion/compare/{base}...{head}","merges_url":"https://api.github.com/repos/indigo-biosystems/hyperion/merges","archive_url":"https://api.github.com/repos/indigo-biosystems/hyperion/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/indigo-biosystems/hyperion/downloads","issues_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues{/number}","pulls_url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls{/number}","milestones_url":"https://api.github.com/repos/indigo-biosystems/hyperion/milestones{/number}","notifications_url":"https://api.github.com/repos/indigo-biosystems/hyperion/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/indigo-biosystems/hyperion/labels{/name}","releases_url":"https://api.github.com/repos/indigo-biosystems/hyperion/releases{/id}","created_at":"2014-12-05T19:33:24Z","updated_at":"2015-03-24T17:26:49Z","pushed_at":"2015-03-24T17:26:50Z","git_url":"git://github.com/indigo-biosystems/hyperion.git","ssh_url":"git@github.com:indigo-biosystems/hyperion.git","clone_url":"https://github.com/indigo-biosystems/hyperion.git","svn_url":"https://github.com/indigo-biosystems/hyperion","homepage":null,"size":752,"stargazers_count":0,"watchers_count":0,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":1,"forks":0,"open_issues":1,"watchers":0,"default_branch":"master"}},"base":{"label":"indigo-biosystems:genesis","ref":"genesis","sha":"ddb7f399f4fd18c3e1fee07495bb082da9b6f2ff","user":{"login":"indigo-biosystems","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigo-biosystems","html_url":"https://github.com/indigo-biosystems","followers_url":"https://api.github.com/users/indigo-biosystems/followers","following_url":"https://api.github.com/users/indigo-biosystems/following{/other_user}","gists_url":"https://api.github.com/users/indigo-biosystems/gists{/gist_id}","starred_url":"https://api.github.com/users/indigo-biosystems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigo-biosystems/subscriptions","organizations_url":"https://api.github.com/users/indigo-biosystems/orgs","repos_url":"https://api.github.com/users/indigo-biosystems/repos","events_url":"https://api.github.com/users/indigo-biosystems/events{/privacy}","received_events_url":"https://api.github.com/users/indigo-biosystems/received_events","type":"Organization","site_admin":false},"repo":{"id":27606837,"name":"hyperion","full_name":"indigo-biosystems/hyperion","owner":{"login":"indigo-biosystems","id":711805,"avatar_url":"https://avatars.githubusercontent.com/u/711805?v=3","gravatar_id":"","url":"https://api.github.com/users/indigo-biosystems","html_url":"https://github.com/indigo-biosystems","followers_url":"https://api.github.com/users/indigo-biosystems/followers","following_url":"https://api.github.com/users/indigo-biosystems/following{/other_user}","gists_url":"https://api.github.com/users/indigo-biosystems/gists{/gist_id}","starred_url":"https://api.github.com/users/indigo-biosystems/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/indigo-biosystems/subscriptions","organizations_url":"https://api.github.com/users/indigo-biosystems/orgs","repos_url":"https://api.github.com/users/indigo-biosystems/repos","events_url":"https://api.github.com/users/indigo-biosystems/events{/privacy}","received_events_url":"https://api.github.com/users/indigo-biosystems/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/indigo-biosystems/hyperion","description":"All the things go RESTfully","fork":false,"url":"https://api.github.com/repos/indigo-biosystems/hyperion","forks_url":"https://api.github.com/repos/indigo-biosystems/hyperion/forks","keys_url":"https://api.github.com/repos/indigo-biosystems/hyperion/keys{/key_id}","collaborators_url":"https://api.github.com/repos/indigo-biosystems/hyperion/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/indigo-biosystems/hyperion/teams","hooks_url":"https://api.github.com/repos/indigo-biosystems/hyperion/hooks","issue_events_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/events{/number}","events_url":"https://api.github.com/repos/indigo-biosystems/hyperion/events","assignees_url":"https://api.github.com/repos/indigo-biosystems/hyperion/assignees{/user}","branches_url":"https://api.github.com/repos/indigo-biosystems/hyperion/branches{/branch}","tags_url":"https://api.github.com/repos/indigo-biosystems/hyperion/tags","blobs_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/refs{/sha}","trees_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/trees{/sha}","statuses_url":"https://api.github.com/repos/indigo-biosystems/hyperion/statuses/{sha}","languages_url":"https://api.github.com/repos/indigo-biosystems/hyperion/languages","stargazers_url":"https://api.github.com/repos/indigo-biosystems/hyperion/stargazers","contributors_url":"https://api.github.com/repos/indigo-biosystems/hyperion/contributors","subscribers_url":"https://api.github.com/repos/indigo-biosystems/hyperion/subscribers","subscription_url":"https://api.github.com/repos/indigo-biosystems/hyperion/subscription","commits_url":"https://api.github.com/repos/indigo-biosystems/hyperion/commits{/sha}","git_commits_url":"https://api.github.com/repos/indigo-biosystems/hyperion/git/commits{/sha}","comments_url":"https://api.github.com/repos/indigo-biosystems/hyperion/comments{/number}","issue_comment_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/comments{/number}","contents_url":"https://api.github.com/repos/indigo-biosystems/hyperion/contents/{+path}","compare_url":"https://api.github.com/repos/indigo-biosystems/hyperion/compare/{base}...{head}","merges_url":"https://api.github.com/repos/indigo-biosystems/hyperion/merges","archive_url":"https://api.github.com/repos/indigo-biosystems/hyperion/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/indigo-biosystems/hyperion/downloads","issues_url":"https://api.github.com/repos/indigo-biosystems/hyperion/issues{/number}","pulls_url":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls{/number}","milestones_url":"https://api.github.com/repos/indigo-biosystems/hyperion/milestones{/number}","notifications_url":"https://api.github.com/repos/indigo-biosystems/hyperion/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/indigo-biosystems/hyperion/labels{/name}","releases_url":"https://api.github.com/repos/indigo-biosystems/hyperion/releases{/id}","created_at":"2014-12-05T19:33:24Z","updated_at":"2015-03-24T17:26:49Z","pushed_at":"2015-03-24T17:26:50Z","git_url":"git://github.com/indigo-biosystems/hyperion.git","ssh_url":"git@github.com:indigo-biosystems/hyperion.git","clone_url":"https://github.com/indigo-biosystems/hyperion.git","svn_url":"https://github.com/indigo-biosystems/hyperion","homepage":null,"size":752,"stargazers_count":0,"watchers_count":0,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":1,"forks":0,"open_issues":1,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1"},"html":{"href":"https://github.com/indigo-biosystems/hyperion/pull/1"},"issue":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/1"},"comments":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/issues/1/comments"},"review_comments":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1/comments"},"review_comment":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/pulls/1/commits"},"statuses":{"href":"https://api.github.com/repos/indigo-biosystems/hyperion/statuses/a1c9eab54d6043fec681b5af0905aba7f2251e4b"}}}}