docs(iam): update with new guidelines (#152)

Author: scaleway-bot

scaleway-async/scaleway_async/iam/v1alpha1/api.py

@@ -124,7 +124,7 @@ async def list_ssh_keys(
         :param organization_id: Filter by Organization ID.
         :param name: Name of group to find.
         :param project_id: Filter by Project ID.
-        :param disabled: Whether to include disabled SSH keys or not.
+        :param disabled: Defines whether to include disabled SSH keys or not.
         :return: :class:`ListSSHKeysResponse <ListSSHKeysResponse>`
 
         Usage:
@@ -171,7 +171,7 @@ async def list_ssh_keys_all(
         :param organization_id: Filter by Organization ID.
         :param name: Name of group to find.
         :param project_id: Filter by Project ID.
-        :param disabled: Whether to include disabled SSH keys or not.
+        :param disabled: Defines whether to include disabled SSH keys or not.
         :return: :class:`List[ListSSHKeysResponse] <List[ListSSHKeysResponse]>`
 
         Usage:
@@ -205,7 +205,7 @@ async def create_ssh_key(
         """
         Create an SSH key.
         Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`.
-        :param name: The name of the SSH key. Max length is 1000.
+        :param name: Name of the SSH key. Max length is 1000.
         :param public_key: SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000.
         :param project_id: Project the resource is attributed to.
         :return: :class:`SSHKey <SSHKey>`
@@ -240,7 +240,7 @@ async def get_ssh_key(
         """
         Get an SSH key.
         Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response.
-        :param ssh_key_id: The ID of the SSH key.
+        :param ssh_key_id: ID of the SSH key.
         :return: :class:`SSHKey <SSHKey>`
 
         Usage:
@@ -481,7 +481,7 @@ async def list_applications(
         :param page: Page number. Value must be greater than 1.
         :param name: Name of the application to filter.
         :param organization_id: ID of the Organization to filter.
-        :param editable: Whether to filter out editable applications or not.
+        :param editable: Defines whether to filter out editable applications or not.
         :param application_ids: Filter by list of IDs.
         :return: :class:`ListApplicationsResponse <ListApplicationsResponse>`
 
@@ -528,7 +528,7 @@ async def list_applications_all(
         :param page: Page number. Value must be greater than 1.
         :param name: Name of the application to filter.
         :param organization_id: ID of the Organization to filter.
-        :param editable: Whether to filter out editable applications or not.
+        :param editable: Defines whether to filter out editable applications or not.
         :param application_ids: Filter by list of IDs.
         :return: :class:`List[ListApplicationsResponse] <List[ListApplicationsResponse]>`
 
@@ -1058,11 +1058,11 @@ async def list_policies(
         :param page_size: Number of results per page. Value must be between 1 and 100.
         :param page: Page number. Value must be greater than 1.
         :param organization_id: ID of the Organization to filter.
-        :param editable: Whether or not filter out editable policies.
-        :param user_ids: Whether or not to filter by list of user IDs.
-        :param group_ids: Whether or not to filter by list of group IDs.
+        :param editable: Defines whether or not filter out editable policies.
+        :param user_ids: Defines whether or not to filter by list of user IDs.
+        :param group_ids: Defines whether or not to filter by list of group IDs.
         :param application_ids: Filter by a list of application IDs.
-        :param no_principal: Whether or not the policy is attributed to a principal.
+        :param no_principal: Defines whether or not the policy is attributed to a principal.
         :param policy_name: Name of the policy to fetch.
         :return: :class:`ListPoliciesResponse <ListPoliciesResponse>`
 
@@ -1114,11 +1114,11 @@ async def list_policies_all(
         :param page_size: Number of results per page. Value must be between 1 and 100.
         :param page: Page number. Value must be greater than 1.
         :param organization_id: ID of the Organization to filter.
-        :param editable: Whether or not filter out editable policies.
-        :param user_ids: Whether or not to filter by list of user IDs.
-        :param group_ids: Whether or not to filter by list of group IDs.
+        :param editable: Defines whether or not filter out editable policies.
+        :param user_ids: Defines whether or not to filter by list of user IDs.
+        :param group_ids: Defines whether or not to filter by list of group IDs.
         :param application_ids: Filter by a list of application IDs.
-        :param no_principal: Whether or not the policy is attributed to a principal.
+        :param no_principal: Defines whether or not the policy is attributed to a principal.
         :param policy_name: Name of the policy to fetch.
         :return: :class:`List[ListPoliciesResponse] <List[ListPoliciesResponse]>`
 
@@ -1174,7 +1174,7 @@ async def create_policy(
         :param application_id: ID of application attributed to the policy.
 
         One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
-        :param no_principal: Whether or not a policy is attributed to a principal.
+        :param no_principal: Defines whether or not a policy is attributed to a principal.
 
         One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
         :return: :class:`Policy <Policy>`
@@ -1259,7 +1259,7 @@ async def update_policy(
         :param application_id: New ID of application attributed to the policy.
 
         One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
-        :param no_principal: Whether or not the policy is attributed to a principal.
+        :param no_principal: Defines whether or not the policy is attributed to a principal.
 
         One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
         :return: :class:`Policy <Policy>`
@@ -1550,8 +1550,8 @@ async def list_api_keys(
         :param user_id: ID of user that bears the API key.
 
         One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
-        :param editable: Whether to filter out editable API keys or not.
-        :param expired: Whether to filter out expired API keys or not.
+        :param editable: Defines whether to filter out editable API keys or not.
+        :param expired: Defines whether to filter out expired API keys or not.
         :param access_key: Filter by access key.
         :param description: Filter by description.
         :param bearer_id: Filter by bearer ID.
@@ -1620,8 +1620,8 @@ async def list_api_keys_all(
         :param user_id: ID of user that bears the API key.
 
         One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
-        :param editable: Whether to filter out editable API keys or not.
-        :param expired: Whether to filter out expired API keys or not.
+        :param editable: Defines whether to filter out editable API keys or not.
+        :param expired: Defines whether to filter out expired API keys or not.
         :param access_key: Filter by access key.
         :param description: Filter by description.
         :param bearer_id: Filter by bearer ID.
@@ -1673,8 +1673,8 @@ async def create_api_key(
 
         One-of ('bearer'): at most one of 'application_id', 'user_id' could be set.
         :param expires_at: Expiration date of the API key.
-        :param default_project_id: The default Project ID to use with Object Storage.
-        :param description: The description of the API key (max length is 200 characters).
+        :param default_project_id: Default Project ID to use with Object Storage.
+        :param description: Description of the API key (max length is 200 characters).
         :return: :class:`APIKey <APIKey>`
 
         Usage:
@@ -1739,8 +1739,8 @@ async def update_api_key(
         Update an API key.
         Update the parameters of an API key, including `default_project_id` and `description`.
         :param access_key: Access key to update.
-        :param default_project_id: The new default Project ID to set.
-        :param description: The new description to update.
+        :param default_project_id: New default Project ID to set.
+        :param description: New description to update.
         :return: :class:`APIKey <APIKey>`
 
         Usage:

scaleway-async/scaleway_async/iam/v1alpha1/types.py

@@ -199,12 +199,12 @@ class APIKey:
 
     default_project_id: str
     """
-    The default Project ID specified for this API key.
+    Default Project ID specified for this API key.
     """
 
     editable: bool
     """
-    Whether or not the API key is editable.
+    Defines whether or not the API key is editable.
     """
 
     creation_ip: str
@@ -251,7 +251,7 @@ class Application:
 
     editable: bool
     """
-    Whether or not the application is editable.
+    Defines whether or not the application is editable.
     """
 
     nb_api_keys: int
@@ -584,7 +584,7 @@ class Policy:
 
     editable: bool
     """
-    Whether or not a policy is editable.
+    Defines whether or not a policy is editable.
     """
 
     nb_rules: int
@@ -625,7 +625,7 @@ class Policy:
 
     no_principal: Optional[bool]
     """
-    Whether or not a policy is attributed to a principal.
+    Defines whether or not a policy is attributed to a principal.
     
     One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
     """
@@ -651,7 +651,7 @@ class Quotum:
 
     unlimited: Optional[bool]
     """
-    Whether or not the quota is unlimited.
+    Defines whether or not the quota is unlimited.
     
     One-of ('value'): at most one of 'limit', 'unlimited' could be set.
     """
@@ -849,7 +849,7 @@ class User:
 
     mfa: bool
     """
-    Whether MFA is enabled.
+    Defines whether MFA is enabled.
     """
 
 
@@ -887,15 +887,15 @@ class ListSSHKeysRequest:
 
     disabled: Optional[bool]
     """
-    Whether to include disabled SSH keys or not.
+    Defines whether to include disabled SSH keys or not.
     """
 
 
 @dataclass
 class CreateSSHKeyRequest:
     name: Optional[str]
     """
-    The name of the SSH key. Max length is 1000.
+    Name of the SSH key. Max length is 1000.
     """
 
     public_key: str
@@ -913,7 +913,7 @@ class CreateSSHKeyRequest:
 class GetSSHKeyRequest:
     ssh_key_id: str
     """
-    The ID of the SSH key.
+    ID of the SSH key.
     """
 
 
@@ -1015,7 +1015,7 @@ class ListApplicationsRequest:
 
     editable: Optional[bool]
     """
-    Whether to filter out editable applications or not.
+    Defines whether to filter out editable applications or not.
     """
 
     application_ids: Optional[List[str]]
@@ -1248,17 +1248,17 @@ class ListPoliciesRequest:
 
     editable: Optional[bool]
     """
-    Whether or not filter out editable policies.
+    Defines whether or not filter out editable policies.
     """
 
     user_ids: Optional[List[str]]
     """
-    Whether or not to filter by list of user IDs.
+    Defines whether or not to filter by list of user IDs.
     """
 
     group_ids: Optional[List[str]]
     """
-    Whether or not to filter by list of group IDs.
+    Defines whether or not to filter by list of group IDs.
     """
 
     application_ids: Optional[List[str]]
@@ -1268,7 +1268,7 @@ class ListPoliciesRequest:
 
     no_principal: Optional[bool]
     """
-    Whether or not the policy is attributed to a principal.
+    Defines whether or not the policy is attributed to a principal.
     """
 
     policy_name: Optional[str]
@@ -1322,7 +1322,7 @@ class CreatePolicyRequest:
 
     no_principal: Optional[bool]
     """
-    Whether or not a policy is attributed to a principal.
+    Defines whether or not a policy is attributed to a principal.
     
     One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
     """
@@ -1376,7 +1376,7 @@ class UpdatePolicyRequest:
 
     no_principal: Optional[bool]
     """
-    Whether or not the policy is attributed to a principal.
+    Defines whether or not the policy is attributed to a principal.
     
     One-of ('principal'): at most one of 'user_id', 'group_id', 'application_id', 'no_principal' could be set.
     """
@@ -1489,12 +1489,12 @@ class ListAPIKeysRequest:
 
     editable: Optional[bool]
     """
-    Whether to filter out editable API keys or not.
+    Defines whether to filter out editable API keys or not.
     """
 
     expired: Optional[bool]
     """
-    Whether to filter out expired API keys or not.
+    Defines whether to filter out expired API keys or not.
     """
 
     access_key: Optional[str]
@@ -1541,12 +1541,12 @@ class CreateAPIKeyRequest:
 
     default_project_id: Optional[str]
     """
-    The default Project ID to use with Object Storage.
+    Default Project ID to use with Object Storage.
     """
 
     description: str
     """
-    The description of the API key (max length is 200 characters).
+    Description of the API key (max length is 200 characters).
     """
 
 
@@ -1567,12 +1567,12 @@ class UpdateAPIKeyRequest:
 
     default_project_id: Optional[str]
     """
-    The new default Project ID to set.
+    New default Project ID to set.
     """
 
     description: Optional[str]
     """
-    The new description to update.
+    New description to update.
     """