feat(iam): improve documention for DeleteUser (#1459)

scaleway-bot · web-flow · commit af2cd7649327 · 2022-11-17T17:32:36.000+01:00
diff --git a/api/iam/v1alpha1/iam_sdk.go b/api/iam/v1alpha1/iam_sdk.go
@@ -982,7 +982,7 @@ type DeleteUserRequest struct {
 	UserID string `json:"-"`
 }
 
-// DeleteUser: delete a user
+// DeleteUser: delete a guest user from an organization
 func (s *API) DeleteUser(req *DeleteUserRequest, opts ...scw.RequestOption) error {
 	var err error
 

Original file line number	Diff line number	Diff line change
`@@ -982,7 +982,7 @@ type DeleteUserRequest struct {`
`982`	`982`	UserID string `json:"-"`
`983`	`983`	`}`
`984`	`984`
`985`		`-// DeleteUser: delete a user`
	`985`	`+// DeleteUser: delete a guest user from an organization`
`986`	`986`	`func (s API) DeleteUser(req DeleteUserRequest, opts ...scw.RequestOption) error {`
`987`	`987`	`var err error`
`988`	`988`