Changes to ccn_api-ref from docs/doc-exports#1451 (CCN API 20250121 version)

Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>
Co-committed-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>

api-ref/source/api/central_network_capabilities/index.rst

@@ -0,0 +1,14 @@
+:original_name: topic_300000015.html
+
+.. _topic_300000015:
+
+Central Network Capabilities
+============================
+
+-  :ref:`Querying Central Network Capabilities <listcentralnetworkcapabilities>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_central_network_capabilities

api-ref/source/api/central_network_connections/index.rst

@@ -0,0 +1,16 @@
+:original_name: topic_300000008.html
+
+.. _topic_300000008:
+
+Central Network Connections
+===========================
+
+-  :ref:`Querying the List of Central Network Connections <listcentralnetworkconnections>`
+-  :ref:`Modifying the Bandwidth of a Central Network Connection <updatecentralnetworkconnection>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_the_list_of_central_network_connections
+   modifying_the_bandwidth_of_a_central_network_connection

api-ref/source/api/central_network_policies/deleting_a_central_network_policy.rst

@@ -0,0 +1,78 @@
+:original_name: DeleteCentralNetworkPolicy.html
+
+.. _DeleteCentralNetworkPolicy:
+
+Deleting a Central Network Policy
+=================================
+
+Function
+--------
+
+This API is used to delete a central network policy. An applied policy cannot be deleted.
+
+URI
+---
+
+DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}
+
+.. table:: **Table 1** Path Parameters
+
+   ================== ========= ====== ==========================
+   Parameter          Mandatory Type   Description
+   ================== ========= ====== ==========================
+   domain_id          Yes       String Account ID.
+   policy_id          Yes       String Central network policy ID.
+   central_network_id Yes       String Central network ID.
+   ================== ========= ====== ==========================
+
+Request Parameters
+------------------
+
+.. table:: **Table 2** Request header parameters
+
+   ============ ========= ====== ===========
+   Parameter    Mandatory Type   Description
+   ============ ========= ====== ===========
+   X-Auth-Token No        String User token.
+   ============ ========= ====== ===========
+
+Response Parameters
+-------------------
+
+**Status code: 204**
+
+.. table:: **Table 3** Response header parameters
+
+   ============ ====== ===========
+   Parameter    Type   Description
+   ============ ====== ===========
+   x-request-id String ``-``
+   ============ ====== ===========
+
+Example Requests
+----------------
+
+Deleting a central network policy
+
+.. code-block:: text
+
+   DELETE /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}
+
+Example Responses
+-----------------
+
+None
+
+Status Codes
+------------
+
+=========== ============================================
+Status Code Description
+=========== ============================================
+204         The central network policy has been deleted.
+=========== ============================================
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/api/central_network_policies/index.rst

@@ -0,0 +1,22 @@
+:original_name: topic_300000009.html
+
+.. _topic_300000009:
+
+Central Network Policies
+========================
+
+-  :ref:`Adding a Central Network Policy <createcentralnetworkpolicy>`
+-  :ref:`Querying the List of Central Network Policies <listcentralnetworkpolicies>`
+-  :ref:`Applying a Central Network Policy <applycentralnetworkpolicy>`
+-  :ref:`Deleting a Central Network Policy <deletecentralnetworkpolicy>`
+-  :ref:`Querying the Changes Between the Current Policy and an Applied Policy <listcentralnetworkpolicychangeset>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   adding_a_central_network_policy
+   querying_the_list_of_central_network_policies
+   applying_a_central_network_policy
+   deleting_a_central_network_policy
+   querying_the_changes_between_the_current_policy_and_an_applied_policy

api-ref/source/api/central_network_quotas/index.rst

@@ -0,0 +1,14 @@
+:original_name: topic_300000014.html
+
+.. _topic_300000014:
+
+Central Network Quotas
+======================
+
+-  :ref:`Querying Central Network Resource Quotas <listcentralnetworkquotas>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_central_network_resource_quotas

api-ref/source/api/central_networks/index.rst

