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

Validation term for allowed terms in Annotation Paths

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.01_CS01
    • Fix Version/s: V4.01_CS02
    • Component/s: CSDL JSON, CSDL XML, Vocabularies
    • Labels:
      None
    • Environment:

      Applied

    • Proposal:
      Hide

      Mention term Validation.AllowedTerms in CSDL sections 14.4.1.3 Annotation Path.

      Add to Validation vocabulary:

      <Term Name="AllowedTerms" Type="Collection(Core.QualifiedTermName)" AppliesTo="Term Property">
  <Annotation Term="Core.Description"
    String="Annotate a property or term of type AnnotationPath to restrict the terms that can be targeted by the path." />
  <Annotation Term="Core.LongDescription"
    String="Annotation path expressions assigned to the annotated term or property are intended to resolve to annotations with one of the listed terms. For forward compatibility, clients should be prepared for the annotation to reference terms besides those listed." />
  <Annotation Term="Core.RequiresType" String="Edm.AnnotationPath" />
</Term>

      Add to Core vocabulary:

      <TypeDefinition Name="QualifiedTermName" UnderlyingType="Edm.String">
  <Annotation Term="Core.Description" String="The qualified name of a term in scope." />
</TypeDefinition>
      Show
      Mention term Validation.AllowedTerms in CSDL sections 14.4.1.3 Annotation Path. Add to Validation vocabulary: <Term Name= "AllowedTerms" Type= "Collection(Core.QualifiedTermName)" AppliesTo= "Term Property" > <Annotation Term= "Core.Description" String= "Annotate a property or term of type AnnotationPath to restrict the terms that can be targeted by the path." /> <Annotation Term= "Core.LongDescription" String= "Annotation path expressions assigned to the annotated term or property are intended to resolve to annotations with one of the listed terms. For forward compatibility, clients should be prepared for the annotation to reference terms besides those listed." /> <Annotation Term= "Core.RequiresType" String= "Edm.AnnotationPath" /> </Term> Add to Core vocabulary: <TypeDefinition Name= "QualifiedTermName" UnderlyingType= "Edm.String" > <Annotation Term= "Core.Description" String= "The qualified name of a term in scope." /> </TypeDefinition>
    • Resolution:
      Hide

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

      https://www.oasis-open.org/committees/download.php/64129/odata-csdl-json-v4.01-wd05-2018-10-22.docx 

      https://www.oasis-open.org/committees/download.php/64130/odata-csdl-xml-v4.01-wd06-2018-10-22.docx 

      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/18 https://www.oasis-open.org/committees/download.php/64129/odata-csdl-json-v4.01-wd05-2018-10-22.docx   https://www.oasis-open.org/committees/download.php/64130/odata-csdl-xml-v4.01-wd06-2018-10-22.docx  

      Description

      Annotation paths allow referencing annotations.

      Often the referenced annotation has to have one of certain "allowed" terms that can be interpreted in that context.

      Currently these "allowed terms" cannot be expressed in the term or property definition.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: