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

Clarify effect of applying an Annotation to an element

    Details

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

      Applied

    • Proposal:
      Hide

      Chapter 14 of the CSDL specifications

      Metadata annotations are terms applied to model elements. Behaviors or constraints described by a metadata annotation must be consistent with the annotated model element. Such annotations define additional behaviors or constraints on the model element, such as a service, entity type, property, function, action, or parameter. For example, a metadata annotation may define ranges of valid values for a particular property.

      An instance annotation is a term applied to a particular instance within an OData payload as described in [OData‑JSON]. An instance annotation can be used to define additional information associated with a particular result, entity, property, or error. For example, whether a property is read-only for a particular instance.

      Show
      Chapter 14 of the CSDL specifications Metadata annotations are terms applied to model elements. Behaviors or constraints described by a metadata annotation must be consistent with the annotated model element. Such annotations define additional behaviors or constraints on the model element, such as a service, entity type, property, function, action, or parameter. For example, a metadata annotation may define ranges of valid values for a particular property. An instance annotation is a term applied to a particular instance within an OData payload as described in [OData‑JSON] . An instance annotation can be used to define additional information associated with a particular result, entity, property, or error. For example, whether a property is read-only for a particular instance.
    • Resolution:
      Show
      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

      My assumption is that an annotation applied to a schema element will apply to all instances of that schema element.
      There are some examples where groups are proposing to apply annotations to specific schema instances.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              george.ericson George Ericson
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: