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

include-annotations should allow inclusion (or exclusion) of specific terms

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_WD01
    • Fix Version/s: V4.0_WD01
    • Component/s: Protocol
    • Labels:
      None
    • Environment:

      [Applied]

      Description

      The odata.include-annotations preference allows the client to specify which annotations are included in the response payload.

      We include annotations by specifying the namespace of the annotation, but there may be cases where only one (or a few number) of the annotations within a (potentially large) namespace are desired.

      We should support specifying individual annotations using namespace.termname.

      Note that we currently say that, if you just specify a namespace, you include only the terms located directly in that namespace, while if you specify namespace.* you include all annotations within that namespace and nested namespaces. We may introduce an ambiguity if we allow namespace.termname where the service needs to know the difference between a namespace name and a term name in order to differentiate. If this is an issue we can:
      1) just use namespace.* for everything within a namespace (recursively) and not differentiate between direct and nested, or
      2) disambiguate by the case where I want everything directly contained by a namespace (i.e., myroot/mynamespace/.)
      3) disambiguate the case where I want a term (i.e., namespace@termname)

        Attachments

          Activity

            People

            • Assignee:
              mikep Michael Pizzo
              Reporter:
              mikep Michael Pizzo
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: