Adds more API error return code requirements
Adds information about the reason that error codes can be returned by a method. This will help ensure that people consider more of the semantics (especially the error paths) of new API methods. Change-Id: Ia2ff1fd2e689f5c0fad0a84e807de07d150ae9ee
This commit is contained in:
parent
c3214cb8eb
commit
b10341ce3f
@ -86,6 +86,14 @@ Each API method which is either added or changed should have the following
|
||||
* Method type (POST/PUT/GET/DELETE)
|
||||
* Normal http response code(s)
|
||||
* Expected error http response code(s)
|
||||
|
||||
* A description for each possible error code should be included
|
||||
describing semantic errors which can cause it such as
|
||||
inconsistent parameters supplied to the method, or when an
|
||||
instance is not in an appropriate state for the request to
|
||||
succeed. Errors caused by syntactic problems covered by the JSON
|
||||
schema defintion do not need to be included.
|
||||
|
||||
* URL for the resource
|
||||
* Parameters which can be passed via the url
|
||||
* JSON schema definition for the body data if allowed
|
||||
|
Loading…
Reference in New Issue
Block a user