Skip to content

Commit f792e48

Browse files
authored
DOC-9435 -- Scope user/role to db (#622)
https://issues.couchbase.com/browse/DOC-9435
1 parent 42cf60f commit f792e48

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

modules/ROOT/assets/attachments/rest-api-admin.yaml

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ paths:
289289
operationId: 'db_config_create'
290290
summary: Create a Sync Gateway Database
291291
tags:
292-
- 'Database Configuration'
292+
- 'Database Management'
293293
description: |+
294294
Use this method to create a new Sync Gateway database.
295295
@@ -1452,7 +1452,7 @@ paths:
14521452
responses:
14531453
200:
14541454
description: Success and returns the revtree as plain text.
1455-
/_role:
1455+
/{db}/_role:
14561456
get:
14571457
tags:
14581458
- 'Database Security'
@@ -1475,6 +1475,7 @@ paths:
14751475
summary: Role
14761476
description: This request creates a new role
14771477
parameters:
1478+
- $ref: '#/parameters/db'
14781479
- $ref: '#/parameters/role'
14791480
responses:
14801481
201:
@@ -1483,13 +1484,14 @@ paths:
14831484
$ref: '#/responses/Unauthorized'
14841485
409:
14851486
$ref: '#/responses/Conflict'
1486-
/_role/{name}:
1487+
/{db}/_role/{name}:
14871488
get:
14881489
tags:
14891490
- 'Database Security'
14901491
summary: Get role
14911492
description: Request a specific role by name.
14921493
parameters:
1494+
- $ref: '#/parameters/db'
14931495
- $ref: '#/parameters/role_name'
14941496
responses:
14951497
200:
@@ -1522,6 +1524,7 @@ paths:
15221524
description: |+
15231525
Use this convenience endpoint to upsert a Sync Gateway role
15241526
parameters:
1527+
- $ref: '#/parameters/db'
15251528
- $ref: '#/parameters/role_name'
15261529
- $ref: '#/parameters/role_body_upsert'
15271530
responses:
@@ -1537,6 +1540,7 @@ paths:
15371540
summary: Deletes the role
15381541
description: This request deletes the role with the specified name
15391542
parameters:
1543+
- $ref: '#/parameters/db'
15401544
- $ref: '#/parameters/role_name'
15411545
responses:
15421546
200:
@@ -1643,12 +1647,14 @@ paths:
16431647
responses:
16441648
200:
16451649
description: User session deleted.
1646-
/_user/:
1650+
/{db}/_user/:
16471651
get:
16481652
tags:
16491653
- 'Database Security'
16501654
summary: Retrieves all users
16511655
description: This request returns all users
1656+
parameters:
1657+
- $ref: '#/parameters/db'
16521658
responses:
16531659
200:
16541660
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:
16651671
summary: Create a new user
16661672
description: This request creates a new user
16671673
parameters:
1674+
- $ref: '#/parameters/db'
16681675
- $ref: '#/parameters/user'
16691676
responses:
16701677

@@ -1674,13 +1681,14 @@ paths:
16741681
$ref: '#/responses/Unauthorized'
16751682
409:
16761683
$ref: '#/responses/Conflict'
1677-
/_user/{name}:
1684+
/{db}/_user/{name}:
16781685
get:
16791686
tags:
16801687
- 'Database Security'
16811688
summary: Retrieve a User
16821689
description: This request returns information about the specified user.
16831690
parameters:
1691+
- $ref: '#/parameters/db'
16841692
- $ref: '#/parameters/name'
16851693

16861694
responses:
@@ -1699,6 +1707,7 @@ paths:
16991707
description: |+
17001708
Use this method to create or update a user
17011709
parameters:
1710+
- $ref: '#/parameters/db'
17021711
- $ref: '#/parameters/name'
17031712
- $ref: '#/parameters/user_body_upsert'
17041713
responses:
@@ -1715,6 +1724,7 @@ paths:
17151724
summary: Delete a User
17161725
description: This request deletes the user with the specified name
17171726
parameters:
1727+
- $ref: '#/parameters/db'
17181728
- $ref: '#/parameters/name'
17191729
responses:
17201730
200:
@@ -6427,11 +6437,11 @@ tags:
64276437
description: Returns bootstrap settings and updates logging options
64286438

64296439
- name: 'Database Configuration'
6430-
description: Create and configure sync gateway databases
6440+
description: Configure sync gateway databases
64316441
- name: 'Database Management'
6432-
description: Manage sync gateway databases
6442+
description: Create and manage sync gateway databases
64336443
- name: 'Database Security'
6434-
description: Create and manage users and roles
6444+
description: Create and manage database users and roles
64356445
- name: 'Access Control'
64366446
description: Convenience API for Sync function upsert
64376447
- name: Replication

0 commit comments

Comments
 (0)