From 0f49023061c8c60a609ebf96871b925c90235c08 Mon Sep 17 00:00:00 2001
From: Rigel Kent <sendmemail@rigelk.eu>
Date: Wed, 21 Nov 2018 01:02:47 +0100
Subject: make POST /users have integer role enum

---
 support/doc/api/openapi.yaml  |  7 ++++++-
 support/doc/api/quickstart.md | 12 ++++++------
 2 files changed, 12 insertions(+), 7 deletions(-)

(limited to 'support')

diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index aa6be7e87..f0c0b46b1 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1741,7 +1741,12 @@ components:
           type: string
           description: 'The user videoQuota '
         role:
-          type: string
+          type: integer
+          format: int32
+          enum:
+            - 0
+            - 1
+            - 2
           description: 'The user role '
       required:
         - username
diff --git a/support/doc/api/quickstart.md b/support/doc/api/quickstart.md
index 6c19b59ee..00874a1c9 100644
--- a/support/doc/api/quickstart.md
+++ b/support/doc/api/quickstart.md
@@ -6,13 +6,13 @@
 
 Some endpoints need authentication. We use OAuth 2.0 so first fetch the client tokens:
 
-```
+```bash
 $ curl https://peertube.example.com/api/v1/oauth-clients/local
 ```
 
 Response example:
 
-```
+```json
 {
   "client_id": "v1ikx5hnfop4mdpnci8nsqh93c45rldf",
   "client_secret": "AjWiOapPltI6EnsWQwlFarRtLh4u8tDt"
@@ -23,7 +23,7 @@ Response example:
 
 Now you can fetch the user token:
 
-```
+```bash
 $ curl -X POST \
  -d "client_id=v1ikx5hnfop4mdpnci8nsqh93c45rldf&client_secret=AjWiOapPltI6EnsWQwlFarRtLh4u8tDt&grant_type=password&response_type=code&username=your_user&password=your_password" \
   https://peertube.example.com/api/v1/users/token
@@ -31,7 +31,7 @@ $ curl -X POST \
 
 Response example:
 
-```
+```json
 {
   "access_token": "90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0",
   "token_type": "Bearer",
@@ -42,13 +42,13 @@ Response example:
 
 Just use the `access_token` in the `Authorization` header:
 
-```
+```bash
 $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https://peertube.example.com/api/v1/jobs/completed
 ```
 
 
 ### List videos
 
-```
+```bash
 $ curl https://peertube.example.com/api/v1/videos
 ```
-- 
cgit v1.2.3