Skip to content

Commit 52e18b0

Browse files
committed
DOC-4961 DOC-4962 RS: Added dry_run option to user and role REST API requests
1 parent 0763dc3 commit 52e18b0

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

content/operate/rs/references/rest-api/requests/roles/_index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,17 @@ PUT /v1/roles/17
199199
| Host | cnm.cluster.fqdn | Domain name |
200200
| Accept | application/json | Accepted media type |
201201

202+
#### Query parameters
203+
204+
| Field | Type | Description |
205+
|---------|------|---------------|
206+
| dry_run | | Validate the updated [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) but don't apply the update. |
207+
208+
#### URL parameters
209+
210+
| Field | Type | Description |
211+
|-------|------|-------------|
212+
| uid | integer | The role's unique ID. |
202213

203214
#### Body
204215

@@ -275,6 +286,11 @@ POST /v1/roles
275286
| Host | cnm.cluster.fqdn | Domain name |
276287
| Accept | application/json | Accepted media type |
277288

289+
#### Query parameters
290+
291+
| Field | Type | Description |
292+
|---------|------|---------------|
293+
| dry_run | | Validate the new [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) but don't apply the update. |
278294

279295
#### Body
280296

content/operate/rs/references/rest-api/requests/users/_index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@ PUT /v1/users/1
190190
| Host | cnm.cluster.fqdn | Domain name |
191191
| Accept | application/json | Accepted media type |
192192

193+
#### Query parameters
194+
195+
| Field | Type | Description |
196+
|---------|------|---------------|
197+
| dry_run | | Validate the updated [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) but don't apply the update. |
193198

194199
#### URL parameters
195200

@@ -274,6 +279,12 @@ POST /v1/users
274279
| Host | cnm.cluster.fqdn | Domain name |
275280
| Accept | application/json | Accepted media type |
276281

282+
#### Query parameters
283+
284+
| Field | Type | Description |
285+
|---------|------|---------------|
286+
| dry_run | | Validate the new [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) but don't apply the update. |
287+
277288
#### Body
278289

279290
Include a single [user object]({{< relref "/operate/rs/references/rest-api/objects/user" >}}) in the request body. The user object must have an email, password, and role.

0 commit comments

Comments
 (0)