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

Add way to specify which batch formats (if any) are supported by a service

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: V4.0_CSD04
    • Component/s: Vocabularies
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Add a SupportedFormats property to the BatchSupportType:

      <Property Name="SupportedFormats" Type="Collection(Edm.String)" Nullable="false">
        <Annotation Term="Core.Description" String="Media types of supported formats for $batch" />
        <Annotation Term="Core.IsMediaType" />
        <Annotation Term="Validation.AllowedValues">
          <Collection>
            <Record>
              <PropertyValue Property="Value" String="multipart/mixed" />
              <Annotation Term="Core.Description"
                String="Multipart Batch Format, see http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_MultipartBatchFormat" />
            </Record>
            <Record>
              <PropertyValue Property="Value" String="application/json" />
              <Annotation Term="Core.Description"
                String="JSON Batch Format, see http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_BatchRequestsandResponses" />
            </Record>
          </Collection>
        </Annotation>
      </Property>
      
      Show
      Add a SupportedFormats property to the BatchSupportType: <Property Name= "SupportedFormats" Type= "Collection(Edm.String)" Nullable= "false" > <Annotation Term= "Core.Description" String= "Media types of supported formats for $batch" /> <Annotation Term= "Core.IsMediaType" /> <Annotation Term= "Validation.AllowedValues" > <Collection> <Record> <PropertyValue Property= "Value" String= "multipart/mixed" /> <Annotation Term= "Core.Description" String= "Multipart Batch Format, see http://docs.oasis-open.org/odata/odata/v4.01/cs01/part1-protocol/odata-v4.01-cs01-part1-protocol.html#sec_MultipartBatchFormat" /> </Record> <Record> <PropertyValue Property= "Value" String= "application/json" /> <Annotation Term= "Core.Description" String= "JSON Batch Format, see http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_BatchRequestsandResponses" /> </Record> </Collection> </Annotation> </Property>
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/17

      Description

      We have annotation terms to specify supported data types and metadata types, but we don't have an annotation term to specify supported batch formats.

      This is particularly important for batch because the client can't just specify an accept header for all formats that it supports, it needs to know what format to send the batch request.

      We could support this by defining a top-level SupportedBatchFormats, along alongside SupportedFormats and SupportedMetadataFormats, or we could put this on our BatchSupportType

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: