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

Add UpdateRestrictions property to specify update type

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.01_OS
    • Fix Version/s: V4.01_ERRATA01
    • Component/s: Vocabularies
    • Labels:
      None
    • Environment:

      [Applied]

    • Proposal:
      Hide

      Add a new property to UpdateRestrictionsType to specify whether the service supports PATCH or PUT. If not specified, PATCH Should be supported and PUT May be supported.

      <Property Name="UpdateMethod" Type="Capabilities.HttpMethod" Nullable="true">
        <Annotation Term="Core.Description" String="Supported HTTP Methods (PUT or PATCH) for updating an entity.  If null, PATCH SHOULD be supported and PUT MAY be supported." />
      </Property>
      
      <EnumType Name="HttpMethod" IsFlags="true">
        <Member Name="GET" Value = "1">
          <Annotation Term="Core.Description" String="The HTTP GET Method" />
        </Member>
        <Member Name="PATCH" Value = "2">
          <Annotation Term="Core.Description" String="The HTTP PATCH Method" />
        </Member>
        <Member Name="PUT" Value = "4">
          <Annotation Term="Core.Description" String="The HTTP PUT Method" />
        </Member>
        <Member Name="POST" Value = "8">
          <Annotation Term="Core.Description" String="The HTTP POST Method" />
        </Member>
        <Member Name="DELETE" Value = "16">
          <Annotation Term="Core.Description" String="The HTTP DELETE Method" />
        </Member>
        <Member Name="OPTIONS" Value = "32">
          <Annotation Term="Core.Description" String="The HTTP OPTIONS Method" />
        </Member>
        <Member Name="HEAD" Value = "64">
          <Annotation Term="Core.Description" String="The HTTP OPTIONS Method" />
        </Member>
      </EnumType>
      
      Show
      Add a new property to UpdateRestrictionsType to specify whether the service supports PATCH or PUT. If not specified, PATCH Should be supported and PUT May be supported. <Property Name= "UpdateMethod" Type= "Capabilities.HttpMethod" Nullable= "true" > <Annotation Term= "Core.Description" String= "Supported HTTP Methods (PUT or PATCH) for updating an entity. If null, PATCH SHOULD be supported and PUT MAY be supported." /> </Property> <EnumType Name= "HttpMethod" IsFlags= "true" > <Member Name= "GET" Value = "1" > <Annotation Term= "Core.Description" String= "The HTTP GET Method" /> </Member> <Member Name= "PATCH" Value = "2" > <Annotation Term= "Core.Description" String= "The HTTP PATCH Method" /> </Member> <Member Name= "PUT" Value = "4" > <Annotation Term= "Core.Description" String= "The HTTP PUT Method" /> </Member> <Member Name= "POST" Value = "8" > <Annotation Term= "Core.Description" String= "The HTTP POST Method" /> </Member> <Member Name= "DELETE" Value = "16" > <Annotation Term= "Core.Description" String= "The HTTP DELETE Method" /> </Member> <Member Name= "OPTIONS" Value = "32" > <Annotation Term= "Core.Description" String= "The HTTP OPTIONS Method" /> </Member> <Member Name= "HEAD" Value = "64" > <Annotation Term= "Core.Description" String= "The HTTP OPTIONS Method" /> </Member> </EnumType>
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/105

      Description

      Clients can determine updatability by looking at the "UpdateRestrictions" capability annotation. however, this annotation does not distinguish between PATCH and PUT.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: