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-884) Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)

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

Michael Pizzo commented on ODATA-884:

-Swagger returns HTTP status codes; should we align?  Perhaps nest OData error codes under HTTP status codes?
-Could be applied to entityset, singleton, function, or action.
-Consider aligning with new inline messages defined in ODATA-859
-Clarify that this was non-limiting. Intended use is for generating API documentation
-Can specify via qualifier what http methods each set of possible error codes apply to, i.e.:
    <Annotation Term="Core.ErrorCodes" Qualifier="Delete"></Annotation>
    <Annotation Term="Core.ErrorCodes" Qualifier="Create"></Annotation>

> Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)
> -----------------------------------------------------------------------------------------------
>                 Key: ODATA-884
>                 URL: https://issues.oasis-open.org/browse/ODATA-884
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Bug
>          Components: Vocabularies
>    Affects Versions: V4.01_WD01, V4.0_ERRATA02
>         Environment: Annotations
>            Reporter: Ralf Handl
>             Fix For: V4.01_WD01
> Jeff Wight proposes to add a term that allows describing possible code values in OData error responses, see https://lists.oasis-open.org/archives/odata-comment/201510/msg00019.html
> <Annotation Term=”Core.ErrorCodes”>
>   <Record>
>     <PropertyValue Property=”ErrorCode” String=”QueryFilterFunctionNotSupported”/>
>     <PropertyValue Property=”Description” String=”This error indicates that a request was made with a filter function that isn’t supported on this entity set.  Please refer to the Capabilities.FilterFunctions annotation on this entity set for a list of supported functions, and the exact error message for which function usage triggered this error.”/>
>   </Record>
> </Annotation>

This message was sent by Atlassian JIRA

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