{"action":"created","issue":{"url":"https://api.github.com/repos/ga4gh/schemas/issues/717","repository_url":"https://api.github.com/repos/ga4gh/schemas","labels_url":"https://api.github.com/repos/ga4gh/schemas/issues/717/labels{/name}","comments_url":"https://api.github.com/repos/ga4gh/schemas/issues/717/comments","events_url":"https://api.github.com/repos/ga4gh/schemas/issues/717/events","html_url":"https://github.com/ga4gh/schemas/pull/717","id":178161769,"number":717,"title":"Adding HTTP Annotations","user":{"login":"david4096","id":3795586,"avatar_url":"https://avatars.githubusercontent.com/u/3795586?v=3","gravatar_id":"","url":"https://api.github.com/users/david4096","html_url":"https://github.com/david4096","followers_url":"https://api.github.com/users/david4096/followers","following_url":"https://api.github.com/users/david4096/following{/other_user}","gists_url":"https://api.github.com/users/david4096/gists{/gist_id}","starred_url":"https://api.github.com/users/david4096/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/david4096/subscriptions","organizations_url":"https://api.github.com/users/david4096/orgs","repos_url":"https://api.github.com/users/david4096/repos","events_url":"https://api.github.com/users/david4096/events{/privacy}","received_events_url":"https://api.github.com/users/david4096/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/ga4gh/schemas/labels/in%20progress","name":"in progress","color":"ededed"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-09-20T19:48:48Z","updated_at":"2016-09-21T00:00:18Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/ga4gh/schemas/pulls/717","html_url":"https://github.com/ga4gh/schemas/pull/717","diff_url":"https://github.com/ga4gh/schemas/pull/717.diff","patch_url":"https://github.com/ga4gh/schemas/pull/717.patch"},"body":"There has been an effort to standardize the methods for generating HTTP API descriptions that allow developers to rapidly develop gateways into their data. Since the GA4GH schemas are defined using Google Protocol Buffers IDL, it is possible to use this definition to generate documentation and code.\r\n\r\nThis PR adds this functionality to the GA4GH schemas by defining specially formatted options. These options allow one to specify the exact endpoint a message will be received at, as well as which fields to gather from the URL path. With these options in place, it is possible to inspect the compiled protobuf to generate service descriptions that include HTTP endpoints.\r\n\r\nThe plugin for `protoc` used is written in Go, and so this PR includes some cursory documentation for getting started with Go on Mac.\r\n\r\nWith these annotations in place, one can use tools like swagger-codegen to generate server stubs, clients, and generated documentation. This will make integrating GA4GH APIs into existing data stores much easier.\r\n\r\n* Updated to newer sphinx-maven\r\n* Added version to URL string\r\n* Add documentation for use and getting started with swagger-codegen\r\n* Add proto dependencies\r\n* Update protobufjsondocs script\r\n\r\nClose #696 "},"comment":{"url":"https://api.github.com/repos/ga4gh/schemas/issues/comments/248471807","html_url":"https://github.com/ga4gh/schemas/pull/717#issuecomment-248471807","issue_url":"https://api.github.com/repos/ga4gh/schemas/issues/717","id":248471807,"user":{"login":"kozbo","id":17557555,"avatar_url":"https://avatars.githubusercontent.com/u/17557555?v=3","gravatar_id":"","url":"https://api.github.com/users/kozbo","html_url":"https://github.com/kozbo","followers_url":"https://api.github.com/users/kozbo/followers","following_url":"https://api.github.com/users/kozbo/following{/other_user}","gists_url":"https://api.github.com/users/kozbo/gists{/gist_id}","starred_url":"https://api.github.com/users/kozbo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kozbo/subscriptions","organizations_url":"https://api.github.com/users/kozbo/orgs","repos_url":"https://api.github.com/users/kozbo/repos","events_url":"https://api.github.com/users/kozbo/events{/privacy}","received_events_url":"https://api.github.com/users/kozbo/received_events","type":"User","site_admin":false},"created_at":"2016-09-21T00:00:18Z","updated_at":"2016-09-21T00:00:18Z","body":"I have gone through the steps in the documentation and was able to use the swagger-codegen tool successfully. +1"}}
{"actor":{"display_login":"kozbo"}}