{"action":"created","issue":{"url":"https://api.github.com/repos/spark-jobserver/spark-jobserver/issues/583","repository_url":"https://api.github.com/repos/spark-jobserver/spark-jobserver","labels_url":"https://api.github.com/repos/spark-jobserver/spark-jobserver/issues/583/labels{/name}","comments_url":"https://api.github.com/repos/spark-jobserver/spark-jobserver/issues/583/comments","events_url":"https://api.github.com/repos/spark-jobserver/spark-jobserver/issues/583/events","html_url":"https://github.com/spark-jobserver/spark-jobserver/issues/583","id":174589224,"number":583,"title":"Interest in Swagger / OpenAPI specification?","user":{"login":"CalebFenton","id":1356658,"avatar_url":"https://avatars.githubusercontent.com/u/1356658?v=3","gravatar_id":"","url":"https://api.github.com/users/CalebFenton","html_url":"https://github.com/CalebFenton","followers_url":"https://api.github.com/users/CalebFenton/followers","following_url":"https://api.github.com/users/CalebFenton/following{/other_user}","gists_url":"https://api.github.com/users/CalebFenton/gists{/gist_id}","starred_url":"https://api.github.com/users/CalebFenton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CalebFenton/subscriptions","organizations_url":"https://api.github.com/users/CalebFenton/orgs","repos_url":"https://api.github.com/users/CalebFenton/repos","events_url":"https://api.github.com/users/CalebFenton/events{/privacy}","received_events_url":"https://api.github.com/users/CalebFenton/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":4,"created_at":"2016-09-01T18:09:52Z","updated_at":"2016-09-02T14:04:30Z","closed_at":null,"body":"Describing an API with a machine-readable specification is useful for a few reasons. Most important for this project would be the ability to automatically generate clients in various languages which can interact with the job server. It would also mean the API is fully documented. The cost is the initial, upfront cost of specifying the API and continually updating it when changes are made. \r\n\r\nFor example, I see there's [an issue](https://github.com/spark-jobserver/spark-jobserver/issues/25) about how the server sometimes responds with JSON and sometimes it just responds with OK. This might be confusing, and it may change in the future, but at least it would be documented if there was a proper spec.\r\n\r\nI was considering making one since I'd rather write the spec and generate a client than write a client, but I wanted to gauge interested and know if anyone else has worked on this."},"comment":{"url":"https://api.github.com/repos/spark-jobserver/spark-jobserver/issues/comments/244383880","html_url":"https://github.com/spark-jobserver/spark-jobserver/issues/583#issuecomment-244383880","issue_url":"https://api.github.com/repos/spark-jobserver/spark-jobserver/issues/583","id":244383880,"user":{"login":"velvia","id":1062875,"avatar_url":"https://avatars.githubusercontent.com/u/1062875?v=3","gravatar_id":"","url":"https://api.github.com/users/velvia","html_url":"https://github.com/velvia","followers_url":"https://api.github.com/users/velvia/followers","following_url":"https://api.github.com/users/velvia/following{/other_user}","gists_url":"https://api.github.com/users/velvia/gists{/gist_id}","starred_url":"https://api.github.com/users/velvia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/velvia/subscriptions","organizations_url":"https://api.github.com/users/velvia/orgs","repos_url":"https://api.github.com/users/velvia/repos","events_url":"https://api.github.com/users/velvia/events{/privacy}","received_events_url":"https://api.github.com/users/velvia/received_events","type":"User","site_admin":false},"created_at":"2016-09-02T14:04:30Z","updated_at":"2016-09-02T14:04:30Z","body":"Well even if it was just scala/Java/Python, that's three less clients to generate by hand. :). And if it was Ooyala people would want a Ruby client. \n\n-Evan\n\"Never doubt that a small group of thoughtful, committed citizens can change the world\" - M. Mead\n\n> On Sep 2, 2016, at 6:27 AM, Stephen Carman <notifications@github.com> wrote:\n> \n> I think swagger is awesome, but for this instance it seems perhaps a bit strange to have clients for this when you can only really run/create jobs in scala/java/python so, like for instance a Ruby client or a C/C++ client doesn't really seem to make much sense other than just as a facility to start jobs. You'd still have to live in a JVM world in some sense.\n> \n> —\n> You are receiving this because you commented.\n> Reply to this email directly, view it on GitHub, or mute the thread.\n> \n"}}
{"actor":{"display_login":"velvia"}}