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

Allow to create annotations in CSDL with a less verbose format to increase adoption

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: New
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: V4.01_OS
    • Fix Version/s: V4.02
    • Component/s: CSDL XML
    • Labels:
      None
    • Proposal:
      Hide

      Allow embedding CSDL JSON annotation values according to 14 Vocabulary and Annotation as CData in CSDL XML

      <Annotation Term="Org.OData.Core.V1.Revisions">
  <![CDATA[
    [
      {
        "Version": "2023-03/PrivatePreview:analytics",
        "Kind": "Deprecated",
        "Description": "Private preview for Analytics APIs"
      }
    ]
  ]]>
</Annotation>

       

      Show
      Allow embedding CSDL JSON annotation values according to 14 Vocabulary and Annotation as CData in CSDL XML <Annotation Term= "Org.OData.Core.V1.Revisions" >   <![CDATA[     [       {         "Version" : "2023-03/PrivatePreview:analytics" ,         "Kind" : "Deprecated" ,         "Description" : "Private preview for Analytics APIs"       }     ]   ]]> </Annotation>  

      Description

      CSDL XML annotations can be quite verbose. E.g. 

      <Annotation Term="Org.OData.Core.V1.Revisions">
  <Collection>
    <Record>
      <PropertyValue Property="Version" String="2023-03/PrivatePreview:analytics" />
      <PropertyValue Property="Kind" EnumMember="Org.OData.Core.V1.RevisionKind/Deprecated" />
      <PropertyValue Property="Description" String="Private preview for Analytics APIs" />
    </Record>
  </Collection>
</Annotation>

      But Annotation can also be expressed in a much cleaner, more readable and less verbose form in CSDL JSON.

        Attachments

          Activity

            People

            • Assignee:
              chrispre Christof Sprenger
              Reporter:
              chrispre Christof Sprenger
            • Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated: