You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@falcon.apache.org by Narayan Periwal <na...@inmobi.com> on 2015/09/21 11:57:23 UTC
Review Request 38548: FALCON-438: Auto generate documentation for
REST API
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/
-----------------------------------------------------------
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
-----
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
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Pallavi Rao <pa...@inmobi.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/#review100395
-----------------------------------------------------------
Ship it!
Ship It!
- Pallavi Rao
On Sept. 24, 2015, 11:19 a.m., Narayan Periwal wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/38548/
> -----------------------------------------------------------
>
> (Updated Sept. 24, 2015, 11:19 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
> -----
>
> 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
>
>
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Balu Vellanki <bv...@hortonworks.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/#review100422
-----------------------------------------------------------
Ship it!
Very useful, looks good to me.
- Balu Vellanki
On Sept. 24, 2015, 11:19 a.m., Narayan Periwal wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/38548/
> -----------------------------------------------------------
>
> (Updated Sept. 24, 2015, 11:19 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
> -----
>
> 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
>
>
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Ajay Yadava <aj...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/#review100448
-----------------------------------------------------------
Ship it!
Ship It!
- Ajay Yadava
On Sept. 24, 2015, 11:19 a.m., Narayan Periwal wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/38548/
> -----------------------------------------------------------
>
> (Updated Sept. 24, 2015, 11:19 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
> -----
>
> 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
>
>
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Narayan Periwal <na...@inmobi.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/
-----------------------------------------------------------
(Updated Sept. 24, 2015, 11:19 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
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Pallavi Rao <pa...@inmobi.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/#review100384
-----------------------------------------------------------
docs/src/site/twiki/restapi/ResourceList.twiki (line 32)
<https://reviews.apache.org/r/38548/#comment157564>
Reword :
... documentation is also hosted on the Falcon server and Prism Server (in distributed mode) ...
webapp/pom.xml (line 54)
<https://reviews.apache.org/r/38548/#comment157565>
Can you make similar changes to prism/pom.xml, so the docs are available on Prism server too?
- Pallavi Rao
On Sept. 24, 2015, 9:04 a.m., Narayan Periwal wrote:
>
> -----------------------------------------------------------
> 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
> -----
>
> 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
>
>
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Narayan Periwal <na...@inmobi.com>.
-----------------------------------------------------------
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
Re: Review Request 38548: FALCON-438: Auto generate documentation for
REST API
Posted by Narayan Periwal <na...@inmobi.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/38548/
-----------------------------------------------------------
(Updated Sept. 22, 2015, 7:22 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