[
http://opencast.jira.com/browse/MH-6885?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=24873#comment-24873
]
Josh Holtzman commented on MH-6885:
-----------------------------------
> The Format class contains the name, description and url of the format
The number of formats is small. I would rather centralize the URLs and
descriptions in the doc utils itself, relying only on the @Produces mediatype
from the annotations. Alternatively, just leave it out. xml, json, and
icalendar are well known to most developers.
> with @Produces, developers can put more than 1 value in it (i.e. put an array)
Correct, same with @Consumes. We should support this, even though we
distinguish formats using the URL rather than accept headers.
> "GET /{eventId}.{format}.{xml|json}" in "/scheduler/docs" is one method but
> it is in fact 2 java methods in the code
This is an optimization that's easy to do with the old doc engine, but harder
with the new one. My suggestion is to simply display the two methods as two
different operations. We can come back and optimize later.
> everyone is using the auto mode
Great, let's just stick with auto for now then. We can always migrate the
custom form code if necessary at a later point. It seems that, for now, auto
generated forms are sufficient for all of our use cases. A feature isn't
really a feature if nobody's using it.
> 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: mh6885v1.diff, restdocs.diff, 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]
_______________________________________________