We now have a fully documented API now!  It's raml files in
Allura/docs/api-rest.  RAML has a lot of opportunities, e.g. to generate client
libraries automatically, etc.

It's published at
https://anypoint.mulesoft.com/apiplatform/forge-allura/#/portals/organizations/86c00a85-31e6-4302-b36d-049ca5d042fd/apis/32370/versions/33732
which is a nice interface to browse and try it live (very cool, now that we have
CORS support).  Heith and I have access to this, and can give any other PMC
member access as well.

Whenever we add or update and API, we should remember to update the RAML files
and also republish to that Anypoint portal.  Heith noticed during his work on
this RAML ticket that it actually would help a lot if we wrote the API spec
*first* and then implemented the API.  That would avoid inconsistencies (which
our current API has).

I'll post a news item on the website soon too.

-- 
Dave Brondsema : [email protected]
http://www.brondsema.net : personal
http://www.splike.com : programming
              <><

Reply via email to