[OASIS Issue Tracker] Commented: (CAMP-51) CAMP uses undocumented notation to describe resources

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

    [ http://tools.oasis-open.org/issues/browse/CAMP-51?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=34494#action_34494 ] 

Gilbert Pilz commented on CAMP-51:
----------------------------------

"..." (ellipses) are normally used in pseudo-schema's like this to indicate points of extension. This is more significant when you are using XML where the order of elements is significant. For example,

<Foo>
  <id> xs:anyURI </id>
  <name xs:string </name>
  ...
  <created> xs:dateTime </created>
</Foo>

indicates that extension elements may appear between the "name" and "created" elements.

Since the order of elements is not significant in JSON, this use of ellipses isn't necessary or even possible. Thankfully, we do not use ellipses in any of the description blocks that use pseudo-schema (e.g. the blocks that appear at the top of very resource section).

Where we do use ellipses is in examples; primarily in examples of HTTP messages. Right now, the explanatory text at the new section seems to indicate that the new section is defining the conventions of the notations that are used in the descriptions, it seems strange to describe the use of an expression (i.e. ellipses) that is never used in any of the descriptions. It seems to me that we can either (a) omit mentioning ellipses in the new section and rely on the common understanding of their purpose and their limited scope of application (non-normative examples or (b) divide the new section up into "conventions for descriptions" and "conventions for examples".

> CAMP uses undocumented notation to describe resources
> -----------------------------------------------------
>
>                 Key: CAMP-51
>                 URL: http://tools.oasis-open.org/issues/browse/CAMP-51
>             Project: OASIS Cloud Application Management for Platforms (CAMP) TC
>          Issue Type: Bug
>          Components: Spec
>            Reporter: Gilbert Pilz
>
> The "general representations" of the resources defined by CAMP uses a pseudo-schema syntax for indicating things like types, cardinality, etc. This syntax is not documented anywhere.

-- 
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