Skip to content

Commit 1f9914c

Browse files
committed
Merge pull request #4092 from Joshua-Anderson/perms-doc-fix
docs(reference): fix mistakes in perms section of api docs
2 parents f6d39c0 + 1613662 commit 1f9914c

1 file changed

Lines changed: 69 additions & 2 deletions

File tree

docs/reference/api-v1.5.rst

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1248,6 +1248,10 @@ Permissions
12481248
List Application Permissions
12491249
````````````````````````````
12501250

1251+
.. note::
1252+
1253+
This does not include the app owner.
1254+
12511255
Example Request:
12521256

12531257
.. code-block:: console
@@ -1266,7 +1270,10 @@ Example Response:
12661270
Content-Type: application/json
12671271
12681272
{
1269-
"users": []
1273+
"users": [
1274+
"test",
1275+
"foo"
1276+
]
12701277
}
12711278
12721279
@@ -1299,7 +1306,7 @@ Example Request:
12991306

13001307
.. code-block:: console
13011308
1302-
POST /v1/apps/example-go/perms/example HTTP/1.1
1309+
DELETE /v1/apps/example-go/perms/example HTTP/1.1
13031310
Host: deis.example.com
13041311
Authorization: token abc123
13051312
@@ -1311,6 +1318,43 @@ Example Response:
13111318
DEIS_API_VERSION: 1.5
13121319
DEIS_PLATFORM_VERSION: 1.8.0
13131320
1321+
List Administrators
1322+
```````````````````
1323+
1324+
Example Request:
1325+
1326+
.. code-block:: console
1327+
1328+
GET /v1/admin/perms/ HTTP/1.1
1329+
Host: deis.example.com
1330+
Authorization: token abc123
1331+
1332+
Example Response:
1333+
1334+
.. code-block:: console
1335+
1336+
HTTP/1.1 200 OK
1337+
DEIS_API_VERSION: 1.5
1338+
DEIS_PLATFORM_VERSION: 1.8.0
1339+
Content-Type: application/json
1340+
1341+
{
1342+
"count": 2,
1343+
"next": null
1344+
"previous": null,
1345+
"results": [
1346+
{
1347+
"username": "test",
1348+
"is_superuser": true
1349+
},
1350+
{
1351+
"username": "foo",
1352+
"is_superuser": true
1353+
}
1354+
]
1355+
}
1356+
1357+
13141358
Grant User Administrative Privileges
13151359
````````````````````````````````````
13161360

@@ -1336,6 +1380,29 @@ Example Response:
13361380
DEIS_API_VERSION: 1.5
13371381
DEIS_PLATFORM_VERSION: 1.8.0
13381382
1383+
Remove User's Administrative Privileges
1384+
```````````````````````````````````````
1385+
1386+
.. note::
1387+
1388+
This command requires administrative privileges
1389+
1390+
Example Request:
1391+
1392+
.. code-block:: console
1393+
1394+
DELETE /v1/admin/perms/example HTTP/1.1
1395+
Host: deis.example.com
1396+
Authorization: token abc123
1397+
1398+
Example Response:
1399+
1400+
.. code-block:: console
1401+
1402+
HTTP/1.1 204 NO CONTENT
1403+
DEIS_API_VERSION: 1.5
1404+
DEIS_PLATFORM_VERSION: 1.8.0
1405+
13391406
Users
13401407
-----
13411408

0 commit comments

Comments
 (0)