[OASIS Issue Tracker] (ODATA-650) Clarify the use of $format in delta links and next links

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

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

Ralf Handl updated ODATA-650:
-----------------------------

    Description: 
The specification clearly forbids clients to compose $format onto a delta or next link, and allows using the Accept header.

It does not forbid servers to encode $format in a delta or next link, which would make it impossible for the client to overrule this encoded format with an Accept header.

During the TC meeting on 04/24/2014, some members suggested concerns of changing the response format when following next links. The server can prevent this format change by encoding the initial format in the next link using $format (regardless of whether the client originally used $format or not).

Format for a delta response should not depend on the original format.  However, if a client explicitly used $format, they may have done so because they couldn't use the Accept header (for whatever reason), in which case they may not be able to change the Accept header when using a delta link, in which case they would expect the delta link to include $format as well.

  was:
Currently the spec does not make any mention of $format in a delta or next link.  Since $format overrides the Accept header, an encoded $format in a delta link or next link means that the response format can not be changed between requests by the client.

During the TC meeting on 04/24/2014, some members suggested concerns of changing the response format when following next links.  The only way to prevent this change would be to encode it in the next link using $format (regardless of whether the client originally used $format or not).

Format for a delta response should not depend on the original format.  However, if a client explicitly used $format, they may have done so because they couldn't use the Accept header (for whatever reason), in which case they may not be able to change the Accept header when using a delta link, in which case they would expect the delta link to include $format as well.


> Clarify the use of $format in delta links and next links
> --------------------------------------------------------
>
>                 Key: ODATA-650
>                 URL: https://tools.oasis-open.org/issues/browse/ODATA-650
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData Protocol 
>    Affects Versions: V4.0_OS
>         Environment: [Proposed]
>            Reporter: Matthew Borges
>            Priority: Minor
>             Fix For: V4.0_ERRATA01
>
>
> The specification clearly forbids clients to compose $format onto a delta or next link, and allows using the Accept header.
> It does not forbid servers to encode $format in a delta or next link, which would make it impossible for the client to overrule this encoded format with an Accept header.
> During the TC meeting on 04/24/2014, some members suggested concerns of changing the response format when following next links. The server can prevent this format change by encoding the initial format in the next link using $format (regardless of whether the client originally used $format or not).
> Format for a delta response should not depend on the original format.  However, if a client explicitly used $format, they may have done so because they couldn't use the Accept header (for whatever reason), in which case they may not be able to change the Accept header when using a delta link, in which case they would expect the delta link to include $format as well.



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