[
https://issues.apache.org/jira/browse/RAVE-1224?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jmeas Pls updated RAVE-1224:
----------------------------
Summary: Determine means to document the API (was: Document API)
> Determine means to document the API
> -----------------------------------
>
> Key: RAVE-1224
> URL: https://issues.apache.org/jira/browse/RAVE-1224
> Project: Rave
> Issue Type: Sub-task
> Reporter: Jmeas Pls
>
> [~carldanley], we're adding a large number of new API routes to the project.
> For anyone to ever be able to implement them in Java, we'll need to give them
> nice documentation that they can go through one-by-one on.
> I'm thinking something like this: https://dev.twitter.com/docs/api/1.1
> Of course, that degree of sophistication might not be what we need. But
> something to that extent would be immensely useful to the folks who pick up
> on this after us.
> I'll leave this decision up to you on how you want to document it.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
