allura-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Heith Seewald" <hseew...@slashdotmedia.com>
Subject [allura:tickets] Ticket 6797 discussion
Date Mon, 03 Aug 2015 22:14:18 GMT
I've attached the source RAML files in a single zip file that can be imported directly via
[mulesoft's api designer](https://anypoint.mulesoft.com), or by [your own instance](https://github.com/mulesoft/api-designer).


There is also a live [API Portal](https://anypoint.mulesoft.com/apiplatform/sf-2/#/portals/organizations/86c00a85-31e6-4302-b36d-049ca5d042fd/apis/26318/versions/27961/pages/42838)
that includes some extra pages (like the API overview page).

There are still a few rough edges, but hopfully through the process of QA we can begin to
refine them :)


Attachments:

- [Allura-vAPI_v1.zip](https://forge-allura.apache.org/p/allura/tickets/_discuss/thread/dd050dc1/e767/attachment/Allura-vAPI_v1.zip)
(23.8 kB; application/zip)


---

** [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 Jul 01, 2015 07:51 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