docs(redis): components (#153)

Author: scaleway-bot

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

@@ -106,7 +106,7 @@ async def create_cluster(
         Create a Redis™ Database Instance.
         Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param project_id: The Project ID in which to create the Database Instance.
+        :param project_id: Project ID in which to create the Database Instance.
         :param name: Name of the Database Instance.
         :param version: Redis™ engine version of the Database Instance.
         :param tags: Tags to apply to the Database Instance.
@@ -117,7 +117,7 @@ async def create_cluster(
         :param acl_rules: List of ACLRuleSpec used to secure your publicly exposed cluster.
         :param endpoints: Zero or multiple EndpointSpec used to expose your cluster publicly and inside Private Networks.
         Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default.
-        :param tls_enabled: Whether or not TLS is enabled.
+        :param tls_enabled: Defines whether or not TLS is enabled.
         :param cluster_settings: List of advanced settings to be set upon Database Instance initialization.
         :return: :class:`Cluster <Cluster>`
 
@@ -514,7 +514,7 @@ async def list_node_types(
         List available node types.
         List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled_types: Whether or not to include disabled types.
+        :param include_disabled_types: Defines whether or not to include disabled types.
         :param page:
         :param page_size:
         :return: :class:`ListNodeTypesResponse <ListNodeTypesResponse>`
@@ -552,7 +552,7 @@ async def list_node_types_all(
         List available node types.
         List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled_types: Whether or not to include disabled types.
+        :param include_disabled_types: Defines whether or not to include disabled types.
         :param page:
         :param page_size:
         :return: :class:`List[ListNodeTypesResponse] <List[ListNodeTypesResponse]>`
@@ -590,9 +590,9 @@ async def list_cluster_versions(
         List available Redis™ versions.
         List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled: Whether or not to include disabled Redis™ engine versions.
-        :param include_beta: Whether or not to include beta Redis™ engine versions.
-        :param include_deprecated: Whether or not to include deprecated Redis™ engine versions.
+        :param include_disabled: Defines whether or not to include disabled Redis™ engine versions.
+        :param include_beta: Defines whether or not to include beta Redis™ engine versions.
+        :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions.
         :param version: List Redis™ engine versions that match a given name pattern.
         :param page:
         :param page_size:
@@ -641,9 +641,9 @@ async def list_cluster_versions_all(
         List available Redis™ versions.
         List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled: Whether or not to include disabled Redis™ engine versions.
-        :param include_beta: Whether or not to include beta Redis™ engine versions.
-        :param include_deprecated: Whether or not to include deprecated Redis™ engine versions.
+        :param include_disabled: Defines whether or not to include disabled Redis™ engine versions.
+        :param include_beta: Defines whether or not to include beta Redis™ engine versions.
+        :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions.
         :param version: List Redis™ engine versions that match a given name pattern.
         :param page:
         :param page_size:

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

@@ -175,7 +175,7 @@ class AvailableClusterSetting:
 
     deprecated: bool
     """
-    Whether or not the setting is deprecated.
+    Defines whether or not the setting is deprecated.
     """
 
 
@@ -237,7 +237,7 @@ class Cluster:
 
     tls_enabled: bool
     """
-    Whether or not TLS is enabled.
+    Defines whether or not TLS is enabled.
     """
 
     cluster_settings: List[ClusterSetting]
@@ -519,12 +519,12 @@ class NodeType:
 
     disabled: bool
     """
-    The node type is currently disabled.
+    Defines whether node type is currently disabled or not.
     """
 
     beta: bool
     """
-    The node type is currently in beta.
+    Defines whether node type is currently in beta.
     """
 
     zone: Zone
@@ -593,7 +593,7 @@ class CreateClusterRequest:
 
     project_id: Optional[str]
     """
-    The Project ID in which to create the Database Instance.
+    Project ID in which to create the Database Instance.
     """
 
     name: Optional[str]
@@ -644,7 +644,7 @@ class CreateClusterRequest:
 
     tls_enabled: bool
     """
-    Whether or not TLS is enabled.
+    Defines whether or not TLS is enabled.
     """
 
     cluster_settings: Optional[List[ClusterSetting]]
@@ -825,7 +825,7 @@ class ListNodeTypesRequest:
 
     include_disabled_types: bool
     """
-    Whether or not to include disabled types.
+    Defines whether or not to include disabled types.
     """
 
     page: Optional[int]
@@ -842,17 +842,17 @@ class ListClusterVersionsRequest:
 
     include_disabled: bool
     """
-    Whether or not to include disabled Redis™ engine versions.
+    Defines whether or not to include disabled Redis™ engine versions.
     """
 
     include_beta: bool
     """
-    Whether or not to include beta Redis™ engine versions.
+    Defines whether or not to include beta Redis™ engine versions.
     """
 
     include_deprecated: bool
     """
-    Whether or not to include deprecated Redis™ engine versions.
+    Defines whether or not to include deprecated Redis™ engine versions.
     """
 
     version: Optional[str]

scaleway/scaleway/redis/v1/api.py

@@ -106,7 +106,7 @@ def create_cluster(
         Create a Redis™ Database Instance.
         Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param project_id: The Project ID in which to create the Database Instance.
+        :param project_id: Project ID in which to create the Database Instance.
         :param name: Name of the Database Instance.
         :param version: Redis™ engine version of the Database Instance.
         :param tags: Tags to apply to the Database Instance.
@@ -117,7 +117,7 @@ def create_cluster(
         :param acl_rules: List of ACLRuleSpec used to secure your publicly exposed cluster.
         :param endpoints: Zero or multiple EndpointSpec used to expose your cluster publicly and inside Private Networks.
         Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default.
-        :param tls_enabled: Whether or not TLS is enabled.
+        :param tls_enabled: Defines whether or not TLS is enabled.
         :param cluster_settings: List of advanced settings to be set upon Database Instance initialization.
         :return: :class:`Cluster <Cluster>`
 
@@ -514,7 +514,7 @@ def list_node_types(
         List available node types.
         List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled_types: Whether or not to include disabled types.
+        :param include_disabled_types: Defines whether or not to include disabled types.
         :param page:
         :param page_size:
         :return: :class:`ListNodeTypesResponse <ListNodeTypesResponse>`
@@ -552,7 +552,7 @@ def list_node_types_all(
         List available node types.
         List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled_types: Whether or not to include disabled types.
+        :param include_disabled_types: Defines whether or not to include disabled types.
         :param page:
         :param page_size:
         :return: :class:`List[ListNodeTypesResponse] <List[ListNodeTypesResponse]>`
@@ -590,9 +590,9 @@ def list_cluster_versions(
         List available Redis™ versions.
         List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled: Whether or not to include disabled Redis™ engine versions.
-        :param include_beta: Whether or not to include beta Redis™ engine versions.
-        :param include_deprecated: Whether or not to include deprecated Redis™ engine versions.
+        :param include_disabled: Defines whether or not to include disabled Redis™ engine versions.
+        :param include_beta: Defines whether or not to include beta Redis™ engine versions.
+        :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions.
         :param version: List Redis™ engine versions that match a given name pattern.
         :param page:
         :param page_size:
@@ -641,9 +641,9 @@ def list_cluster_versions_all(
         List available Redis™ versions.
         List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`.
         :param zone: Zone to target. If none is passed will use default zone from the config.
-        :param include_disabled: Whether or not to include disabled Redis™ engine versions.
-        :param include_beta: Whether or not to include beta Redis™ engine versions.
-        :param include_deprecated: Whether or not to include deprecated Redis™ engine versions.
+        :param include_disabled: Defines whether or not to include disabled Redis™ engine versions.
+        :param include_beta: Defines whether or not to include beta Redis™ engine versions.
+        :param include_deprecated: Defines whether or not to include deprecated Redis™ engine versions.
         :param version: List Redis™ engine versions that match a given name pattern.
         :param page:
         :param page_size:

scaleway/scaleway/redis/v1/types.py

@@ -175,7 +175,7 @@ class AvailableClusterSetting:
 
     deprecated: bool
     """
-    Whether or not the setting is deprecated.
+    Defines whether or not the setting is deprecated.
     """
 
 
@@ -237,7 +237,7 @@ class Cluster:
 
     tls_enabled: bool
     """
-    Whether or not TLS is enabled.
+    Defines whether or not TLS is enabled.
     """
 
     cluster_settings: List[ClusterSetting]
@@ -519,12 +519,12 @@ class NodeType:
 
     disabled: bool
     """
-    The node type is currently disabled.
+    Defines whether node type is currently disabled or not.
     """
 
     beta: bool
     """
-    The node type is currently in beta.
+    Defines whether node type is currently in beta.
     """
 
     zone: Zone
@@ -593,7 +593,7 @@ class CreateClusterRequest:
 
     project_id: Optional[str]
     """
-    The Project ID in which to create the Database Instance.
+    Project ID in which to create the Database Instance.
     """
 
     name: Optional[str]
@@ -644,7 +644,7 @@ class CreateClusterRequest:
 
     tls_enabled: bool
     """
-    Whether or not TLS is enabled.
+    Defines whether or not TLS is enabled.
     """
 
     cluster_settings: Optional[List[ClusterSetting]]
@@ -825,7 +825,7 @@ class ListNodeTypesRequest:
 
     include_disabled_types: bool
     """
-    Whether or not to include disabled types.
+    Defines whether or not to include disabled types.
     """
 
     page: Optional[int]
@@ -842,17 +842,17 @@ class ListClusterVersionsRequest:
 
     include_disabled: bool
     """
-    Whether or not to include disabled Redis™ engine versions.
+    Defines whether or not to include disabled Redis™ engine versions.
     """
 
     include_beta: bool
     """
-    Whether or not to include beta Redis™ engine versions.
+    Defines whether or not to include beta Redis™ engine versions.
     """
 
     include_deprecated: bool
     """
-    Whether or not to include deprecated Redis™ engine versions.
+    Defines whether or not to include deprecated Redis™ engine versions.
     """
 
     version: Optional[str]