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

Annotate constructor/factory actions

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Applied
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: V4.02
    • Component/s: Protocol, Vocabularies
    • Labels:
      None
    • Proposal:
      Hide

      Add tagging term Core.Constructor

      <Term Name="Constructor" Type="Core.Tag" Nullable="false" DefaultValue="true" AppliesTo="Action">
  <Annotation Term="Core.Description" String="The annotated action constructs new entities" />
</Term>
      Show
      Add tagging term Core.Constructor <Term Name= "Constructor" Type= "Core.Tag" Nullable= "false" DefaultValue= "true" AppliesTo= "Action" > <Annotation Term= "Core.Description" String= "The annotated action constructs new entities" /> </Term>
    • Resolution:
      Hide

      https://github.com/oasis-tcs/odata-vocabularies/pull/237

      https://github.com/oasis-tcs/odata-specs/pull/247 

      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/237 https://github.com/oasis-tcs/odata-specs/pull/247  

      Description

      In 11.5.4.1 Invoking an Action we define that

      Actions that create and return a single entity follow the rules for entity creation and return a Location header that contains the edit URL or read URL of the created entity.

      Currently there's no way for clients and generic tools to recognize such "constructor" or "factory" actions. Annotating these actions would be helpful for e.g. OpenAPI generation from $metadata.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: