summaryrefslogtreecommitdiffstats
path: root/protocol.txt
diff options
context:
space:
mode:
Diffstat (limited to 'protocol.txt')
-rw-r--r--protocol.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/protocol.txt b/protocol.txt
index 018006a..0d699f3 100644
--- a/protocol.txt
+++ b/protocol.txt
@@ -75,3 +75,22 @@ req: POST /config/<obj_path>/<action>
resp: action-specific JSON
- for time-consuming actions, can return multiple JSON
documents, each containing a status update
+
+
+Use of HTTP status codes:
+
+2xx Success
+
+400 Bad request
+ resp: plain text error message
+
+401 Authentication error
+
+409 Concurrent modification
+ resp: JSON list of objects modified by a concurrent transaction
+
+422 Semantic error
+ resp: JSON object mapping paths to object-specific lists of
+ validation error messages
+
+500 Server error