@@ -0,0 +1,22 @@
+:original_name: topic_300000006.html
+
+.. _topic_300000006:
+
+Central Networks
+================
+
+-  :ref:`Creating a Central Network <createcentralnetwork>`
+-  :ref:`Querying the Central Network List <listcentralnetworks>`
+-  :ref:`Querying a Central Network <showcentralnetwork>`
+-  :ref:`Updating a Central Network <updatecentralnetwork>`
+-  :ref:`Deleting a Central Network <deletecentralnetwork>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   creating_a_central_network
+   querying_the_central_network_list
+   querying_a_central_network
+   updating_a_central_network
+   deleting_a_central_network

api-ref/source/api/global_connection_bandwidths/deleting_a_global_connection_bandwidth.rst

@@ -0,0 +1,73 @@
+:original_name: DeleteGlobalConnectionBandwidth.html
+
+.. _DeleteGlobalConnectionBandwidth:
+
+Deleting a Global Connection Bandwidth
+======================================
+
+Function
+--------
+
+This API is used to delete a global connection bandwidth.
+
+URI
+---
+
+DELETE /v3/{domain_id}/gcb/gcbandwidths/{id}
+
+.. table:: **Table 1** Path Parameters
+
+   ========= ========= ====== ============
+   Parameter Mandatory Type   Description
+   ========= ========= ====== ============
+   domain_id Yes       String Account ID.
+   id        Yes       String Instance ID.
+   ========= ========= ====== ============
+
+Request Parameters
+------------------
+
+.. table:: **Table 2** Request header parameters
+
+   ============ ========= ====== ===========
+   Parameter    Mandatory Type   Description
+   ============ ========= ====== ===========
+   X-Auth-Token No        String User token.
+   ============ ========= ====== ===========
+
+Response Parameters
+-------------------
+
+**Status code: 204**
+
+The global connection bandwidth has been deleted.
+
+None
+
+Example Requests
+----------------
+
+Deleting a global connection bandwidth
+
+.. code-block:: text
+
+   DELETE https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id}
+
+Example Responses
+-----------------
+
+None
+
+Status Codes
+------------
+
+=========== =================================================
+Status Code Description
+=========== =================================================
+204         The global connection bandwidth has been deleted.
+=========== =================================================
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/api/global_connection_bandwidths/index.rst

@@ -0,0 +1,28 @@
+:original_name: topic_300000019.html
+
+.. _topic_300000019:
+
+Global Connection Bandwidths
+============================
+
+-  :ref:`Querying the Global Connection Bandwidth List <listglobalconnectionbandwidths>`
+-  :ref:`Creating a Global Connection Bandwidth <createglobalconnectionbandwidth>`
+-  :ref:`Querying a Global Connection Bandwidth <showglobalconnectionbandwidth>`
+-  :ref:`Updating a Global Connection Bandwidth <updateglobalconnectionbandwidth>`
+-  :ref:`Deleting a Global Connection Bandwidth <deleteglobalconnectionbandwidth>`
+-  :ref:`Querying the List of Global Connection Bandwidths That Meet the Binding Conditions <listsupportbindingconnectionbandwidths>`
+-  :ref:`Querying the Tenant Configuration of a Global Connection Bandwidth <listglobalconnectionbandwidthconfigs>`
+-  :ref:`Querying the Site List <listglobalconnectionbandwidthsites>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_the_global_connection_bandwidth_list
+   creating_a_global_connection_bandwidth
+   querying_a_global_connection_bandwidth
+   updating_a_global_connection_bandwidth
+   deleting_a_global_connection_bandwidth
+   querying_the_list_of_global_connection_bandwidths_that_meet_the_binding_conditions
+   querying_the_tenant_configuration_of_a_global_connection_bandwidth
+   querying_the_site_list

api-ref/source/api/index.rst

@@ -0,0 +1,24 @@
+:original_name: cc_01_0014.html
+
+.. _cc_01_0014:
+
+API
+===
+
+-  :ref:`Central Networks <topic_300000006>`
+-  :ref:`Central Network Connections <topic_300000008>`
+-  :ref:`Central Network Policies <topic_300000009>`
+-  :ref:`Central Network Quotas <topic_300000014>`
+-  :ref:`Central Network Capabilities <topic_300000015>`
+-  :ref:`Global Connection Bandwidths <topic_300000019>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   central_networks/index
+   central_network_connections/index
+   central_network_policies/index
+   central_network_quotas/index
+   central_network_capabilities/index
+   global_connection_bandwidths/index