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

Add annotations to describe custom query options and custom headers

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_CSD01
    • Fix Version/s: V4.0_CSD02
    • Component/s: Vocabularies
    • Labels:
    • Environment:

      Proposed

    • Proposal:
      Hide

      See https://github.com/oasis-tcs/odata-vocabularies/blob/ODATA-1099/vocabularies/Org.OData.Capabilities.V1.md#CustomHeaders

      2018-1-0: Proposal amended by unanimous consent to restrict the "AppliesTo" to "EntityContainer". This allows us to specify global (service-wide) query options or headers. Resource-specific header and query option requirements can be applied through the HttpRequests annotation term defined in ODATA-884. Update the applied change to restrict to "EntityContainer" and update description to specify that they are applied to service.

       

      2019-2-14: Ammend proposal to change "RetrieveRestrictions" to "ReadRestrictions"

      Show
      See https://github.com/oasis-tcs/odata-vocabularies/blob/ODATA-1099/vocabularies/Org.OData.Capabilities.V1.md#CustomHeaders 2018-1-0: Proposal amended by unanimous consent to restrict the "AppliesTo" to "EntityContainer". This allows us to specify global (service-wide) query options or headers. Resource-specific header and query option requirements can be applied through the HttpRequests annotation term defined in ODATA-884 . Update the applied change to restrict to "EntityContainer" and update description to specify that they are applied to service.   2019-2-14: Ammend proposal to change "RetrieveRestrictions" to "ReadRestrictions"
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/6

      Description

      Some services support custom query options, either across the board, or for specific resources or resource types.

      Other services support or even require custom headers, e.g. for CSRF protection.

      We need a way to express in metadata which custom query options and custom headers are available / required where.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: