{"action":"opened","issue":{"url":"https://api.github.com/repos/hal-platform/hal/issues/51","repository_url":"https://api.github.com/repos/hal-platform/hal","labels_url":"https://api.github.com/repos/hal-platform/hal/issues/51/labels{/name}","comments_url":"https://api.github.com/repos/hal-platform/hal/issues/51/comments","events_url":"https://api.github.com/repos/hal-platform/hal/issues/51/events","html_url":"https://github.com/hal-platform/hal/issues/51","id":222041508,"number":51,"title":"Consider switching to API Blueprint and aglio for API docs","user":{"login":"skluck","id":3161125,"avatar_url":"https://avatars0.githubusercontent.com/u/3161125?v=3","gravatar_id":"","url":"https://api.github.com/users/skluck","html_url":"https://github.com/skluck","followers_url":"https://api.github.com/users/skluck/followers","following_url":"https://api.github.com/users/skluck/following{/other_user}","gists_url":"https://api.github.com/users/skluck/gists{/gist_id}","starred_url":"https://api.github.com/users/skluck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/skluck/subscriptions","organizations_url":"https://api.github.com/users/skluck/orgs","repos_url":"https://api.github.com/users/skluck/repos","events_url":"https://api.github.com/users/skluck/events{/privacy}","received_events_url":"https://api.github.com/users/skluck/received_events","type":"User","site_admin":false},"labels":[{"id":521982088,"url":"https://api.github.com/repos/hal-platform/hal/labels/c/api","name":"c/api","color":"eeeeee","default":false},{"id":521982282,"url":"https://api.github.com/repos/hal-platform/hal/labels/c/docs","name":"c/docs","color":"eeeeee","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-04-16T23:56:59Z","updated_at":"2017-04-16T23:56:59Z","closed_at":null,"body":"See:\r\n- https://apiblueprint.org/\r\n- https://github.com/danielgtaylor/aglio\r\n\r\nAPI Blueprint is basically markdown for API definitions. There's a ton of great tooling for it which even includes mock servers. Aglio is a parser/renderer written in nodejs, so at least from that standpoint the tooling is better than slate which uses ruby.\r\n\r\nSee some examples:\r\n- [default](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/default.html)\r\n- [flatly theme](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/flatly-triple.html)\r\n- [slate theme](http://htmlpreview.github.io/?https://raw.githubusercontent.com/danielgtaylor/aglio/blob/master/examples/slate-triple.html)\r\n\r\nIf we could find a documentation schema that works better with hypermedia that would be good, otherwise API blueprint looks like a frontrunner."}}
{"actor":{"display_login":"skluck"}}