[
http://opencast.jira.com/browse/MH-6885?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=24617#comment-24617
]
Josh Holtzman edited comment on MH-6885 at 2/21/11 8:14 AM:
------------------------------------------------------------
restdocs.diff demonstrates one approach to providing rest documentation using a
CXF RequestHandler. It intercepts all requests to {endpoint_root}/docs.html
and generates documentation based on the CXF runtime information, which is
derived from both overall configuration and the class-level JAX-RS annotations.
We can incorporate this into the trunk at any time, since the new documentation
URLs do not conflict with the old ones. Once the new documentation annotations
are in place, we can switch back to the old URL pattern, or simply remove it.
The java.lang.reflect.Method, along with any custom annotations, can be
accessed via OperationResourceInfo.getAnnotatedMethod(). Class-level
annotations are available via jaxRsService.getClass().getAnnotations().
Once we've got all of the documentation information assembled, we should
probably populate some kind of data structure to feed to a templating system.
Bonus points if we can use jquery templates or trimpath on the server, so can
keep the templating syntax in line with the rest of the user interfaces.
This patch was produced on the 1.1.x branch, since the RestPublisher has seen
some changes that have not yet been merged back into the trunk.
was (Author: jholtzman):
restdocs.diff demonstrates one approach to providing rest documentation
using a CXF RequestHandler. It intercepts all requests to
{endpoint_root}/docs.html and generates documentation based on the CXF runtime
information, which is derived from both overall configuration and the
class-level JAX-RS annotations.
We can incorporate this into the trunk at any time, since the new documentation
URLs do not conflict with the old ones. Once the new documentation annotations
are in place, we can switch back to the old URL pattern, or simply remove it.
The java.lang.reflect.Method, along with any custom annotations, can be
accessed via OperationResourceInfo.getAnnotatedMethod(). Class-level
annotations are available via jaxRsService.getClass().getAnnotations().
This patch was produced on the 1.1.x branch, since the RestPublisher has seen
some changes that have not yet been merged back into the trunk.
> Outline the steps to replace the old doc engine
> -----------------------------------------------
>
> Key: MH-6885
> URL: http://opencast.jira.com/browse/MH-6885
> Project: Matterhorn Project
> Issue Type: Sub-Task
> Components: Architecture & Services
> Affects Versions: 1.2
> Reporter: Christopher Brooks
> Assignee: Kenneth Lui
> Fix For: 1.2
>
> Attachments: restdocs.diff
>
>
> Now that we have a base template setup, what do we need to do to replace the
> current docs system with this? How are docs html being generated, and what
> files from there do we need to bring into matterhorn kernel?
--
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
_______________________________________________
Matterhorn mailing list
[email protected]
http://lists.opencastproject.org/mailman/listinfo/matterhorn
To unsubscribe please email
[email protected]
_______________________________________________
