[OASIS Issue Tracker] (ODATA-1140) Add details to HTTPResponseCode term

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

Michael Pizzo created ODATA-1140:
------------------------------------

             Summary: Add details to HTTPResponseCode term
                 Key: ODATA-1140
                 URL: https://issues.oasis-open.org/browse/ODATA-1140
             Project: OASIS Open Data Protocol (OData) TC
          Issue Type: Improvement
          Components: Vocabularies
    Affects Versions: V4.01_CS01
            Reporter: Michael Pizzo
            Priority: Minor
             Fix For: V4.01_CS02


ODATA-884 introduced a way to describe the set of requests and associated valid responses that could be made against a resource.

The response includes an HTTP Status code, and the initial proposal included the ability to specify the set of conditions under which the status code may be returned, including a human-readable string and a machine-readable error/status code.

This detail error code would presumably be something that could be returned in the "details" section of an error response:

~~~json
{
  "error": {
    "code": "501",
    "message": "Unsupported functionality",
    "target": "query",
    "details": [
      {
       "code": "301",
       "target": "$search"  
       "message": "$search query option not supported",
      }
    ]
    "innererror": {
      "trace": [...],
      "context": {...}
    }
  }
}

~~~

This is similar to an effort going on in OpenAPI: https://github.com/OAI/OpenAPI-Specification/issues/1392 
which references: https://datatracker.ietf.org/doc/rfc7807/?include_text=1 Problem Details for HTTP APIs.
 



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