docs(iam): document UpdateUserUsername (scaleway#2358)

scaleway-bot · web-flow · commit c784ebeab26f · 2024-12-13T16:08:49.000Z
diff --git a/api/iam/v1alpha1/iam_sdk.go b/api/iam/v1alpha1/iam_sdk.go
@@ -2338,8 +2338,10 @@ type UpdateUserRequest struct {
 
 // UpdateUserUsernameRequest: update user username request.
 type UpdateUserUsernameRequest struct {
+	// UserID: ID of the user to update.
 	UserID string `json:"-"`
 
+	// Username: the new username.
 	Username string `json:"username"`
 }
 
@@ -2619,7 +2621,7 @@ func (s *API) CreateUser(req *CreateUserRequest, opts ...scw.RequestOption) (*Us
 	return &resp, nil
 }
 
-// UpdateUserUsername:
+// UpdateUserUsername: Update an user's username. Private Beta feature.
 func (s *API) UpdateUserUsername(req *UpdateUserUsernameRequest, opts ...scw.RequestOption) (*User, error) {
 	var err error
 

Original file line number	Diff line number	Diff line change
`@@ -2338,8 +2338,10 @@ type UpdateUserRequest struct {`
`2338`	`2338`
`2339`	`2339`	`// UpdateUserUsernameRequest: update user username request.`
`2340`	`2340`	`type UpdateUserUsernameRequest struct {`
	`2341`	`+ // UserID: ID of the user to update.`
`2341`	`2342`	UserID string `json:"-"`
`2342`	`2343`
	`2344`	`+ // Username: the new username.`
`2343`	`2345`	Username string `json:"username"`
`2344`	`2346`	`}`
`2345`	`2347`
`@@ -2619,7 +2621,7 @@ func (s API) CreateUser(req CreateUserRequest, opts ...scw.RequestOption) (*Us`
`2619`	`2621`	`return &resp, nil`
`2620`	`2622`	`}`
`2621`	`2623`
`2622`		`-// UpdateUserUsername:`
	`2624`	`+// UpdateUserUsername: Update an user's username. Private Beta feature.`
`2623`	`2625`	`func (s API) UpdateUserUsername(req UpdateUserUsernameRequest, opts ...scw.RequestOption) (*User, error) {`
`2624`	`2626`	`var err error`
`2625`	`2627`