[OASIS Issue Tracker] Updated: (ODATA-351) Define ID, ReadLink and EditLink in Part 1: Protocol, define representation in Atom and JSON

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

     [ http://tools.oasis-open.org/issues/browse/ODATA-351?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Martin Zurmuehl updated ODATA-351:
----------------------------------

    Proposal: 
Part 1: Protocol
- Define concept of "transient" entities and feeds in addition to the already defined "addressable" entities and feeds. 
- Define concepts ID, ReadLink and EditLink. 
- Feeds and entities MUST have ID which MUST be IRI.
- Feeds and entities MAY have ReadLink which MAY be identical to ID. Feeds and entities without ReadLink are transient.
- Entities MAY have EditLink which MAY be identical to ReadLink. Entities without EditLink are read-only.

Atom
- ID in <atom:id>
- Feed:
-- ReadLink as <link rel="self"> to re-read feed, MUST be complete request URL with options OR use "shortened" URL that can produce same result
-- No <link rel="self"> => transient feed

- Entity
-- EditLink as <link rel="edit"> present: updatable and readable
-- ReadLink as <link rel="self"> present without EditLink: read-only entity, with EditLink: different URL
-- No EditLink and no ReadLink: transient entity
		
Mapping to JSON
- ID as odata.id required in entity AND feed
- ReadLink as odata.readLink; absent: use ID from odata.id, MUST be dereferencable URL
- ReadLink present as "odata.readLink": null means transient entity or feed
- EditLink as odata.editLink; absent: use ReadLink (from odata.readLink or odata.id)
- EditLink present: different from ReadLink


  was:
Part 1: Protocol
- Feeds and entities MUST have ID which MUST be IRI.
- Feeds and entities MAY have ReadLink which MAY be identical to ID. Feeds and entities without ReadLink are transient.
- Entities MAY have EditLink which MAY be identical to ReadLink. Entities without EditLink are read-only.

Atom
- ID in <atom:id>
- Feed:
-- ReadLink as <link rel="self"> to re-read feed, MUST be complete request URL with options OR use "shortened" URL that can produce same result
-- No <link rel="self"> => transient feed

- Entity
-- EditLink as <link rel="edit"> present: updatable and readable
-- ReadLink as <link rel="self"> present without EditLink: read-only entity, with EditLink: different URL
-- No EditLink and no ReadLink: transient entity
		
Mapping to JSON
- ID as odata.id required in entity AND feed
- ReadLink as odata.readLink; absent: use ID from odata.id, MUST be dereferencable URL
- ReadLink present as "odata.readLink": null means transient entity or feed
- EditLink as odata.editLink; absent: use ReadLink (from odata.readLink or odata.id)
- EditLink present: different from ReadLink



> Define ID, ReadLink and EditLink in Part 1: Protocol, define representation in Atom and JSON
> --------------------------------------------------------------------------------------------
>
>                 Key: ODATA-351
>                 URL: http://tools.oasis-open.org/issues/browse/ODATA-351
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: OData ATOM Format , OData JSON Format, OData Protocol 
>    Affects Versions: V4.0_WD01
>         Environment: [Proposed]
>            Reporter: Ralf Handl
>             Fix For: V4.0_WD01
>
>
> In certain situations, especially Data Aggregation, we need the concept of "transient" entities and feeds in addition to the already defined "addressable" entities and feeds.
> Protocol should define the concepts ID, ReadLink and EditLink.
> Restrictions due to Atom and AtomPub
> - ID required, MUST be IRI
> - Feed: MAY have Self-Link to re-retrieve THIS feed 
> - Entry
> -- Links are optional
> -- <link rel="self"> identifies resource equivalent to current resource
> -- AtomPub: <link rel="edit"> can be used to retrieve, update, and delete the Resource represented by that Entry

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