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

Replace multiple batch capability term with single "BatchSupport" term

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_WD01, V4.0_ERRATA03
    • Fix Version/s: V4.01_WD01
    • Component/s: CSDL XML
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Remove before publishing the following capability term:
      -BatchContentIdReferencingInRequestBodiesSupported

      Deprecate the following capabilities terms:
      -BatchSupported
      -BatchContinueOnErrorSupported

      Define a new "BatchSupport" term in the capabilities vocabulary for putting these and other capabilities related to batch:

      <Term Name="BatchSupport" Type="Capabilities.BatchSupportType" AppliesTo="EntityContainer">
      <Annotation Term="Core.Description" String="Batch Support for the service"/>
      </Term>

      <ComplexType Name="BatchSupportType">
      <Property Name="Supported" Type="Edm.Boolean" DefaultValue="true">
      <Annotation Term="Core.Description" String="Service supports requests to $batch" />
      </Property>
      <Property Name="ContinueOnErrorSupported" Type="Edm.Boolean">
      <Annotation Term="Core.Description" String="Service supports the continue on error preference" />
      </Property>
      <Property Name="ReferencesInRequestBodiesSupported" Type="Edm.Boolean">
      <Annotation Term="Core.Description" String="Service supports Content-ID referencing in request bodies" />
      </Property>
      <Property Name="ReferencesAcrossChangeSetsSupported" Type="Edm.Boolean">
      <Annotation Term="Core.Description" String="Service supports Content-ID referencing across change sets" />
      </Property>
      <Property Name="EtagReferencesSupported" Type="Edm.Boolean">
      <Annotation Term="Core.Description" String="Service supports referencing Etags from previous requests" />
      </Property>
      </ComplexType>

      Show
      Remove before publishing the following capability term: -BatchContentIdReferencingInRequestBodiesSupported Deprecate the following capabilities terms: -BatchSupported -BatchContinueOnErrorSupported Define a new "BatchSupport" term in the capabilities vocabulary for putting these and other capabilities related to batch: <Term Name="BatchSupport" Type="Capabilities.BatchSupportType" AppliesTo="EntityContainer"> <Annotation Term="Core.Description" String="Batch Support for the service"/> </Term> <ComplexType Name="BatchSupportType"> <Property Name="Supported" Type="Edm.Boolean" DefaultValue="true"> <Annotation Term="Core.Description" String="Service supports requests to $batch" /> </Property> <Property Name="ContinueOnErrorSupported" Type="Edm.Boolean"> <Annotation Term="Core.Description" String="Service supports the continue on error preference" /> </Property> <Property Name="ReferencesInRequestBodiesSupported" Type="Edm.Boolean"> <Annotation Term="Core.Description" String="Service supports Content-ID referencing in request bodies" /> </Property> <Property Name="ReferencesAcrossChangeSetsSupported" Type="Edm.Boolean"> <Annotation Term="Core.Description" String="Service supports Content-ID referencing across change sets" /> </Property> <Property Name="EtagReferencesSupported" Type="Edm.Boolean"> <Annotation Term="Core.Description" String="Service supports referencing Etags from previous requests" /> </Property> </ComplexType>
    • Resolution:
      Show
      https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/4.01%20spec/vocabularies/Org.OData.Capabilities.V1.xml https://www.oasis-open.org/apps/org/workgroup/odata/download.php/59028/odata-v4.01-wd01-part1-protocol.docx

      Description

      In the current published vocabulary we have two different capabilities terms related to batch (Supported and ContinueOnErrorSupported). We at least three more already lined up for 4.01:
      "BatchContentIdReferencingInRequestBodiesSupported" (ODATA-479),
      "ContentIdReferencingAcrossChangeSetsSupported" (ODATA-480), and
      "EtagReferencingSupported" (OData-541)

      In most cases (filter, expand, etc.) we have grouped related terms together under a single capability. I would suggest we do the same for $batch.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mikep Michael Pizzo
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: