feat(iam): add doc for UpdateUserPassword (scaleway#1553)

Co-authored-by: Laure-di <[email protected]>
scaleway-bot · Nov 4, 2024 · 56cb327 · 56cb327
1 parent 3b0ef23
commit 56cb327
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/packages/clients/src/api/iam/v1alpha1/api.gen.ts b/packages/clients/src/api/iam/v1alpha1/api.gen.ts
@@ -347,6 +347,12 @@ export class API extends ParentAPI {
       unmarshalUser,
     )
 
+  /**
+   * Update an user's password.
+   *
+   * @param request - The request {@link UpdateUserPasswordRequest}
+   * @returns A Promise of User
+   */
   updateUserPassword = (request: Readonly<UpdateUserPasswordRequest>) =>
     this.client.fetch<User>(
       {

diff --git a/packages/clients/src/api/iam/v1alpha1/types.gen.ts b/packages/clients/src/api/iam/v1alpha1/types.gen.ts
@@ -1079,8 +1079,14 @@ export type UpdateSSHKeyRequest = {
 }
 
 export type UpdateUserPasswordRequest = {
+  /** ID of the user to update. */
   userId: string
+  /** The new password. */
   password: string
+  /**
+   * Whether or not to send an email alerting the user their password has
+   * changed.
+   */
   sendEmail: boolean
 }