From 256644822a2d3f87a0f98e398c604af8d06e3385 Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Tue, 10 Jul 2018 09:29:50 -0700 Subject: [PATCH 1/2] Document HTTP response codes --- website/source/api/index.html.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/website/source/api/index.html.md b/website/source/api/index.html.md index b58510281..a446262a1 100644 --- a/website/source/api/index.html.md +++ b/website/source/api/index.html.md @@ -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. From 1ffd8138ef0b49ef1c88ac17194b2ff4b12772c1 Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Mon, 16 Jul 2018 14:44:23 -0700 Subject: [PATCH 2/2] clarify 400 --- website/source/api/index.html.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/source/api/index.html.md b/website/source/api/index.html.md index a446262a1..59ffdecb8 100644 --- a/website/source/api/index.html.md +++ b/website/source/api/index.html.md @@ -203,7 +203,8 @@ 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. +* 400 indicates a validation failure and if a parameter is modified in the + request, it could potentially succeed. * 403 marks that the client isn't authenticated for the request. +* 404 indicates an unknown resource. * 5xx means that the client should not expect the request to succeed if retried.