[
https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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}
<services>
<rest defaultRestSubcontext="/api" >
<custom-resource-parameter-annotation
qualifiedName="org.glassfish.jersey.media.multipart.FormDataParam"/>
<api-import
pattern="org.apache.falcon.resource.admin.AdminResource" />
<api-import
pattern="org.apache.falcon.resource.proxy.InstanceManagerProxy" />
<api-import
pattern="org.apache.falcon.resource.proxy.SchedulableEntityManagerProxy" />
<api-import
pattern="org.apache.falcon.resource.metadata.LineageMetadataResource" />
<api-import
pattern="org.apache.falcon.resource.metadata.MetadataDiscoveryResource" />
</rest>
</services>
{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)
