feat(doc): basic server REST API

jolibrain · Jun 21, 2023 · a757d17 · a757d17
1 parent bc4c132
commit a757d17
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/docs/source/API.rst b/docs/source/API.rst
@@ -0,0 +1,33 @@
+.. _api:
+
+########################
+ JoliGEN server REST API
+########################
+
+*********
+Training
+*********
+
+Creates a training process with name `name`
+
+- *Method* `POST`
+- *URL* `/train/:name`
+- *URL Params*
+    - `name:string`: name of training process 
+- *Response*
+    - *Success:*:
+        - Code: 201
+        - Content: `{ "message": "ok", "name": "train_1" }`
+
+- Get all training processes
+
+`GET /train`
+
+- Get training status
+
+`GET /train/name`
+
+- Stop training process
+
+`DELETE /train/name`
+