falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Narayan Periwal" <narayan.peri...@inmobi.com>
Subject Re: Review Request 38548: FALCON-438: Auto generate documentation for REST API
Date Thu, 24 Sep 2015 09:04:15 GMT

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/
-----------------------------------------------------------

(Updated Sept. 24, 2015, 9:04 a.m.)


Review request for Falcon.


Repository: falcon-git


Description
-------

To auto-generate the documentation for the rest api's, there is an enunciate plugin available
in Maven. We can run enunciate as part of our build process and it generates nice HTML based
documentation of our web services. It uses the javadoc of the api's for the documentation
purpose.


Diffs (updated)
-----

  docs/src/site/twiki/restapi/ResourceList.twiki 8dc4a49 
  pom.xml 646de69 
  prism/enunciate.xml PRE-CREATION 
  prism/pom.xml 6eca0b9 
  prism/src/main/java/org/apache/falcon/resource/admin/AdminResource.java 50b668c 
  prism/src/main/java/org/apache/falcon/resource/metadata/LineageMetadataResource.java d595221

  prism/src/main/java/org/apache/falcon/resource/metadata/MetadataDiscoveryResource.java 220cc42

  prism/src/main/java/org/apache/falcon/resource/proxy/InstanceManagerProxy.java 3343c52 
  prism/src/main/java/org/apache/falcon/resource/proxy/SchedulableEntityManagerProxy.java
61a80c1 
  webapp/pom.xml 828f7f5 

Diff: https://reviews.apache.org/r/38548/diff/


Testing
-------

Done.


Thanks,

Narayan Periwal


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message