[OASIS Issue Tracker] (ODATA-994) consider replacing SchemaVersion header with $SchemaVersion query option, or root URL versioning

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

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

Martin Zurmuehl updated ODATA-994:
----------------------------------

    Proposal: 
If the only difference between two request is the SchemaVersion Header value, the response is not cachable in all today-browser-implementations (the 'vary' header is not treated correct). 
--> To enable caching of responses we need differentiating URL's. We should use a $SchemaVersion query option. It is superior to adding a segment to the root url, because clients are anyhow familiar with adding query options.
The usage of a $SchemaVersion query option in the relative contextURLs is save; according to rfc3986 query options on the base URI are not kept during reference resolution for all relevant cases.

  was:
If the only difference between two request is the SchemaVersion Header value, the response is not cachable in all today-browser-implementations (the 'vary' header is not treated correct). 
--> To enable caching of responses we need differentiating URL's. We should use a $SchemaVersion query option. It is superior to adding a segment to the root url, because clients are anyhow familiar with adding query options.
The usage of a $SchemaVersion query option in the relative contextURLs is save; according to rfc3986 query options are kept during reference resolution.


> consider replacing SchemaVersion header with $SchemaVersion query option, or root URL versioning
> ------------------------------------------------------------------------------------------------
>
>                 Key: ODATA-994
>                 URL: https://issues.oasis-open.org/browse/ODATA-994
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: Protocol
>    Affects Versions: V4.01_WD01
>         Environment: Proposed
>            Reporter: Ralf Handl
>            Assignee: Martin Zurmuehl
>             Fix For: V4.01_CSD02
>
>
> In OData-980 we clarified how odata.type is annotated, but this brought up the question as to whether we should be using a SchemaVersion request header or a $SchemaVersion query option to request a particular version of data.  A queryoption (or root url versioning) has the advantage of making the response cacheable, we just need to make sure composition rules are well thought-out (i.e., for using contexturl as base for relative references)



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)