Compare commits

..

2 Commits
main ... confpy

Author SHA1 Message Date
48320170ef adding entry in sbv 2023-10-24 19:39:38 +00:00
87e27bcc35 Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
2023-10-24 09:38:24 +00:00
10 changed files with 58 additions and 109 deletions

View File

@ -71,7 +71,7 @@ Requests
| | | | | | | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. | | | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. | | disk_encryption_id | No | String | Specifies 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. | | | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -479,7 +479,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "disk_encryption_id": "",
"mode": "Sharding", "mode": "Sharding",
"flavor": [ "flavor": [
{ {
@ -528,7 +528,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "disk_encryption_id": "",
"mode": "ReplicaSet", "mode": "ReplicaSet",
"flavor": [ "flavor": [
{ {
@ -566,7 +566,7 @@ Responses
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "disk_encryption_id": "",
"mode": "Single", "mode": "Single",
"flavor": [ "flavor": [
{ {

View File

@ -78,7 +78,7 @@ Requests
| | | | | | | | | |
| | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. | | | | | Enter a strong password to improve security, preventing security risks such as brute force cracking. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | No | String | The key ID used for disk encryption. The string must comply with UUID regular expression rules. | | disk_encryption_id | No | String | Specifies 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. | | | | | If this parameter is not transferred, disk encryption is not performed. |
+-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -583,7 +583,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365, "port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "disk_encryption_id": "",
"mode": "Sharding", "mode": "Sharding",
"flavor": [ "flavor": [
{ {
@ -637,7 +637,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365, "port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "disk_encryption_id": "",
"mode": "ReplicaSet", "mode": "ReplicaSet",
"flavor": [ "flavor": [
{ {
@ -680,7 +680,7 @@ Responses
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"port": 8365, "port": 8365,
"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "disk_encryption_id": "",
"mode": "Single", "mode": "Single",
"flavor": [ "flavor": [
{ {

View File

@ -16,7 +16,7 @@ Constraints
- Frozen instances do not support this operation. - Frozen instances do not support this operation.
- DB instances associated with the IPv6 subnet 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. - If the IP address is enabled, restart the nodes for the setting to take effect.
- Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported. - Cluster instances of Community Edition 3.4, 4.0 and 4.2 are supported.
- This function cannot be disabled after being enabled. - This function cannot be disabled after being enabled.
URI URI

View File

@ -102,17 +102,17 @@ Responses
.. table:: **Table 5** RecycleDatastore .. table:: **Table 5** RecycleDatastore
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+======================================================================================================================+ +=======================+=======================+========================================================================================================+
| type | String | Database type. The value is **DDS-Community**. | | type | String | Database type. The value is **DDS-Community**. |
| | | | | | | |
| | | Enumerated values: | | | | Enumerated values: |
| | | | | | | |
| | | - DDS-Community | | | | - DDS-Community |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
| 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**. | | 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**. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+
- Response Example - Response Example

View File

@ -168,7 +168,7 @@ Responses
| | | | | | | |
| | | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`. | | | | For more information, see :ref:`Table 6 <dds_api_0023__table0581104824211>`. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| disk_encryption_id | String | The disk encryption key ID. This parameter is returned only when the instance disk is encrypted. | | disk_encryption_id | String | Indicates 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. | | enterprise_project_id | String | Indicates the enterprise project ID. |
| | | | | | | |

View File

@ -109,9 +109,4 @@ html_static_path = ['_static']
html_copy_source = False html_copy_source = False
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
latex_documents = [ latex_documents = []
('index',
'None.tex',
u'Document Database Service - API Reference',
u'OpenTelekomCloud', 'manual'),
]

View File

@ -1,11 +1,7 @@
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
otcdocstheme # Apache-2.0 otcdocstheme # Apache-2.0
# releasenotes # releasenotes
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.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
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
setuptools

View File

@ -31,17 +31,6 @@ otcdocs_repo_name = 'docs/document-database-service'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea' 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, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.

93
tox.ini

File diff suppressed because it is too large Load Diff

View File

@ -4,9 +4,5 @@
default-branch: main default-branch: main
templates: templates:
- helpcenter-base-jobs - helpcenter-base-jobs
check: - api-ref-hc-int-jobs
jobs: - umn-hc-int-jobs
- noop
gate:
jobs:
- noop