[OASIS Issue Tracker] (ODATA-859) Define term, semantics for inserting error information into a (mostly) successful response

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

     [ https://issues.oasis-open.org/browse/ODATA-859?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Hubert Heijkers updated ODATA-859:
----------------------------------

    Proposal: 
Add a term to the Core vocabulary that is shaped similar to the standard OData error response:

      <Term Name="Notifications" Type="Collection(Core.NotificationType)"> 
        <Annotation Term="Core.Description" String="Instance annotation for warning and info notifications" /> 
      </Term> 
      <ComplexType Name="NotificationType"> 
        <Property Name="code" Type="Edm.String" Nullable="false" /> 
        <Property Name="message" Type="Edm.String" Nullable="false"> 
          <Annotation Term="Core.IsLanguageDependent" /> 
        </Property> 
        <Property Name="severity" Type="Core.NotificationSeverity" Nullable="false" /> 
        <Property Name="target" Type="Edm.String" Nullable="true"> 
          <Annotation Term="Core.Description" 
            String="A path to the target of the notification detail, relative to the annotated instance" /> 
        </Property> 
        <Property Name="details" Type="Collection(Common.NotificationType)" Nullable="false" /> 
      </ComplexType> 
      <TypeDefinition Name="NotificationSeverity" UnderlyingType="Edm.String"> 
        <Annotation Term="Validation.AllowedValues"> 
          <Record> 
            <PropertyValue Property="Values"> 
              <Collection> 
                <Record> 
                  <PropertyValue Property="Value" String="success" /> 
                </Record> 
                <Record> 
                  <PropertyValue Property="Value" String="info" /> 
                </Record> 
                <Record> 
                  <PropertyValue Property="Value" String="warning" /> 
                </Record> 
                <Record> 
                  <PropertyValue Property="Value" String="error" /> 
                </Record> 
              </Collection> 
            </PropertyValue> 
          </Record> 
        </Annotation> 
      </TypeDefinition> 

Notification details may target properties of the annotated structured type instance, related instances, or their properties

  was:
Add a term to the Core vocabulary that is shaped similar to the standard OData error response:

      <Term Name="Notification" Type="Core.NotificationType">
        <Annotation Term="Core.Description" String="Instance annotation for warning and info notifications" />
      </Term>
      <ComplexType Name="NotificationType">
        <Property Name="code" Type="Edm.String" Nullable="false" />
        <Property Name="message" Type="Edm.String" Nullable="false">
          <Annotation Term="Core.IsLanguageDependent" />
        </Property>
        <Property Name="severity" Type="Core.NotificationSeverity" Nullable="false" />
        <Property Name="details" Type="Collection(Common.NotificationDetailType)" Nullable="false" />
      </ComplexType>
      <ComplexType Name="NotificationDetailType">
        <Property Name="code" Type="Edm.String" Nullable="false" />
        <Property Name="message" Type="Edm.String" Nullable="false">
          <Annotation Term="Core.IsLanguageDependent" />
        </Property>
        <Property Name="severity" Type="Core.NotificationSeverity" Nullable="false" />
        <Property Name="target" Type="Edm.String" Nullable="true">
          <Annotation Term="Core.Description"
            String="A path to the target of the notification detail, relative to the annotated instance" />
        </Property>
      </ComplexType>
      <TypeDefinition Name="NotificationSeverity" UnderlyingType="Edm.String">
        <Annotation Term="Validation.AllowedValues">
            <Collection>
                <Record>
                  <PropertyValue Property="Value" String="success" />
                </Record>
                <Record>
                  <PropertyValue Property="Value" String="info" />
                </Record>
                <Record>
                  <PropertyValue Property="Value" String="warning" />
                </Record>
                <Record>
                  <PropertyValue Property="Value" String="error" />
                </Record>
            </Collection>
        </Annotation>
      </TypeDefinition>

Notification details may target properties of the annotated structured type instance, related instances, or their properties


> Define term, semantics for inserting error information into a (mostly) successful response
> ------------------------------------------------------------------------------------------
>
>                 Key: ODATA-859
>                 URL: https://issues.oasis-open.org/browse/ODATA-859
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: OData JSON Format
>    Affects Versions: V4.0_ERRATA02
>         Environment: Annotations
>            Reporter: Michael Pizzo
>             Fix For: V4.01_WD01
>
>
> If a response returns successfully but there is an error within the payload, would we have some way to annotated the payload with an error?



--
This message was sent by Atlassian JIRA
(v6.2.2#6258)