Skip to content

Commit 36147a7

Browse files
authored
fix(mongodb): add the new SetUserRole endpoint on the documentation (scaleway#2561)
1 parent f33fe0f commit 36147a7

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

api/mongodb/v1alpha1/mongodb_sdk.go

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -515,12 +515,15 @@ type SnapshotVolumeType struct {
515515

516516
// UserRole: user role.
517517
type UserRole struct {
518-
// Role: default value: unknown_role
518+
// Role: name of the preset role.
519+
// Default value: unknown_role
519520
Role UserRoleRole `json:"role"`
520521

522+
// Database: name of the database on which the preset role will be used.
521523
// Precisely one of Database, AnyDatabase must be set.
522524
Database *string `json:"database,omitempty"`
523525

526+
// AnyDatabase: flag to enable the preset role in all databases.
524527
// Precisely one of Database, AnyDatabase must be set.
525528
AnyDatabase *bool `json:"any_database,omitempty"`
526529
}
@@ -1907,7 +1910,7 @@ func (s *API) DeleteUser(req *DeleteUserRequest, opts ...scw.RequestOption) erro
19071910
return nil
19081911
}
19091912

1910-
// SetUserRole:
1913+
// SetUserRole: Apply preset roles for a user in a Database Instance.
19111914
func (s *API) SetUserRole(req *SetUserRoleRequest, opts ...scw.RequestOption) (*User, error) {
19121915
var err error
19131916

0 commit comments

Comments
 (0)