{"action":"created","issue":{"url":"https://api.github.com/repos/openzipkin/zipkin/issues/846","labels_url":"https://api.github.com/repos/openzipkin/zipkin/issues/846/labels{/name}","comments_url":"https://api.github.com/repos/openzipkin/zipkin/issues/846/comments","events_url":"https://api.github.com/repos/openzipkin/zipkin/issues/846/events","html_url":"https://github.com/openzipkin/zipkin/issues/846","id":116660389,"number":846,"title":"Document the v1 REST Api","user":{"login":"adriancole","id":64215,"avatar_url":"https://avatars.githubusercontent.com/u/64215?v=3","gravatar_id":"","url":"https://api.github.com/users/adriancole","html_url":"https://github.com/adriancole","followers_url":"https://api.github.com/users/adriancole/followers","following_url":"https://api.github.com/users/adriancole/following{/other_user}","gists_url":"https://api.github.com/users/adriancole/gists{/gist_id}","starred_url":"https://api.github.com/users/adriancole/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adriancole/subscriptions","organizations_url":"https://api.github.com/users/adriancole/orgs","repos_url":"https://api.github.com/users/adriancole/repos","events_url":"https://api.github.com/users/adriancole/events{/privacy}","received_events_url":"https://api.github.com/users/adriancole/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2015-11-12T22:54:30Z","updated_at":"2015-12-22T19:28:57Z","closed_at":null,"body":"The query server presents a REST api under the /v1 namespace. This needs to be documented.\r\n\r\nIt is a good time to do this, as we don't expect many major changes. Major changes would coincide with our v2 model https://docs.google.com/document/d/1ixxEs9TvhiGjJObGbRSPhSna3zHdadoUTQIZ5JKgLzU/edit"},"comment":{"url":"https://api.github.com/repos/openzipkin/zipkin/issues/comments/166709472","html_url":"https://github.com/openzipkin/zipkin/issues/846#issuecomment-166709472","issue_url":"https://api.github.com/repos/openzipkin/zipkin/issues/846","id":166709472,"user":{"login":"netmilk","id":79609,"avatar_url":"https://avatars.githubusercontent.com/u/79609?v=3","gravatar_id":"","url":"https://api.github.com/users/netmilk","html_url":"https://github.com/netmilk","followers_url":"https://api.github.com/users/netmilk/followers","following_url":"https://api.github.com/users/netmilk/following{/other_user}","gists_url":"https://api.github.com/users/netmilk/gists{/gist_id}","starred_url":"https://api.github.com/users/netmilk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/netmilk/subscriptions","organizations_url":"https://api.github.com/users/netmilk/orgs","repos_url":"https://api.github.com/users/netmilk/repos","events_url":"https://api.github.com/users/netmilk/events{/privacy}","received_events_url":"https://api.github.com/users/netmilk/received_events","type":"User","site_admin":false},"created_at":"2015-12-22T19:28:56Z","updated_at":"2015-12-22T19:28:56Z","body":"@adriancole I think it's a great idea! The possibility to let non native programmers edit the documentation and be sure it's still valid is the win of using Dredd. \r\n\r\nThe idea behind Dredd is be able abstract the discussion about the HTTP API to the lingua franca contract - the API Blueprint, but keep it tightly bound to the implementation with [hooks](https://dredd.readthedocs.org/en/latest/hooks/) and tested in CI (!), so it won't get out of sync.\r\n\r\nI think the only catch in your case can be Dredd doesn't support Scala or Java at this moment. But it has precedent support for compiled language ([Go](http://dredd.readthedocs.org/en/latest/hooks-go/)) and [tutorial support for adding new language](https://dredd.readthedocs.org/en/latest/hooks-new-language/) including the [language agnostic testing harness](https://github.com/apiaryio/dredd-hooks-template) so it shouldn't be a problem to add your's if needed. \r\n\r\nI'm excited to help with anything. Just ping me here, on twitter (@ntmlk) or we can schedule a little call if needed."}}