[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] Commented: (ODATA-335) Review results for OData ATOM Format Version 4.0
[ http://tools.oasis-open.org/issues/browse/ODATA-335?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=33047#action_33047 ] Ralf Handl commented on ODATA-335: ---------------------------------- SD4/SD5: Looking at the current structure of Part 1: Protocol, chapter 10 we've derived the following outline for the format specifications: Service Doc Entity Property Navigation Property Media Collections Entity References Count Delta Create: only differences between POST request and GET response Update: only differences between PATCH request and GET response Update Link: only differences between POST/PUT request and GET response Actions & Functions advertisement Action parameters Annotations Error response > Review results for OData ATOM Format Version 4.0 > ------------------------------------------------ > > Key: ODATA-335 > URL: http://tools.oasis-open.org/issues/browse/ODATA-335 > Project: OASIS Open Data Protocol (OData) TC > Issue Type: Improvement > Components: OData ATOM Format > Affects Versions: V4.0_WD01 > Environment: [Proposed] > Reporter: Martin Zurmuehl > Assignee: Ralf Handl > > In our review today we came up with the following points and resolution proposals (copied from the chat): > Review document can be found at https://www.oasis-open.org/committees/download.php/48588/odata-atom-format-v4.0-wd01-2013-03-19.doc > SDx and so on are references to comments in this document > SD2: follow Stefan's proposal > JW3: follow > Atom 3 Primitive Types: use same structure and example as in JSON 4.11 > And sync the document structures!!! > This covers SD4 and SD5 > Atom 4 Use of Atom: avoid "safely ignore" and instead follow wording of Atom on processing foreign markup > Refers to SD6 > Common outline of format documents > Follow conformance: READ, WRITE, sophisticated > Mirror hypermedia-driven client: service document, collections, entities, properties > Easier headlines: n.m Element atom:xxx, n.m.1 Attribute yyy > Empty elements in examples: no space before "closing" slash > Common outline refers to SD7 > Empty elements refers to SD9 > Check if we can use another monospaced font for code examples other than Courier New > SD10: accepted > SD11: accepted - follow/cite part 1 Protocol passage > In general: restrict format specs to format-specific stuff and don't repeat the format-independent Core stuff > Atom 12 Action Parameters > SD14: accepted - make clear that sentence talks only about <parameters> element, not its children > SD15: accepted - state difference between explicitly passing null and passing nothing for allowing the default value > Atom 13 Errors as XML > SD16: accepted > SD17: accepted > SD18: accepted - not format specific, just refer to Core > Maybe state that OData is in sync with Atom Syndication here -- 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
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]