OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

odata message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: [OASIS Issue Tracker] (ODATA-1088) Clarify affect of applying an Annotation to an element

    [ https://issues.oasis-open.org/browse/ODATA-1088?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=66730#comment-66730 ] 

George Ericson commented on ODATA-1088:

--- Following is requested clarification text for Chapter 14 of the CSDL specifications. ---

Metadata annotations are terms applied to schema declarations, such as the CSDL documents, describing or referencing an entity model.  A metadata annotation applies to all instances containing the annotated schema element.  Behaviors or constraints applied by a metadata annotation shall be consistent with the annotated schema element.   
Such annotations define additional behaviors or constraints on the declared 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 supported by an OData service.  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. The result of applying any instance annotation must be a subset of the behaviors and constraints specified by the schema declaration describing the instance, including any metadata annotations.  Instance annotations appear in the actual payload as described in [OData‑JSON].   

---- Following goes in protocol spec ----
If a request containing instance annotations is made to create or update an instance, an OData service must reject the request with HTTP Status code of 400 Bad Request if it is unable to support the behavior or constraints specified by an instance annotation, or if a specified instance annotation is not be consistent with the schema declaration for the instance.

> Clarify affect of applying an Annotation to an element
> ------------------------------------------------------
>                 Key: ODATA-1088
>                 URL: https://issues.oasis-open.org/browse/ODATA-1088
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: CSDL JSON , CSDL XML
>    Affects Versions: V4.01_CSD02
>         Environment: Implementations
>            Reporter: George Ericson
>             Fix For: V4.01_CS02
> 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.

This message was sent by Atlassian JIRA

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]