You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@allura.apache.org by Dave Brondsema <br...@users.sf.net> on 2013/10/25 18:23:55 UTC

[allura:tickets] #6797 Move API docs from sf.net wiki to Allura (with raml?)



---

** [tickets:#6797] Move API docs from sf.net wiki to Allura (with raml?)**

**Status:** open
**Labels:** allura-api asf 
**Created:** Fri Oct 25, 2013 04:23 PM UTC by Dave Brondsema
**Last Updated:** Fri Oct 25, 2013 04:23 PM UTC
**Owner:** nobody

Right now the allura API docs are at https://sourceforge.net/p/forge/documentation/Allura%20API/  They should be moved to Allura itself.

We should also consider writing the API docs with [RAML](http://raml.org/) which looks very nice to me.  Simple and readable, has composition for things like "pagination" which apply to multiple endpoints.  With RAML we could also show interactive documentation with "try it live" functionality at http://www.apihub.com/


---

Sent from sourceforge.net because allura-dev@incubator.apache.org is subscribed to https://sourceforge.net/p/allura/tickets/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/allura/admin/tickets/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.