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

CRUDQ descriptions on entity sets

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: OpenAPI, Vocabularies
    • Labels:
    • Environment:

      Proposed

    • Proposal:
      Hide

      Add new properties to the Capabilities terms InsertRestrictions, UpdateRestrictions, DeleteRestrictions, ReadRestrictions, and ReadByKeyRestrictions:

      • Description of type string
      • LongDescription of type string

      Note: this automatically extends NavigationPropertyRestriction with descriptions for Insert, Update, and Delete.

       

      Show
      Add new properties to the Capabilities terms  InsertRestrictions , UpdateRestrictions , DeleteRestrictions , ReadRestrictions , and ReadByKeyRestrictions : Description of type string LongDescription of type string Note: this automatically extends NavigationPropertyRestriction with descriptions for Insert, Update, and Delete.  
    • Resolution:
      Hide

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

       

      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/40/files  

      Description

      In public comment https://lists.oasis-open.org/archives/odata-comment/201510/msg00005.html the question was asked on how to provide descriptions specific to one of the standard operations on an entity set:

      • Create new
      • Query list
      • Read single
      • Update existing
      • Delete existing

      This could be leveraged when generating OpenAPI descriptions for OData services, where each entity set results in up to two path items (for the list, for key access) with up to five operations.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: