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

Define term, semantics for inserting error information into a (mostly) successful response

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: V4.0_ERRATA02
    • Fix Version/s: V4.01_WD01
    • Component/s: JSON Format
    • Labels:
      None
    • Environment:

      Annotations

    • Proposal:
      Hide

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

      <Term Name="Messages" Type="Collection(Core.MessageType)">
      <Annotation Term="Core.Description" String="Instance annotation for warning and info messages" />
      </Term>
      <ComplexType Name="MessageType">
      <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.MessageSeverity" Nullable="false" />
      <Property Name="target" Type="Edm.String" Nullable="true">
      <Annotation Term="Core.Description"
      String="A path to the target of the message detail, relative to the annotated instance" />
      </Property>
      <Property Name="details" Type="Collection(Core.MessageType)" Nullable="false" />
      </ComplexType>
      <TypeDefinition Name="MessageSeverity" 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

      Show
      Add a term to the Core vocabulary that is shaped similar to the standard OData error response: <Term Name="Messages" Type="Collection(Core.MessageType)"> <Annotation Term="Core.Description" String="Instance annotation for warning and info messages" /> </Term> <ComplexType Name="MessageType"> <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.MessageSeverity" Nullable="false" /> <Property Name="target" Type="Edm.String" Nullable="true"> <Annotation Term="Core.Description" String="A path to the target of the message detail, relative to the annotated instance" /> </Property> <Property Name="details" Type="Collection(Core.MessageType)" Nullable="false" /> </ComplexType> <TypeDefinition Name="MessageSeverity" 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
    • Resolution:
      Show
      https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/4.01%20spec/vocabularies/Org.OData.Core.V1.xml

      Description

      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?

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              mikep Michael Pizzo
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: