Add descriptions to system query option restrictions in Capability vocabulary

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Minor
    • V4.02
    • Affects Version/s: V4.01_CS02
    • Component/s: Vocabularies
    • None
    • 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
    • Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/67/files  

      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.

            Assignee:
            Unassigned
            Reporter:
            gerald.krause1
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: