You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@atlas.apache.org by Apoorv Naik <na...@gmail.com> on 2017/02/14 18:48:04 UTC
Review Request 56672: ATLAS-1370: Atlas REST documentation
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/56672/
-----------------------------------------------------------
Review request for atlas, Ashutosh Mestry, Madhan Neethiraj, Sarath Subramanian, Suma Shivaprasad, and Vimal Sharma.
Bugs: ATLAS-1370
https://issues.apache.org/jira/browse/ATLAS-1370
Repository: atlas
Description
-------
Currently there's no easy way of figuring the REST interactions for atlas unless you know the exact place where to look the REST interfaces. Enunciate is a build plugin that allows a project to create such html docs for easier understanding of the REST endpoints.
Currently the enunciate version being used has some limitations when building with JDK8 thus it's activated using a profile called jdk7. The latest version of enunciate has no such limitation and hence the profile activation might not be necessary (added a skipEnunciate property for enable/disable control).
This review is mainly for the TypesREST, LineageREST and DiscoveryREST.
HOWTO:
cd webapp
mvn clean package -DskipTests -DskipSite=false -DskipEnunciate=false
Docs generated under webapp/target/api/v2/ (open the index.html page in your favorite browser)
Diffs
-----
build-tools/src/main/resources/enunciate.xml 777b496a
intg/src/main/java/org/apache/atlas/AtlasErrorCode.java adffee7c
pom.xml 834ecae0
webapp/pom.xml 5dc74019
webapp/src/main/java/org/apache/atlas/web/resources/AdminResource.java 440d75ce
webapp/src/main/java/org/apache/atlas/web/rest/DiscoveryREST.java 48d8d493
webapp/src/main/java/org/apache/atlas/web/rest/LineageREST.java 0904b693
webapp/src/main/java/org/apache/atlas/web/rest/TypesREST.java 3203b712
Diff: https://reviews.apache.org/r/56672/diff/
Testing
-------
No testing needed as there's no functionality change.
Will run mvn clean install -DskipTests for build sanity.
Thanks,
Apoorv Naik
Re: Review Request 56672: ATLAS-1370: Atlas REST documentation
Posted by Vimal Sharma <vi...@hortonworks.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/56672/#review165854
-----------------------------------------------------------
Ship it!
Ship It!
- Vimal Sharma
On Feb. 16, 2017, 4:18 a.m., Apoorv Naik wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/56672/
> -----------------------------------------------------------
>
> (Updated Feb. 16, 2017, 4:18 a.m.)
>
>
> Review request for atlas, Ashutosh Mestry, Madhan Neethiraj, Sarath Subramanian, Suma Shivaprasad, and Vimal Sharma.
>
>
> Bugs: ATLAS-1370
> https://issues.apache.org/jira/browse/ATLAS-1370
>
>
> Repository: atlas
>
>
> Description
> -------
>
> Currently there's no easy way of figuring the REST interactions for atlas unless you know the exact place where to look the REST interfaces. Enunciate is a build plugin that allows a project to create such html docs for easier understanding of the REST endpoints.
>
> Currently the enunciate version being used has some limitations when building with JDK8 thus it's activated using a profile called jdk7. The latest version of enunciate has no such limitation and hence the profile activation might not be necessary (added a skipEnunciate property for enable/disable control).
>
> This review is mainly for the TypesREST, LineageREST and DiscoveryREST.
>
> HOWTO:
>
> mvn clean install -DskipTests -DskipSite=false -DskipEnunciate=false
>
> Docs generated under webapp/target/api/v2/ (open the index.html page in your favorite browser)
>
>
> Diffs
> -----
>
> build-tools/src/main/resources/enunciate.xml 777b496a
> docs/src/site/twiki/index.twiki d45f4dae
> intg/src/main/java/org/apache/atlas/AtlasErrorCode.java ae6be843
> pom.xml 834ecae0
> webapp/pom.xml 5dc74019
> webapp/src/main/java/org/apache/atlas/web/resources/AdminResource.java 440d75ce
> webapp/src/main/java/org/apache/atlas/web/rest/DiscoveryREST.java 48d8d493
> webapp/src/main/java/org/apache/atlas/web/rest/LineageREST.java 0904b693
> webapp/src/main/java/org/apache/atlas/web/rest/TypesREST.java 3203b712
>
> Diff: https://reviews.apache.org/r/56672/diff/
>
>
> Testing
> -------
>
> No testing needed as there's no functionality change.
>
> Will run mvn clean install -DskipTests for build sanity.
>
>
> Thanks,
>
> Apoorv Naik
>
>
Re: Review Request 56672: ATLAS-1370: Atlas REST documentation
Posted by Apoorv Naik <na...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/56672/
-----------------------------------------------------------
(Updated Feb. 16, 2017, 4:18 a.m.)
Review request for atlas, Ashutosh Mestry, Madhan Neethiraj, Sarath Subramanian, Suma Shivaprasad, and Vimal Sharma.
Changes
-------
Added V2 rest link in index page of twiki
Older api docs will be moved under legacy link
Bugs: ATLAS-1370
https://issues.apache.org/jira/browse/ATLAS-1370
Repository: atlas
Description
-------
Currently there's no easy way of figuring the REST interactions for atlas unless you know the exact place where to look the REST interfaces. Enunciate is a build plugin that allows a project to create such html docs for easier understanding of the REST endpoints.
Currently the enunciate version being used has some limitations when building with JDK8 thus it's activated using a profile called jdk7. The latest version of enunciate has no such limitation and hence the profile activation might not be necessary (added a skipEnunciate property for enable/disable control).
This review is mainly for the TypesREST, LineageREST and DiscoveryREST.
HOWTO:
mvn clean install -DskipTests -DskipSite=false -DskipEnunciate=false
Docs generated under webapp/target/api/v2/ (open the index.html page in your favorite browser)
Diffs (updated)
-----
build-tools/src/main/resources/enunciate.xml 777b496a
docs/src/site/twiki/index.twiki d45f4dae
intg/src/main/java/org/apache/atlas/AtlasErrorCode.java ae6be843
pom.xml 834ecae0
webapp/pom.xml 5dc74019
webapp/src/main/java/org/apache/atlas/web/resources/AdminResource.java 440d75ce
webapp/src/main/java/org/apache/atlas/web/rest/DiscoveryREST.java 48d8d493
webapp/src/main/java/org/apache/atlas/web/rest/LineageREST.java 0904b693
webapp/src/main/java/org/apache/atlas/web/rest/TypesREST.java 3203b712
Diff: https://reviews.apache.org/r/56672/diff/
Testing
-------
No testing needed as there's no functionality change.
Will run mvn clean install -DskipTests for build sanity.
Thanks,
Apoorv Naik
Re: Review Request 56672: ATLAS-1370: Atlas REST documentation
Posted by Apoorv Naik <na...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/56672/
-----------------------------------------------------------
(Updated Feb. 16, 2017, 2:51 a.m.)
Review request for atlas, Ashutosh Mestry, Madhan Neethiraj, Sarath Subramanian, Suma Shivaprasad, and Vimal Sharma.
Bugs: ATLAS-1370
https://issues.apache.org/jira/browse/ATLAS-1370
Repository: atlas
Description (updated)
-------
Currently there's no easy way of figuring the REST interactions for atlas unless you know the exact place where to look the REST interfaces. Enunciate is a build plugin that allows a project to create such html docs for easier understanding of the REST endpoints.
Currently the enunciate version being used has some limitations when building with JDK8 thus it's activated using a profile called jdk7. The latest version of enunciate has no such limitation and hence the profile activation might not be necessary (added a skipEnunciate property for enable/disable control).
This review is mainly for the TypesREST, LineageREST and DiscoveryREST.
HOWTO:
mvn clean install -DskipTests -DskipSite=false -DskipEnunciate=false
Docs generated under webapp/target/api/v2/ (open the index.html page in your favorite browser)
Diffs
-----
build-tools/src/main/resources/enunciate.xml 777b496a
intg/src/main/java/org/apache/atlas/AtlasErrorCode.java adffee7c
pom.xml 834ecae0
webapp/pom.xml 5dc74019
webapp/src/main/java/org/apache/atlas/web/resources/AdminResource.java 440d75ce
webapp/src/main/java/org/apache/atlas/web/rest/DiscoveryREST.java 48d8d493
webapp/src/main/java/org/apache/atlas/web/rest/LineageREST.java 0904b693
webapp/src/main/java/org/apache/atlas/web/rest/TypesREST.java 3203b712
Diff: https://reviews.apache.org/r/56672/diff/
Testing
-------
No testing needed as there's no functionality change.
Will run mvn clean install -DskipTests for build sanity.
Thanks,
Apoorv Naik