[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[
https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14906002#comment-14906002
]
Ajay Yadava commented on FALCON-438:
[~nperiwal]
This is superb. Some feedback:
* Currently some sections of the documentation are getting duplicated.
* Mount point for the documentation is not correct, needs a prefix api.
Both issues can be fixed by following changes in the configuration. It should
be like below:
{code}
{code}
Can you please make the changes?
> Auto generate documentation for REST API
>
>
> Key: FALCON-438
> URL: https://issues.apache.org/jira/browse/FALCON-438
> Project: Falcon
> Issue Type: Improvement
> Components: docs
>Affects Versions: 0.5
>Reporter: Venkatesh Seetharam
>Assignee: Narayan Periwal
> Attachments: FALCON-438-v0.patch, FALCON-438-v1.patch
>
>
> http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/
> https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart
> http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html
> Swagger looks pretty good.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[ https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14906214#comment-14906214 ] Narayan Periwal commented on FALCON-438: [~pallavi.rao], addressed your review comments > Auto generate documentation for REST API > > > Key: FALCON-438 > URL: https://issues.apache.org/jira/browse/FALCON-438 > Project: Falcon > Issue Type: Improvement > Components: docs >Affects Versions: 0.5 >Reporter: Venkatesh Seetharam >Assignee: Narayan Periwal > Attachments: FALCON-438-v0.patch, FALCON-438-v1.patch, > FALCON-438-v2.patch, FALCON-438-v3.patch > > > http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/ > https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart > http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html > Swagger looks pretty good. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[ https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14906072#comment-14906072 ] Narayan Periwal commented on FALCON-438: [~ajayyadava], yes I saw that some sections of the documentation was getting duplicated and the mount point was incorrect. I have made the changes suggested by you. I have deployed again and checked that's its not getting duplicated and showing the correct mount point. > Auto generate documentation for REST API > > > Key: FALCON-438 > URL: https://issues.apache.org/jira/browse/FALCON-438 > Project: Falcon > Issue Type: Improvement > Components: docs >Affects Versions: 0.5 >Reporter: Venkatesh Seetharam >Assignee: Narayan Periwal > Attachments: FALCON-438-v0.patch, FALCON-438-v1.patch, > FALCON-438-v2.patch > > > http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/ > https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart > http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html > Swagger looks pretty good. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[ https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14906791#comment-14906791 ] Ajay Yadava commented on FALCON-438: +1. Will commit shortly. > Auto generate documentation for REST API > > > Key: FALCON-438 > URL: https://issues.apache.org/jira/browse/FALCON-438 > Project: Falcon > Issue Type: Improvement > Components: docs >Affects Versions: 0.5 >Reporter: Venkatesh Seetharam >Assignee: Narayan Periwal > Attachments: FALCON-438-v0.patch, FALCON-438-v1.patch, > FALCON-438-v2.patch, FALCON-438-v3.patch > > > http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/ > https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart > http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html > Swagger looks pretty good. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[ https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14902079#comment-14902079 ] Narayan Periwal commented on FALCON-438: [~ajayyadava], I will add the url at which the docs will be available. Just to mention here, The current version of the rest api's documentation is also available in the falcon server at the url http://:/docs > Auto generate documentation for REST API > > > Key: FALCON-438 > URL: https://issues.apache.org/jira/browse/FALCON-438 > Project: Falcon > Issue Type: Improvement > Components: docs >Affects Versions: 0.5 >Reporter: Venkatesh Seetharam >Assignee: Narayan Periwal > Attachments: FALCON-438-v0.patch > > > http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/ > https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart > http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html > Swagger looks pretty good. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[ https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14902010#comment-14902010 ] Ajay Yadava commented on FALCON-438: [~nperiwal] Can you please add the url at which the docs will be available along with server to the docs as well, so that users are aware that they can check the current version of documentation at the specified URL? Will review the remaining patch today. > Auto generate documentation for REST API > > > Key: FALCON-438 > URL: https://issues.apache.org/jira/browse/FALCON-438 > Project: Falcon > Issue Type: Improvement > Components: docs >Affects Versions: 0.5 >Reporter: Venkatesh Seetharam >Assignee: Narayan Periwal > Attachments: FALCON-438-v0.patch > > > http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/ > https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart > http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html > Swagger looks pretty good. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FALCON-438) Auto generate documentation for REST API
[ https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14900449#comment-14900449 ] Pallavi Rao commented on FALCON-438: +1 for that. If we can bundle the docs along with our webapp, users won't need to visit the Falcon documentation page as it will available on the server. > Auto generate documentation for REST API > > > Key: FALCON-438 > URL: https://issues.apache.org/jira/browse/FALCON-438 > Project: Falcon > Issue Type: Improvement > Components: docs >Affects Versions: 0.5 >Reporter: Venkatesh Seetharam >Assignee: Narayan Periwal > > http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/ > https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart > http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html > Swagger looks pretty good. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
