-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/73057/
-----------------------------------------------------------
(Updated Dec. 2, 2020, 2:33 p.m.)
Review request for atlas, Ashutosh Mestry, Jayendra Parab, Madhan Neethiraj,
Nixon Rodrigues, Sameer Shaikh, and Sarath Subramanian.
Changes
-------
Updated reviewers details
Bugs: ATLAS-3913
https://issues.apache.org/jira/browse/ATLAS-3913
Repository: atlas
Description (updated)
-------
Currently, swagger documentation is not available with packaging.
This change will allow atlas server deployment to host its REST API doc using
Swagger.
## Approach:
* Update enuntiate plugin version from 2.11.1 to 2.13.2
* Download latest swagger-ui from
https://github.com/swagger-api/swagger-ui/archive/v3.36.2.zip & extract.
* Move swagger-ui-3.36.2/dist/<required_files> to
build-tools/src/main/resources/ui-dist
* Update swagger tag in enuntiate.xml
* Inside build-tools/src/main/resources/ui-dist :
* Create index.js
* Modify SwaggerUIBundle object in ui-dist/index.html to load index.js
along with following:
1 modify url to load swagger.json
2 Add requestInterceptor
* Updated Header.js, UrlLinks.js, Header.html to add API documentation menu.
## How to navigate to the documentation page?
-> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation
(see attached screenshot for reference)
Diffs
-----
3party-licenses/normalize.css-LICENSE PRE-CREATION
3party-licenses/swagger-ui-LECENSE PRE-CREATION
build-tools/src/main/resources/enunciate.xml 8a9383a01
build-tools/src/main/resources/ui-dist/favicon-16x16.png PRE-CREATION
build-tools/src/main/resources/ui-dist/favicon-32x32.png PRE-CREATION
build-tools/src/main/resources/ui-dist/index.html PRE-CREATION
build-tools/src/main/resources/ui-dist/index.js PRE-CREATION
build-tools/src/main/resources/ui-dist/swagger-ui-bundle.js PRE-CREATION
build-tools/src/main/resources/ui-dist/swagger-ui-standalone-preset.js
PRE-CREATION
build-tools/src/main/resources/ui-dist/swagger-ui.css PRE-CREATION
dashboardv2/public/js/templates/site/Header.html 97e124aaa
dashboardv2/public/js/utils/UrlLinks.js 6d3c07952
dashboardv2/public/js/views/site/Header.js 2d6b55d47
dashboardv3/public/js/templates/site/Header.html 6d5e6efac
dashboardv3/public/js/utils/UrlLinks.js 69e527442
dashboardv3/public/js/views/site/Header.js cce00c730
pom.xml ba9450c16
webapp/pom.xml fe5dc0bdb
Diff: https://reviews.apache.org/r/73057/diff/2/
Testing (updated)
-------
Tested few APIs (POST | GET| DELETE) manually.
File Attachments
----------------
How-to-navigate-to-the-documentation-page
https://reviews.apache.org/media/uploaded/files/2020/12/02/8fe22101-fbf8-4ab2-87d9-6bfee0949845__99964008-a62afe80-2db8-11eb-8ecd-cea617fe7f4a.png
Thanks,
Nikhil Bonte
