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

Add term Core.Example to allow including annotation examples in term definitions

    Details

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

      Proposed

    • Proposal:
      Hide

      Add new term

      <Term Name="Example" Type="Core.ExampleType">
        <Annotation Term="Core.Description" String="A container for annotation examples" />
        <Annotation Term="Core.Example">
          <Record>
            <Annotation Term="Core.Description"
              String="Note that the value of Core.Example is a record/object containing the annotation examples" />
          </Record>
        </Annotation>
      </Term>
      <ComplexType Name="ExampleType">
        <Annotation Term="Core.Description" String="This type intentionally doesn't have properties, so it can only contain annotation examples" />
      </ComplexType>
      
      Show
      Add new term <Term Name= "Example" Type= "Core.ExampleType" > <Annotation Term= "Core.Description" String= "A container for annotation examples" /> <Annotation Term= "Core.Example" > <Record> <Annotation Term= "Core.Description" String= "Note that the value of Core.Example is a record/object containing the annotation examples" /> </Record> </Annotation> </Term> <ComplexType Name= "ExampleType" > <Annotation Term= "Core.Description" String= "This type intentionally doesn't have properties, so it can only contain annotation examples" /> </ComplexType>
    • Resolution:
      Show
      https://github.com/oasis-tcs/odata-vocabularies/pull/16  

      Description

      While discussing ODATA-1099 the idea came up to allow including annotation examples into the term definition, especially useful for structured terms.

      See https://www.oasis-open.org/committees/download.php/61713/odata-meeting-190_on-20171005-minutes.html#6.2.1, META 2.

      As ODATA-1099 is not yet resolved, the term Core.Example is pulled out into this separate issue.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: