Skip to content

Commit c784785

Browse files
authored
fix(rdb): add documentation about password validation (scaleway#763)
1 parent 705015f commit c784785

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

scaleway-async/scaleway_async/rdb/v1/api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -993,7 +993,7 @@ async def create_instance(
993993
Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size.
994994
:param engine: Database engine of the Database Instance (PostgreSQL, MySQL, ...).
995995
:param user_name: Username created when the Database Instance is created.
996-
:param password: Password of the user.
996+
:param password: Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
997997
:param node_type: Type of node to use for the Database Instance.
998998
:param region: Region to target. If none is passed will use default region from the config.
999999
:param organization_id: Please use project_id instead.
@@ -2313,7 +2313,7 @@ async def create_user(
23132313
Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters.
23142314
:param instance_id: UUID of the Database Instance in which you want to create a user.
23152315
:param name: Name of the user you want to create.
2316-
:param password: Password of the user you want to create.
2316+
:param password: Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
23172317
:param is_admin: Defines whether the user will have administrative privileges.
23182318
:param region: Region to target. If none is passed will use default region from the config.
23192319
:return: :class:`User <User>`
@@ -2367,7 +2367,7 @@ async def update_user(
23672367
:param instance_id: UUID of the Database Instance the user belongs to.
23682368
:param name: Name of the database user.
23692369
:param region: Region to target. If none is passed will use default region from the config.
2370-
:param password: Password of the database user.
2370+
:param password: Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
23712371
:param is_admin: Defines whether or not this user got administrative privileges.
23722372
:return: :class:`User <User>`
23732373

scaleway-async/scaleway_async/rdb/v1/types.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,7 +1347,7 @@ class CreateInstanceRequest:
13471347

13481348
password: str
13491349
"""
1350-
Password of the user.
1350+
Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
13511351
"""
13521352

13531353
node_type: str
@@ -1493,7 +1493,7 @@ class CreateUserRequest:
14931493

14941494
password: str
14951495
"""
1496-
Password of the user you want to create.
1496+
Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
14971497
"""
14981498

14991499
is_admin: bool
@@ -2567,7 +2567,7 @@ class UpdateUserRequest:
25672567

25682568
password: Optional[str]
25692569
"""
2570-
Password of the database user.
2570+
Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
25712571
"""
25722572

25732573
is_admin: Optional[bool]

scaleway/scaleway/rdb/v1/api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -989,7 +989,7 @@ def create_instance(
989989
Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size.
990990
:param engine: Database engine of the Database Instance (PostgreSQL, MySQL, ...).
991991
:param user_name: Username created when the Database Instance is created.
992-
:param password: Password of the user.
992+
:param password: Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
993993
:param node_type: Type of node to use for the Database Instance.
994994
:param region: Region to target. If none is passed will use default region from the config.
995995
:param organization_id: Please use project_id instead.
@@ -2305,7 +2305,7 @@ def create_user(
23052305
Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters.
23062306
:param instance_id: UUID of the Database Instance in which you want to create a user.
23072307
:param name: Name of the user you want to create.
2308-
:param password: Password of the user you want to create.
2308+
:param password: Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
23092309
:param is_admin: Defines whether the user will have administrative privileges.
23102310
:param region: Region to target. If none is passed will use default region from the config.
23112311
:return: :class:`User <User>`
@@ -2359,7 +2359,7 @@ def update_user(
23592359
:param instance_id: UUID of the Database Instance the user belongs to.
23602360
:param name: Name of the database user.
23612361
:param region: Region to target. If none is passed will use default region from the config.
2362-
:param password: Password of the database user.
2362+
:param password: Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
23632363
:param is_admin: Defines whether or not this user got administrative privileges.
23642364
:return: :class:`User <User>`
23652365

scaleway/scaleway/rdb/v1/types.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,7 +1347,7 @@ class CreateInstanceRequest:
13471347

13481348
password: str
13491349
"""
1350-
Password of the user.
1350+
Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
13511351
"""
13521352

13531353
node_type: str
@@ -1493,7 +1493,7 @@ class CreateUserRequest:
14931493

14941494
password: str
14951495
"""
1496-
Password of the user you want to create.
1496+
Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
14971497
"""
14981498

14991499
is_admin: bool
@@ -2567,7 +2567,7 @@ class UpdateUserRequest:
25672567

25682568
password: Optional[str]
25692569
"""
2570-
Password of the database user.
2570+
Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
25712571
"""
25722572

25732573
is_admin: Optional[bool]

0 commit comments

Comments
 (0)