diff --git a/DO_OPENAPI_COMMIT_SHA.txt b/DO_OPENAPI_COMMIT_SHA.txt index 0390375..c9cb1fd 100644 --- a/DO_OPENAPI_COMMIT_SHA.txt +++ b/DO_OPENAPI_COMMIT_SHA.txt @@ -1 +1 @@ -b5b24d0 +75904f0 diff --git a/src/pydo/_client.py b/src/pydo/_client.py index e8d2412..e0cf735 100644 --- a/src/pydo/_client.py +++ b/src/pydo/_client.py @@ -103,8 +103,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too * - PATCH - Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH - request is is a set of instructions on how to modify a resource updating only specific - attributes. + request is a set of instructions on how to modify a resource updating only specific attributes. * - POST - To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new @@ -200,7 +199,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Response for a Single Object ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { "droplet": { @@ -212,7 +211,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Response for an Object Collection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { "droplets": [ @@ -244,7 +243,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Sample Meta Object ^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { . . . @@ -287,7 +286,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Sample Links Object ^^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { . . . @@ -354,7 +353,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too ``ratelimit-remaining`` reaching zero can also indicate that the "burst limit" of 250 requests per minute limit was met, even if the 5,000 requests per hour limit was not. - In this case, the 429 error response will include a retry-after header to indicate how + In this case, the 429 error response will include a ``retry-after`` header to indicate how long to wait (in seconds) until the request may be retried. You can see the format of the response in the examples. diff --git a/src/pydo/aio/_client.py b/src/pydo/aio/_client.py index 7dafce3..7d75cad 100644 --- a/src/pydo/aio/_client.py +++ b/src/pydo/aio/_client.py @@ -103,8 +103,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too * - PATCH - Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH - request is is a set of instructions on how to modify a resource updating only specific - attributes. + request is a set of instructions on how to modify a resource updating only specific attributes. * - POST - To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new @@ -200,7 +199,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Response for a Single Object ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { "droplet": { @@ -212,7 +211,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Response for an Object Collection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { "droplets": [ @@ -244,7 +243,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Sample Meta Object ^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { . . . @@ -287,7 +286,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too Sample Links Object ^^^^^^^^^^^^^^^^^^^ - .. code-block:: + .. code-block:: json { . . . @@ -354,7 +353,7 @@ class GeneratedClient: # pylint: disable=client-accepts-api-version-keyword,too ``ratelimit-remaining`` reaching zero can also indicate that the "burst limit" of 250 requests per minute limit was met, even if the 5,000 requests per hour limit was not. - In this case, the 429 error response will include a retry-after header to indicate how + In this case, the 429 error response will include a ``retry-after`` header to indicate how long to wait (in seconds) until the request may be retried. You can see the format of the response in the examples. diff --git a/src/pydo/aio/operations/_operations.py b/src/pydo/aio/operations/_operations.py index 509f345..9e50fdc 100644 --- a/src/pydo/aio/operations/_operations.py +++ b/src/pydo/aio/operations/_operations.py @@ -85569,6 +85569,8 @@ async def list_options(self, **kwargs: Any) -> JSON: To list all of the options available for the offered database engines, send a GET request to ``/v2/databases/options``. The result will be a JSON object with an ``options`` key. + OpenSearch is in closed beta. To request access, `contact support + `_. :return: JSON object :rtype: JSON @@ -85935,8 +85937,10 @@ async def list_clusters( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for - Kafka and "opensearch" for Opensearch. Required. Known values are: "pg", - "mysql", "redis", "mongodb", "kafka", and "opensearch". + Kafka and "opensearch" for OpenSearch. OpenSearch is in closed beta. To + request access, `contact support + `_. Required. Known values are: + "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database @@ -86279,6 +86283,8 @@ async def create_cluster( timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. + OpenSearch is in closed beta. To request access, `contact support + `_. :param body: Required. :type body: JSON @@ -86297,8 +86303,9 @@ async def create_cluster( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" for - Opensearch. Required. Known values are: "pg", "mysql", "redis", "mongodb", - "kafka", and "opensearch". + OpenSearch. OpenSearch is in closed beta. To request access, `contact support + `_. Required. Known values are: "pg", + "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. Required. @@ -86516,8 +86523,9 @@ async def create_cluster( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. @@ -86770,6 +86778,8 @@ async def create_cluster( timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. + OpenSearch is in closed beta. To request access, `contact support + `_. :param body: Required. :type body: IO[bytes] @@ -86789,8 +86799,9 @@ async def create_cluster( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. @@ -87041,6 +87052,8 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. + OpenSearch is in closed beta. To request access, `contact support + `_. :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] @@ -87056,8 +87069,9 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" for - Opensearch. Required. Known values are: "pg", "mysql", "redis", "mongodb", - "kafka", and "opensearch". + OpenSearch. OpenSearch is in closed beta. To request access, `contact support + `_. Required. Known values are: "pg", + "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. Required. @@ -87275,8 +87289,9 @@ async def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> J "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. @@ -87628,8 +87643,9 @@ async def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. diff --git a/src/pydo/operations/_operations.py b/src/pydo/operations/_operations.py index 97fa0fe..38c4868 100644 --- a/src/pydo/operations/_operations.py +++ b/src/pydo/operations/_operations.py @@ -92545,6 +92545,8 @@ def list_options(self, **kwargs: Any) -> JSON: To list all of the options available for the offered database engines, send a GET request to ``/v2/databases/options``. The result will be a JSON object with an ``options`` key. + OpenSearch is in closed beta. To request access, `contact support + `_. :return: JSON object :rtype: JSON @@ -92909,8 +92911,10 @@ def list_clusters(self, *, tag_name: Optional[str] = None, **kwargs: Any) -> JSO "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for - Kafka and "opensearch" for Opensearch. Required. Known values are: "pg", - "mysql", "redis", "mongodb", "kafka", and "opensearch". + Kafka and "opensearch" for OpenSearch. OpenSearch is in closed beta. To + request access, `contact support + `_. Required. Known values are: + "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database @@ -93253,6 +93257,8 @@ def create_cluster( timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. + OpenSearch is in closed beta. To request access, `contact support + `_. :param body: Required. :type body: JSON @@ -93271,8 +93277,9 @@ def create_cluster( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" for - Opensearch. Required. Known values are: "pg", "mysql", "redis", "mongodb", - "kafka", and "opensearch". + OpenSearch. OpenSearch is in closed beta. To request access, `contact support + `_. Required. Known values are: "pg", + "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. Required. @@ -93490,8 +93497,9 @@ def create_cluster( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. @@ -93744,6 +93752,8 @@ def create_cluster( timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. + OpenSearch is in closed beta. To request access, `contact support + `_. :param body: Required. :type body: IO[bytes] @@ -93763,8 +93773,9 @@ def create_cluster( "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. @@ -94015,6 +94026,8 @@ def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters. + OpenSearch is in closed beta. To request access, `contact support + `_. :param body: Is either a JSON type or a IO[bytes] type. Required. :type body: JSON or IO[bytes] @@ -94030,8 +94043,9 @@ def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" for - Opensearch. Required. Known values are: "pg", "mysql", "redis", "mongodb", - "kafka", and "opensearch". + OpenSearch. OpenSearch is in closed beta. To request access, `contact support + `_. Required. Known values are: "pg", + "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. Required. @@ -94249,8 +94263,9 @@ def create_cluster(self, body: Union[JSON, IO[bytes]], **kwargs: Any) -> JSON: "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster. @@ -94602,8 +94617,9 @@ def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: "engine": "str", # A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" - for Opensearch. Required. Known values are: "pg", "mysql", "redis", - "mongodb", "kafka", and "opensearch". + for OpenSearch. OpenSearch is in closed beta. To request access, `contact + support `_. Required. Known values + are: "pg", "mysql", "redis", "mongodb", "kafka", and "opensearch". "name": "str", # A unique, human-readable name referring to a database cluster. Required. "num_nodes": 0, # The number of nodes in the database cluster.