[OASIS Issue Tracker] Commented: (CMIS-106) Clarify types-childrenand types-descendants

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ http://tools.oasis-open.org/issues/browse/CMIS-106?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=10123#action_10123 ] 

Ryan McVeigh commented on CMIS-106:
-----------------------------------

I'm not sure how to add a proposal to this issue - it isn't an option - perhaps because there are already comments?  Anyway here's my proposal:

Proposal: Make getTypeDefinition/getTypeChildren/getTypeDescendants consistent with getProperties/getChildren/getDescendants (in behavior and structure - and note more consistent naming). Specifically:

    * getTypeDefinition should return an Entry describing a single type
    * getTypeChildren should return the direct children of a type (or the root type) as a Feed. The resource should identify the type whose children will be fetched. Optional (query) args include includePropertyDefinintions, maxItems, skipCount.
    * getTypeDescendants should return the descendants of a type (or the root type) as a feed with nesting (child types will be contained in their parent's atom:entry) up to the specified depth. The resource should identify the type whose descendants will be fetched. Optional (query) args include includePropertyDefinintions, and depth.

--

This one is causing us some grief in prototyping and I would update its priority to Critical.

> Clarify types-children and types-descendants
> --------------------------------------------
>
>                 Key: CMIS-106
>                 URL: http://tools.oasis-open.org/issues/browse/CMIS-106
>             Project: OASIS Content Management Interoperability Services TC
>          Issue Type: Bug
>          Components: REST/AtomPub Binding
>    Affects Versions: Draft 0.50
>            Reporter: Ryan McVeigh
>            Assignee: Al Brown
>
> What is the difference between TypesChildren and TypesDescendants? The description of both says they are feeds containing all the types in the repository. If both resources contain all types, then what is the difference?
>    1. I suspect that either TypesDescendants is redundant and unnecessary, or
>    2. that the descriptions are wrong, and they should be returning feeds of types that are children/descendants of a given type.
>    3. Note that there is no "typeDescendants" description in the repository services section (REST)
>    4. Also note the description of getTypes in Part 1 has a note that "CMIS will return [the types] as a flat list". It also says that if a typeId parameter is provided, then it will "only return that type and its descendants".
>        a. This makes it sound like there is no such thing as TypesChildren, and should only be TypesDescendants? And it is really not exactly descendants, since it also includes the "root" type (identified by the parameter). Gack.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira