Skip to content

Commit 32b99b0

Browse files
authored
RS 7.22.0 June maintenance release docs (#1702)
* DOC-5333 RS: 7.22.0 June maintenance release notes * Added license_expiration_days to v2 Prometheus metrics * Fixed /users/password REST API reference * Fixed REST API examples, links, and explanations in password rotation doc * DOC-5333 Added more resolved issues * DOC-5333 Feedback update - /users/password resolved issue wording * DOC-5333 Added build number and checksums * DOC-5333 Added resolved issue for incorrect status returned by DB endpoint availability API
1 parent bc13331 commit 32b99b0

File tree

4 files changed

+314
-18
lines changed

4 files changed

+314
-18
lines changed

content/embeds/rs-prometheus-metrics-v2.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
| <span class="break-all">generation{cluster_wd=<node_uid>}</span> | gauge| Generation number of the specific cluster_wd|
6767
| <span class="break-all">has_qourum{cluster_wd=<node_uid>, has_witness_disk=BOOL}</span> | gauge| Has_qourum = 1<br />No quorum = 0 |
6868
| <span class="break-all">is_primary{cluster_wd=<node_uid>}</span> | gauge| primary = 1<br />secondary = 0 |
69+
| <span class="break-all">license_expiration_days</span> | gauge | Number of days until the license expires |
6970
| <span class="break-all">license_shards_limit</span> | gauge | Total shard limit by the license by shard type (ram / flash) |
7071
| <span class="break-all">total_live_nodes_count{cluster_wd=<node_uid>}</span> | gauge| Number of live nodes|
7172
| <span class="break-all">total_node_count{cluster_wd=<node_uid>}</span> | gauge| Number of nodes |

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

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ weight: $weight
1313

1414
| Method | Path | Description |
1515
|----------------------------|----------------------|-----------------------------|
16-
| [PUT](#update-password) | `/v1/users/password` | Replace the password of the authenticated user |
17-
| [POST](#add-password) | `/v1/users/password` | Add a new password for the authenticated user |
18-
| [DELETE](#delete-password) | `/v1/users/password` | Delete a password for the authenticated user |
16+
| [PUT](#update-password) | `/v1/users/password` | Replace passwords |
17+
| [POST](#add-password) | `/v1/users/password` | Add a new password |
18+
| [DELETE](#delete-password) | `/v1/users/password` | Delete a password |
1919

2020
## Update password {#update-password}
2121

2222
PUT /v1/users/password
2323

24-
Replaces the password list of the user making this request with a single new password. The request authentication header must include the relevant username and password.
24+
Replaces the password list of the specified user with a single new password. If a `username` is not provided in the JSON request body, it replaces the password list of the authenticated user making this request instead.
2525

2626
### Request {#put-request}
2727

@@ -33,6 +33,7 @@ Replaces the password list of the user making this request with a single new pas
3333

3434
```json
3535
{
36+
"username": "The username of the affected user. If missing, default to the authenticated user.",
3637
"new_password": "the new (single) password"
3738
}
3839
```
@@ -49,6 +50,7 @@ The request must contain a JSON object with the following fields:
4950

5051
| Field | Type | Description |
5152
|-------|------|-------------|
53+
| username | string | (Optional) The username of the affected user. If missing, defaults to the authenticated user. |
5254
| new_password | string | The new password (required) |
5355

5456
### Response {#put-response}
@@ -65,6 +67,8 @@ The following are possible `error_code` values:
6567
|------|-------------|
6668
| password_not_complex | The given password is not complex enough (Only work when the password_complexity feature is enabled). |
6769
| new_password_same_as_current | The given new password is identical to one of the already existing passwords. |
70+
| user_not_exist | User does not exist. |
71+
| unauthorized_action | Updating another user's password is acceptable by an admin user only. |
6872

6973
### Status codes {#put-status-codes}
7074

@@ -73,12 +77,14 @@ The following are possible `error_code` values:
7377
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, password changed. |
7478
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing parameters. |
7579
| [401 Unauthorized](https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized) | The user is unauthorized. |
80+
| [403 Forbidden](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) | Insufficient privileges. |
81+
| [404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found) | User not found. |
7682

7783
## Add password {#add-password}
7884

7985
POST /v1/users/password
8086

81-
Adds a new password to the password list of the user making this request. The request authentication header must include the relevant username and password.
87+
Adds a new password to the specified user's password list. If a `username` is not provided in the JSON request body, it adds the password to the password list of the authenticated user making this request instead.
8288

8389
### Request {#post-request}
8490

@@ -90,6 +96,7 @@ Adds a new password to the password list of the user making this request. The re
9096

9197
```json
9298
{
99+
"username": "The username of the affected user. If missing, default to the authenticated user.",
93100
"new_password": "a password to add"
94101
}
95102
```
@@ -106,6 +113,7 @@ The request must contain a JSON object with the following fields:
106113

107114
| Field | Type | Description |
108115
|-------|------|-------------|
116+
| username | string | (Optional) The username of the affected user. If missing, defaults to the authenticated user. |
109117
| new_password | string | New password to add (required) |
110118

111119
### Response {#post-response}
@@ -122,6 +130,8 @@ The following are possible `error_code` values:
122130
|------|-------------|
123131
| password_not_complex | The given password is not complex enough (Only work when the password_complexity feature is enabled). |
124132
| new_password_same_as_current | The given new password is identical to one of the already existing passwords. |
133+
| user_not_exist | User does not exist. |
134+
| unauthorized_action | Updating another user's password is acceptable by an admin user only. |
125135

126136
### Status codes {#post-status-codes}
127137

@@ -130,12 +140,14 @@ The following are possible `error_code` values:
130140
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, new password was added to the list of valid passwords. |
131141
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing parameters. |
132142
| [401 Unauthorized](https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized) | The user is unauthorized. |
143+
| [403 Forbidden](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) | Insufficient privileges. |
144+
| [404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found) | User not found. |
133145

134146
## Delete password {#delete-password}
135147

136148
DELETE /v1/users/password
137149

138-
Deletes a password from the password list of the user making this request. The request authentication header must include the relevant username and password.
150+
Deletes a password from the specified user's password list. If a `username` is not provided in the JSON request body, it deletes the password from the password list of the authenticated user making this request instead.
139151

140152
### Request {#delete-request}
141153

@@ -147,7 +159,8 @@ Deletes a password from the password list of the user making this request. The r
147159

148160
```json
149161
{
150-
"old_password": "an existing password"
162+
"username": "The username of the affected user. If missing, default to the authenticated user.",
163+
"old_password": "an existing password to delete"
151164
}
152165
```
153166

@@ -163,6 +176,7 @@ The request must contain a JSON object with the following fields:
163176

164177
| Field | Type | Description |
165178
|-------|------|-------------|
179+
| username | string | (Optional) The username of the affected user. If missing, defaults to the authenticated user. |
166180
| old_password | string | Existing password to be deleted (required) |
167181

168182
### Response {#delete-response}
@@ -175,7 +189,9 @@ The following are possible `error_code` values:
175189

176190
| Code | Description |
177191
|------|-------------|
178-
| cannot_delete_last_password | Cannot delete the last password of a user |
192+
| cannot_delete_last_password | Cannot delete the last password of a user. |
193+
| user_not_exist | User does not exist. |
194+
| unauthorized_action | Updating another user's password is acceptable by an admin user only. |
179195

180196
### Status codes {#delete-status-codes}
181197

@@ -184,3 +200,5 @@ The following are possible `error_code` values:
184200
| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, new password was deleted from the list of valid passwords. |
185201
| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing parameters. |
186202
| [401 Unauthorized](https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized) | The user is unauthorized. |
203+
| [403 Forbidden](https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden) | Insufficient privileges. |
204+
| [404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found) | User not found. |

0 commit comments

Comments
 (0)