[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-12-09 Thread Nikhil Bonte (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nikhil Bonte updated ATLAS-3913:

Attachment: how_to_navigate.png
swagger_rest_api_doc_page.png

> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Affects Versions: 2.1.0
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
> Fix For: 3.0.0, 2.2.0
>
> Attachments: how_to_navigate.png, swagger_rest_api_doc_page.png
>
>  Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.2 
> h3. 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/ 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.
>  
> h3. How to navigate to the documentation page?
> -> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation 
> (see attached screenshot for reference)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-12-09 Thread Nikhil Bonte (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nikhil Bonte updated ATLAS-3913:

Description: 
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.2 
h3. 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/ 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.

 
h3. How to navigate to the documentation page?

-> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation 
(see attached screenshot for reference)

  was:
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.2
 
h2. 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/ 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.

 
h2. How to navigate to the documentation page?
-> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation 
(see attached screenshot for reference)


> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Affects Versions: 2.1.0
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
> Fix For: 3.0.0, 2.2.0
>
>  Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.2 
> h3. 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/ 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.
>  
> h3. How to navigate to the documentation page?
> -> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation 
> (see attached screenshot for reference)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-12-09 Thread Nikhil Bonte (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nikhil Bonte updated ATLAS-3913:

Description: 
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.2
 
h2. 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/ 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.

 
h2. How to navigate to the documentation page?
-> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation 
(see attached screenshot for reference)

  was:
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.2


> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Affects Versions: 2.1.0
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
> Fix For: 3.0.0, 2.2.0
>
>  Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.2
>  
> h2. 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/ 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.
>  
> h2. How to navigate to the documentation page?
> -> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation 
> (see attached screenshot for reference)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-12-09 Thread Nikhil Bonte (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nikhil Bonte updated ATLAS-3913:

Description: 
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.2

  was:
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.1


> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Affects Versions: 2.1.0
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
> Fix For: 3.0.0, 2.2.0
>
>  Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.2



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-08-07 Thread Sarath Subramanian (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Sarath Subramanian updated ATLAS-3913:
--
Labels: REST_API swagger  (was: )

> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.1



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-08-07 Thread Sarath Subramanian (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Sarath Subramanian updated ATLAS-3913:
--
Affects Version/s: 2.1.0

> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Affects Versions: 2.1.0
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.1



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-08-07 Thread Sarath Subramanian (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Sarath Subramanian updated ATLAS-3913:
--
Fix Version/s: 2.2.0
   3.0.0

> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Affects Versions: 2.1.0
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>  Labels: REST_API, swagger
> Fix For: 3.0.0, 2.2.0
>
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.1



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-08-07 Thread Nikhil Bonte (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nikhil Bonte updated ATLAS-3913:

Description: 
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into the war file.

Also update enunciate version from 2.11.1 to 2.13.1

  was:
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into war.

Also update enunciate version from 2.11.1 to 2.13.1


> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into the war file.
> Also update enunciate version from 2.11.1 to 2.13.1



--
This message was sent by Atlassian Jira
(v8.3.4#803005)


[jira] [Updated] (ATLAS-3913) Swagger documentation for APIs

2020-08-07 Thread Nikhil Bonte (Jira)


 [ 
https://issues.apache.org/jira/browse/ATLAS-3913?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nikhil Bonte updated ATLAS-3913:

Description: 
Current packaging does not package swagger ui into Atlas war.

This change will pack swagger ui into war.

Also update enunciate version from 2.11.1 to 2.13.1

  was:
Enunciate does not package swagger ui into Atlas war.

This change will pack swagger ui into war.

Also update enunciate version from 2.11.1 to 2.13.1


> Swagger documentation for APIs
> --
>
> Key: ATLAS-3913
> URL: https://issues.apache.org/jira/browse/ATLAS-3913
> Project: Atlas
>  Issue Type: Bug
>  Components:  atlas-core, atlas-webui
>Reporter: Nikhil Bonte
>Assignee: Nikhil Bonte
>Priority: Major
>
> Current packaging does not package swagger ui into Atlas war.
> This change will pack swagger ui into war.
> Also update enunciate version from 2.11.1 to 2.13.1



--
This message was sent by Atlassian Jira
(v8.3.4#803005)