atlas-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apoorv Naik <>
Subject Re: Review Request 56672: ATLAS-1370: Atlas REST documentation
Date Thu, 16 Feb 2017 04:18:54 GMT

This is an automatically generated e-mail. To reply, visit:

(Updated Feb. 16, 2017, 4:18 a.m.)

Review request for atlas, Ashutosh Mestry, Madhan Neethiraj, Sarath Subramanian, Suma Shivaprasad,
and Vimal Sharma.


Added V2 rest link in index page of twiki
Older api docs will be moved under legacy link

Bugs: ATLAS-1370

Repository: atlas


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. 


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/ ae6be843 
  pom.xml 834ecae0 
  webapp/pom.xml 5dc74019 
  webapp/src/main/java/org/apache/atlas/web/resources/ 440d75ce 
  webapp/src/main/java/org/apache/atlas/web/rest/ 48d8d493 
  webapp/src/main/java/org/apache/atlas/web/rest/ 0904b693 
  webapp/src/main/java/org/apache/atlas/web/rest/ 3203b712 



No testing needed as there's no functionality change.

Will run mvn clean install -DskipTests for build sanity.


Apoorv Naik

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