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

Add descriptions to system query option restrictions in Capability vocabulary

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: V4.01_CS02
    • Fix Version/s: V4.02_WD01
    • Component/s: Vocabularies
    • Labels:
      None
    • Environment:

      Proposed

    • Proposal:
      Hide

      Allow application of term Core.Description to:

      • BatchSupportType
      • FilterRestrictionsType
      • SortRestrictionsType
      • ExpandRestrictionsType
      • SearchRestrictionsType

      Allow application of term Core.LongDescription to:

      • BatchSupportType

      Document this via Validation.ApplicableTerms.

      Rationale:

      • BatchSupportType describes an operation and thus has both a Description and a LongDescription, similar to InsertRestrictionsType, UpdateRestrictionsType, DeleteRestrictionsType, and ReadRestrictionsBase.
      • The other four types describe query options, similar to type CustomParameter, which also only has a Description, no LongDescription
      Show
      Allow application of term Core.Description to: BatchSupportType FilterRestrictionsType SortRestrictionsType ExpandRestrictionsType SearchRestrictionsType Allow application of term Core.LongDescription to: BatchSupportType Document this via Validation.ApplicableTerms. Rationale: BatchSupportType describes an operation and thus has both a Description and a LongDescription, similar to InsertRestrictionsType, UpdateRestrictionsType, DeleteRestrictionsType, and ReadRestrictionsBase. The other four types describe query options, similar to type CustomParameter, which also only has a Description, no LongDescription
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/67/files  

      Description

      There are cases when a custom description for system query options can help service consumers to better understand the supported functionality. For example, they could be used to explain special constraints stemming from the service model that cannot be expressed otherwise.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              gerald.krause1 Gerald Krause
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: