You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/assets/attachments/rest-api-admin.yaml
+18-8Lines changed: 18 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -289,7 +289,7 @@ paths:
289
289
operationId: 'db_config_create'
290
290
summary: Create a Sync Gateway Database
291
291
tags:
292
-
- 'Database Configuration'
292
+
- 'Database Management'
293
293
description: |+
294
294
Use this method to create a new Sync Gateway database.
295
295
@@ -1452,7 +1452,7 @@ paths:
1452
1452
responses:
1453
1453
200:
1454
1454
description: Success and returns the revtree as plain text.
1455
-
/_role:
1455
+
/{db}/_role:
1456
1456
get:
1457
1457
tags:
1458
1458
- 'Database Security'
@@ -1475,6 +1475,7 @@ paths:
1475
1475
summary: Role
1476
1476
description: This request creates a new role
1477
1477
parameters:
1478
+
- $ref: '#/parameters/db'
1478
1479
- $ref: '#/parameters/role'
1479
1480
responses:
1480
1481
201:
@@ -1483,13 +1484,14 @@ paths:
1483
1484
$ref: '#/responses/Unauthorized'
1484
1485
409:
1485
1486
$ref: '#/responses/Conflict'
1486
-
/_role/{name}:
1487
+
/{db}/_role/{name}:
1487
1488
get:
1488
1489
tags:
1489
1490
- 'Database Security'
1490
1491
summary: Get role
1491
1492
description: Request a specific role by name.
1492
1493
parameters:
1494
+
- $ref: '#/parameters/db'
1493
1495
- $ref: '#/parameters/role_name'
1494
1496
responses:
1495
1497
200:
@@ -1522,6 +1524,7 @@ paths:
1522
1524
description: |+
1523
1525
Use this convenience endpoint to upsert a Sync Gateway role
1524
1526
parameters:
1527
+
- $ref: '#/parameters/db'
1525
1528
- $ref: '#/parameters/role_name'
1526
1529
- $ref: '#/parameters/role_body_upsert'
1527
1530
responses:
@@ -1537,6 +1540,7 @@ paths:
1537
1540
summary: Deletes the role
1538
1541
description: This request deletes the role with the specified name
1539
1542
parameters:
1543
+
- $ref: '#/parameters/db'
1540
1544
- $ref: '#/parameters/role_name'
1541
1545
responses:
1542
1546
200:
@@ -1643,12 +1647,14 @@ paths:
1643
1647
responses:
1644
1648
200:
1645
1649
description: User session deleted.
1646
-
/_user/:
1650
+
/{db}/_user/:
1647
1651
get:
1648
1652
tags:
1649
1653
- 'Database Security'
1650
1654
summary: Retrieves all users
1651
1655
description: This request returns all users
1656
+
parameters:
1657
+
- $ref: '#/parameters/db'
1652
1658
responses:
1653
1659
200:
1654
1660
description: The message body contains the list of users in a JSON array. Each element of the array is a string representing the name of a user in the specified database.
@@ -1665,6 +1671,7 @@ paths:
1665
1671
summary: Create a new user
1666
1672
description: This request creates a new user
1667
1673
parameters:
1674
+
- $ref: '#/parameters/db'
1668
1675
- $ref: '#/parameters/user'
1669
1676
responses:
1670
1677
@@ -1674,13 +1681,14 @@ paths:
1674
1681
$ref: '#/responses/Unauthorized'
1675
1682
409:
1676
1683
$ref: '#/responses/Conflict'
1677
-
/_user/{name}:
1684
+
/{db}/_user/{name}:
1678
1685
get:
1679
1686
tags:
1680
1687
- 'Database Security'
1681
1688
summary: Retrieve a User
1682
1689
description: This request returns information about the specified user.
1683
1690
parameters:
1691
+
- $ref: '#/parameters/db'
1684
1692
- $ref: '#/parameters/name'
1685
1693
1686
1694
responses:
@@ -1699,6 +1707,7 @@ paths:
1699
1707
description: |+
1700
1708
Use this method to create or update a user
1701
1709
parameters:
1710
+
- $ref: '#/parameters/db'
1702
1711
- $ref: '#/parameters/name'
1703
1712
- $ref: '#/parameters/user_body_upsert'
1704
1713
responses:
@@ -1715,6 +1724,7 @@ paths:
1715
1724
summary: Delete a User
1716
1725
description: This request deletes the user with the specified name
1717
1726
parameters:
1727
+
- $ref: '#/parameters/db'
1718
1728
- $ref: '#/parameters/name'
1719
1729
responses:
1720
1730
200:
@@ -6427,11 +6437,11 @@ tags:
6427
6437
description: Returns bootstrap settings and updates logging options
6428
6438
6429
6439
- name: 'Database Configuration'
6430
-
description: Create and configure sync gateway databases
6440
+
description: Configure sync gateway databases
6431
6441
- name: 'Database Management'
6432
-
description: Manage sync gateway databases
6442
+
description: Create and manage sync gateway databases
6433
6443
- name: 'Database Security'
6434
-
description: Create and manage users and roles
6444
+
description: Create and manage database users and roles
6435
6445
- name: 'Access Control'
6436
6446
description: Convenience API for Sync function upsert
0 commit comments