Changes to dds_api-ref from docs/doc-exports#1036 (dds_api

Enabling Shard or Co Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>
Update tox.ini && conf.py file
2024-01-31 18:53:15 +00:00 · 2024-01-17 13:29:14 +00:00 · 2024-01-11 12:49:38 +00:00 · 2024-01-02 13:48:02 +00:00 · 2023-11-14 13:35:47 +00:00 · 2023-10-25 13:04:14 +00:00
9 changed files with 103 additions and 57 deletions
--- a/api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst
+++ b/api-ref/source/apis_v3.0_recommended/backup_and_restoration/restoring_data_to_a_new_db_instance.rst
@ -71,7 +71,7 @@ Requests
      |                       |                 |                  |                                                                                                                                                                                                                        |
      |                       |                 |                  | Enter a strong password to improve security, preventing security risks such as brute force cracking.                                                                                                                   |
      +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | disk_encryption_id    | No              | String           | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules.                                                                                                              |
+      | disk_encryption_id    | No              | String           | The key ID used for disk encryption. The string must comply with UUID regular expression rules.                                                                                                                        |
      |                       |                 |                  |                                                                                                                                                                                                                        |
      |                       |                 |                  | If this parameter is not transferred, disk encryption is not performed.                                                                                                                                                |
      +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -479,7 +479,7 @@ Responses
          "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
          "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
          "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
-          "disk_encryption_id": "",
+          "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
          "mode": "Sharding",
          "flavor": [
              {
@ -528,7 +528,7 @@ Responses
          "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
          "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
          "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
-          "disk_encryption_id": "",
+          "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
          "mode": "ReplicaSet",
          "flavor": [
              {
@ -566,7 +566,7 @@ Responses
          "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
          "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
          "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
-          "disk_encryption_id": "",
+          "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
          "mode": "Single",
          "flavor": [
              {
--- a/api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst
+++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/creating_a_db_instance.rst
@ -78,7 +78,7 @@ Requests
      |                       |                 |                  |                                                                                                                                                                                                                                           |
      |                       |                 |                  | Enter a strong password to improve security, preventing security risks such as brute force cracking.                                                                                                                                      |
      +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | disk_encryption_id    | No              | String           | Specifies the key ID used for disk encryption. The string must comply with UUID regular expression rules.                                                                                                                                 |
+      | disk_encryption_id    | No              | String           | The key ID used for disk encryption. The string must comply with UUID regular expression rules.                                                                                                                                           |
      |                       |                 |                  |                                                                                                                                                                                                                                           |
      |                       |                 |                  | If this parameter is not transferred, disk encryption is not performed.                                                                                                                                                                   |
      +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -583,7 +583,7 @@ Responses
          "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
          "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
          "port": 8365,
-          "disk_encryption_id": "",
+          "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
          "mode": "Sharding",
          "flavor": [
              {
@ -637,7 +637,7 @@ Responses
          "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
          "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
          "port": 8365,
-          "disk_encryption_id": "",
+          "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
          "mode": "ReplicaSet",
          "flavor": [
              {
@ -680,7 +680,7 @@ Responses
          "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
          "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
          "port": 8365,
-          "disk_encryption_id": "",
+          "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
          "mode": "Single",
          "flavor": [
              {
--- a/api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst
+++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/enabling_shard_or_config_ip_addresses.rst
@ -16,7 +16,7 @@ Constraints
 -  Frozen instances do not support this operation.
 -  DB instances associated with the IPv6 subnet do not support this operation.
 -  If the IP address is enabled, restart the nodes for the setting to take effect.
-  Cluster instances of Community Edition 3.4, 4.0 and 4.2 are supported.
+-  Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported.
 -  This function cannot be disabled after being enabled.

 URI
--- a/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst
+++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_db_instances_in_the_recycle_bin.rst
@ -102,17 +102,17 @@ Responses

   .. table:: **Table 5** RecycleDatastore

-      +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
+      +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
      | Name                  | Type                  | Description                                                                                                          |
-      +=======================+=======================+========================================================================================================+
+      +=======================+=======================+======================================================================================================================+
      | type                  | String                | Database type. The value is **DDS-Community**.                                                                       |
      |                       |                       |                                                                                                                      |
      |                       |                       | Enumerated values:                                                                                                   |
      |                       |                       |                                                                                                                      |
      |                       |                       | -  DDS-Community                                                                                                     |
-      +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
-      | version               | String                | Database version. Versions 3.4, 4.0, and 4.2 are supported. The value can be **3.4, 4.0,** or **4.2**. |
-      +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
+      +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+
+      | version               | String                | Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be **3.4, 4.0,** **4.2,** or **4.4**. |
+      +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+

 -  Response Example

--- a/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_instances_and_details.rst
+++ b/api-ref/source/apis_v3.0_recommended/db_instance_management/querying_instances_and_details.rst
@ -168,7 +168,7 @@ Responses
      |                       |                       |                                                                                                                                                                                        |
      |                       |                       | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`.                                                                                                           |
      +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-      | disk_encryption_id    | String                | Indicates the disk encryption key ID. This parameter is returned only when the instance disk is encrypted.                                                                             |
+      | disk_encryption_id    | String                | The disk encryption key ID. This parameter is returned only when the instance disk is encrypted.                                                                                       |
      +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | enterprise_project_id | String                | Indicates the enterprise project ID.                                                                                                                                                   |
      |                       |                       |                                                                                                                                                                                        |
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@ -1,7 +1,11 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
+
 otcdocstheme # Apache-2.0
+
 # releasenotes
 reno>=3.1.0 # Apache-2.0

 otc-sphinx-directives>=0.1.0
+sphinx-minify>=0.0.1 # Apache-2.0
 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/document-database-service'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'

+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = ''
+otcdocs_doc_link = ''
+otcdocs_doc_title = ''
+otcdocs_doc_type = ''
+otcdocs_service_category = 'database'
+otcdocs_service_title = 'Document Database Service'
+otcdocs_service_type = 'dds'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
--- a/tox.ini
+++ b/tox.ini
--- a/zuul.yaml
+++ b/zuul.yaml
@ -4,5 +4,9 @@
    default-branch: main
    templates:
      - helpcenter-base-jobs
-      - api-ref-hc-int-jobs
-      - umn-hc-int-jobs
+    check:
+      jobs:
+        - noop
+    gate:
+      jobs:
+        - noop
Author	SHA1	Message	Date
proposalbot	b3ecf9fc5b	Changes to dds_api-ref from docs/doc-exports#1036 (dds_api Enabling Shard or Co Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2024-01-31 18:53:15 +00:00
tischrei	bab39dfb01	Update tox.ini && conf.py file Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>	2024-01-17 13:29:14 +00:00
proposalbot	08efb2938c	Changes to dds_api-ref from docs/doc-exports#1003 (dds_api Supported disk encry Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2024-01-11 12:49:38 +00:00
proposalbot	da6cbcc3a5	Changes to dds_api-ref from docs/doc-exports#997 (WIP: Update Metadata) Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2024-01-02 13:48:02 +00:00
Gode, Sebastian	40e37c8637	Update tox.ini && conf.py file Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>	2023-11-14 13:35:47 +00:00
proposalbot	45c9ba0e77	Changes to dds_api-ref from docs/doc-exports#936 (adding drs best-practice metad Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2023-10-25 13:04:14 +00:00