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

Clarify that nested next links can appear on the same page as a delta link

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: V4.01_OS
    • Component/s: JSON Format, Protocol
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Clarify that each page of results within a response can have either a nextlink or a deltalink but not both. Probably best to avoid the use of the word "page" as it is ambiguous. Maybe something like "The delta payload, and each nested collection within the delta payload, may be paged. The delta link appears on the last page of each collection in place of the nextlink."

      Also clarify that following nested next links within a delta payload typically doesn't result in a delta at the end-the delta is tracked by the top level response. Clients MAY request the delta link when requesting the nested content and, since it's a preference, the service MAY ignore it.

      This should be a non-normative clarification.

      Show
      Clarify that each page of results within a response can have either a nextlink or a deltalink but not both. Probably best to avoid the use of the word "page" as it is ambiguous. Maybe something like "The delta payload, and each nested collection within the delta payload, may be paged. The delta link appears on the last page of each collection in place of the nextlink." Also clarify that following nested next links within a delta payload typically doesn't result in a delta at the end-the delta is tracked by the top level response. Clients MAY request the delta link when requesting the nested content and, since it's a preference, the service MAY ignore it. This should be a non-normative clarification.
    • Resolution:
      Show
      https://www.oasis-open.org/committees/download.php/66374/odata-v4.01-wd09-part1-protocol-2019-12-09a.docx https://www.oasis-open.org/committees/download.php/66488/odata-json-format-v4.01-wd09-2020-01-15.docx  

      Description

      In the protocol document we specify that a delta link can only appear on the last page of a result set indicating that a top level next link and delta link cannot be returned on the same page.  However, we don't say anything about nested next links.

      We should clarify that nested next links are allowed on all pages but a delta link should only be returned for the top level query.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              matt.borges Matthew Borges
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: