Uploaded image for project: 'OASIS Open Data Protocol (OData) TC'
  1. OASIS Open Data Protocol (OData) TC
  2. ODATA-1043

Clarify purpose of context URL

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_CSD01
    • Fix Version/s: V4.01_CSD02
    • Component/s: Protocol
    • Labels:
      None
    • Environment:

      Applied

    • Proposal:
      Hide

      State in chapter 10 that one purpose of the context URL is to make responses "self-contained" and allow the client to e.g. construct navigation links for selected navigation properties.

      Otherwise no action, and no relaxation of the context URL patterns.

      Show
      State in chapter 10 that one purpose of the context URL is to make responses "self-contained" and allow the client to e.g. construct navigation links for selected navigation properties. Otherwise no action, and no relaxation of the context URL patterns.
    • Resolution:
      Show
      https://www.oasis-open.org/committees/download.php/60366/odata-v4.01-wd02-part1-protocol-2017-03-24.docx

      Description

      1) Chapter 10 states: The context URL describes the content of the payload. It consists of the canonical metadata document URL and a fragment identifying the relevant portion of the metadata document.

      This is somewhat violated by context urls using the template variable

      {entity}

      whose value is the canonical URL of an entity, including its key values - the key values aren't needed to identify the relevant portion of the metadata document, for this purpose the type is sufficient.

      2) Chapter 10 states: Request payloads generally do not require context URLs as the type of the payload can generally be determined from the request URL.

      Can we have the same for response payloads? Most responses for requests to entity sets or singletons using canonical URLs would not need a context URL, same for navigation paths with a navigation property binding. Instances with a type derived from the declared type carry the @odata.type annotation, so even those don't need a context URL. Same for responses to actions/functions with an EntitySetPath, or action/function imports with a an EntitySet.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              handl Ralf Handl
            • Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: