luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

Document HTTP response codes

Browse source
This commit is contained in:
Alex Dadgar 2018-07-10 09:29:50 -07:00
parent 7f9a7fe9a1
commit 256644822a
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
website/source/api/index.html.md
View file

@ -196,3 +196,14 @@ GET /v1/jobs
Even though these share a path, the `PUT` operation creates a new job whereas
the `GET` operation reads all jobs.
## HTTP Response Codes
Individual API's will contain further documentation in the case that more
specific response codes are returned but all clients should handle the following:
* 200 and 204 as success codes.
* 4xx codes indicate that if a parameter was modified in the request, it could
potentially succeed.
* 403 marks that the client isn't authenticated for the request.
* 5xx means that the client should not expect the request to succeed if retried.