Skip to content

Commit 44aa2db

Browse files
chore(cockpit): deprecate grafana users (#2560)
Co-authored-by: Rémy Léone <rleone@scaleway.com>
1 parent 8d3966f commit 44aa2db

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

packages_generated/cockpit/src/v1/api.gen.ts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,11 @@ The output returned displays the URL to access your Cockpit's Grafana.
153153
})
154154

155155
/**
156-
* Create a Grafana user. Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
156+
* (Deprecated) EOL 2026-01-20. Create a Grafana user
157+
Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
157158
Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation.
158159
*
160+
* @deprecated
159161
* @param request - The request {@link GlobalApiCreateGrafanaUserRequest}
160162
* @returns A Promise of GrafanaUser
161163
*/
@@ -199,8 +201,10 @@ Each Grafana user is associated with a role: viewer or editor. A viewer can only
199201
)
200202

201203
/**
202-
* List Grafana users. List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
204+
* (Deprecated) EOL 2026-01-20. List Grafana users
205+
List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
203206
*
207+
* @deprecated
204208
* @param request - The request {@link GlobalApiListGrafanaUsersRequest}
205209
* @returns A Promise of ListGrafanaUsersResponse
206210
*/
@@ -209,8 +213,10 @@ Each Grafana user is associated with a role: viewer or editor. A viewer can only
209213
) => enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request)
210214

211215
/**
212-
* Delete a Grafana user. Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
216+
* (Deprecated) EOL 2026-01-20. Delete a Grafana user
217+
Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
213218
*
219+
* @deprecated
214220
* @param request - The request {@link GlobalApiDeleteGrafanaUserRequest}
215221
*/
216222
deleteGrafanaUser = (request: Readonly<GlobalApiDeleteGrafanaUserRequest>) =>
@@ -224,9 +230,11 @@ Each Grafana user is associated with a role: viewer or editor. A viewer can only
224230
})
225231

226232
/**
227-
* Reset a Grafana user password. Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
233+
* (Deprecated) EOL 2026-01-20. Reset a Grafana user password
234+
Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
228235
A new password regenerates and only displays once. Make sure that you save it.
229236
*
237+
* @deprecated
230238
* @param request - The request {@link GlobalApiResetGrafanaUserPasswordRequest}
231239
* @returns A Promise of GrafanaUser
232240
*/

0 commit comments

Comments
 (0)