allura-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dave Brondsema" <d...@brondsema.net>
Subject [allura:tickets] Ticket 6797 discussion
Date Thu, 13 Aug 2015 20:38:10 GMT
- **status**: review --> in-progress
- **Comment**:

This is in git now and I've made several changes, see branch `db/6797` and please review those.
 A few more things we should do that I'll hand back to you for:

* need an example and schema for an individual forum.  See `FIXME` in api.raml
* Add some doc text so it's part of the file and shows up above the API details.  I'm thinking
about stuff like the opening sentences on https://sourceforge.net/p/forge/documentation/Allura%20API/
and the text about authenticating, etc.  See http://raml.org/spec.html#user-documentation
for the raml properties.

Followup for separate tickets:

* cover git/hg/svn endpoints.  They need some cleanup first, as they are simplistic and isn't
even hooked up for svn
* cover `/p/{project}/_nav.json` ?  Would need to move `/rest/` from the base URI into the
heirarchy, but that'd be good anyway so it shows up in the UI (it seems slightly hidden to
me right now)
* maybe update POST endpoints to take json in addition to form-encoded



---

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

**Status:** in-progress
**Milestone:** unreleased
**Labels:** allura-api asf sf-current sf-4 
**Created:** Fri Oct 25, 2013 04:23 PM UTC by Dave Brondsema
**Last Updated:** Wed Aug 12, 2015 07:01 PM UTC
**Owner:** Heith Seewald


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 forge-allura.apache.org because dev@allura.apache.org is subscribed to https://forge-allura.apache.org/p/allura/tickets/

To unsubscribe from further messages, a project admin can change settings at https://forge-allura.apache.org/p/allura/admin/tickets/options.
 Or, if this is a mailing list, you can unsubscribe from the mailing list.
Mime
  • Unnamed multipart/related (inline, None, 0 bytes)
View raw message