{"action":"created","issue":{"url":"https://api.github.com/repos/opentargets/rest_api/issues/130","repository_url":"https://api.github.com/repos/opentargets/rest_api","labels_url":"https://api.github.com/repos/opentargets/rest_api/issues/130/labels{/name}","comments_url":"https://api.github.com/repos/opentargets/rest_api/issues/130/comments","events_url":"https://api.github.com/repos/opentargets/rest_api/issues/130/events","html_url":"https://github.com/opentargets/rest_api/issues/130","id":271547230,"node_id":"MDU6SXNzdWUyNzE1NDcyMzA=","number":130,"title":"extend openapi specs to improve public API documentation","user":{"login":"elipapa","id":112610,"node_id":"MDQ6VXNlcjExMjYxMA==","avatar_url":"https://avatars0.githubusercontent.com/u/112610?v=4","gravatar_id":"","url":"https://api.github.com/users/elipapa","html_url":"https://github.com/elipapa","followers_url":"https://api.github.com/users/elipapa/followers","following_url":"https://api.github.com/users/elipapa/following{/other_user}","gists_url":"https://api.github.com/users/elipapa/gists{/gist_id}","starred_url":"https://api.github.com/users/elipapa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elipapa/subscriptions","organizations_url":"https://api.github.com/users/elipapa/orgs","repos_url":"https://api.github.com/users/elipapa/repos","events_url":"https://api.github.com/users/elipapa/events{/privacy}","received_events_url":"https://api.github.com/users/elipapa/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"deniseOme","id":6472381,"node_id":"MDQ6VXNlcjY0NzIzODE=","avatar_url":"https://avatars2.githubusercontent.com/u/6472381?v=4","gravatar_id":"","url":"https://api.github.com/users/deniseOme","html_url":"https://github.com/deniseOme","followers_url":"https://api.github.com/users/deniseOme/followers","following_url":"https://api.github.com/users/deniseOme/following{/other_user}","gists_url":"https://api.github.com/users/deniseOme/gists{/gist_id}","starred_url":"https://api.github.com/users/deniseOme/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deniseOme/subscriptions","organizations_url":"https://api.github.com/users/deniseOme/orgs","repos_url":"https://api.github.com/users/deniseOme/repos","events_url":"https://api.github.com/users/deniseOme/events{/privacy}","received_events_url":"https://api.github.com/users/deniseOme/received_events","type":"User","site_admin":false},"assignees":[{"login":"deniseOme","id":6472381,"node_id":"MDQ6VXNlcjY0NzIzODE=","avatar_url":"https://avatars2.githubusercontent.com/u/6472381?v=4","gravatar_id":"","url":"https://api.github.com/users/deniseOme","html_url":"https://github.com/deniseOme","followers_url":"https://api.github.com/users/deniseOme/followers","following_url":"https://api.github.com/users/deniseOme/following{/other_user}","gists_url":"https://api.github.com/users/deniseOme/gists{/gist_id}","starred_url":"https://api.github.com/users/deniseOme/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deniseOme/subscriptions","organizations_url":"https://api.github.com/users/deniseOme/orgs","repos_url":"https://api.github.com/users/deniseOme/repos","events_url":"https://api.github.com/users/deniseOme/events{/privacy}","received_events_url":"https://api.github.com/users/deniseOme/received_events","type":"User","site_admin":false}],"milestone":null,"comments":4,"created_at":"2017-11-06T16:59:04Z","updated_at":"2018-07-20T16:35:39Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"We have a new api documentation at https://api.opentargets.io/v3/docs\r\n\r\nWe should edit https://github.com/opentargets/rest_api/blob/master/openapi.template.yaml to take advantage of [redoc vendor extension](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md). \r\n\r\nThis will allow to include code samples and example POST bodies/responses.\r\n\r\n@deniseOme want to give it a shot?"},"comment":{"url":"https://api.github.com/repos/opentargets/rest_api/issues/comments/406655580","html_url":"https://github.com/opentargets/rest_api/issues/130#issuecomment-406655580","issue_url":"https://api.github.com/repos/opentargets/rest_api/issues/130","id":406655580,"node_id":"MDEyOklzc3VlQ29tbWVudDQwNjY1NTU4MA==","user":{"login":"elipapa","id":112610,"node_id":"MDQ6VXNlcjExMjYxMA==","avatar_url":"https://avatars0.githubusercontent.com/u/112610?v=4","gravatar_id":"","url":"https://api.github.com/users/elipapa","html_url":"https://github.com/elipapa","followers_url":"https://api.github.com/users/elipapa/followers","following_url":"https://api.github.com/users/elipapa/following{/other_user}","gists_url":"https://api.github.com/users/elipapa/gists{/gist_id}","starred_url":"https://api.github.com/users/elipapa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elipapa/subscriptions","organizations_url":"https://api.github.com/users/elipapa/orgs","repos_url":"https://api.github.com/users/elipapa/repos","events_url":"https://api.github.com/users/elipapa/events{/privacy}","received_events_url":"https://api.github.com/users/elipapa/received_events","type":"User","site_admin":false},"created_at":"2018-07-20T16:35:39Z","updated_at":"2018-07-20T16:35:39Z","author_association":"CONTRIBUTOR","body":"Great suggestion! \r\nWriting specifications of what each response contains is what’s missing from our swagger (aka. OpenAPI) definition.\r\nSpending the time to do it is a painful exercise (probably of a few days duration), but it has the added benefit that the documentation would be automatically updated.\r\n \r\nAnother bonus: we can leverage that work to provide a clear contract between webapp and API, which is something that we have wanted to establish for quite a while.\r\n \r\n@ElaineMcA This part of the work depends on @opentargets/frontend  going through the webapp code to see what part of the API calls is _actually used_ in the webapp. \r\n "}}
{"actor":{"display_login":"elipapa"}}