Browse Source

[docs] Document about form data content type

Romain Rigaux 4 years ago
parent
commit
6bf83972ba
1 changed files with 10 additions and 5 deletions
  1. 10 5
      docs/docs-site/content/developer/api/rest/_index.md

+ 10 - 5
docs/docs-site/content/developer/api/rest/_index.md

@@ -11,7 +11,16 @@ Users authenticate with the same credentials as they would do in the Browser log
 
 
 ## Quickstart
 ## Quickstart
 
 
-The API can be called directly via REST. Some JavaScript and Python wrappers are not documented yet.
+The API can be called directly via REST. Some calls, JavaScript and Python wrappers are not fully documented yet.
+
+Default content type is form data, e.g.:
+
+    -H "Content-Type: application/x-www-form-urlencoded" -d 'username=demo&password=demo'
+
+It is possible to submit data in JSON format:
+
+    -H "Content-Type: application/json" -d '{"username": "demo", "password": "demo"}'
+
 
 
 ### Curl
 ### Curl
 
 
@@ -108,10 +117,6 @@ The API only supports JWT but users need to provide the credentials they are usi
     [21/May/2021 16:26:46 -0700] access       INFO     127.0.0.1 -anon- - "POST /notebook/execute/v1/create_notebook HTTP/1.1" - (mem: 172mb)-- login redirection
     [21/May/2021 16:26:46 -0700] access       INFO     127.0.0.1 -anon- - "POST /notebook/execute/v1/create_notebook HTTP/1.1" - (mem: 172mb)-- login redirection
     [21/May/2021 16:26:46 -0700] access       INFO     127.0.0.1 -anon- - "POST /notebook/execute/v1/create_notebook HTTP/1.1" returned in 4ms 302 0
     [21/May/2021 16:26:46 -0700] access       INFO     127.0.0.1 -anon- - "POST /notebook/execute/v1/create_notebook HTTP/1.1" returned in 4ms 302 0
 
 
-It is possible to submit data in **JSON format**:
-
-    -H "Content-Type: application/json" -d '{"username": "demo", "password": "demo"}'
-
 ### Authenticate
 ### Authenticate
 
 
 Provide login credentials and get a [JWT token](https://jwt.io/):
 Provide login credentials and get a [JWT token](https://jwt.io/):