Changes to wafd_api-ref from docs/doc-exports#471 (waf dedicated API 01

waf ded

Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

api-ref/source/api_usage_guidelines.rst

@@ -0,0 +1,26 @@
+:original_name: waf_02_0001.html
+
+.. _waf_02_0001:
+
+API Usage Guidelines
+====================
+
+Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: *https://Endpoint/uri*. In the URL, **uri** indicates the resource path, that is, the API access path.
+
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by **Application/json**.
+
+For details about how to use APIs, see `API Usage Guidelines <https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API%20Documents>`__.
+
+.. important::
+
+   The following table lists the additional request header fields required for the POST, PUT, PATCH, and DELETE methods.
+
++-----------------------+-----------------------------------------------+-----------------+-----------------+
+| Parameter             | Description                                   | Mandatory       | Example         |
++=======================+===============================================+=================+=================+
+| x-request-source-type | Type of a request resource                    | Yes             | ApiCall         |
+|                       |                                               |                 |                 |
+|                       | -  **ApiCall**: invoked by an API.            |                 |                 |
+|                       | -  **ConsoleAction**: invoked by the console. |                 |                 |
+|                       | -  **SystemAction**: invoked by the system.   |                 |                 |
++-----------------------+-----------------------------------------------+-----------------+-----------------+

api-ref/source/apis/certificate_management/index.rst

@@ -0,0 +1,20 @@
+:original_name: topic_300000004.html
+
+.. _topic_300000004:
+
+Certificate Management
+======================
+
+-  :ref:`Querying the Certificate List <listcertificates>`
+-  :ref:`Creating a Certificate <createcertificate>`
+-  :ref:`Querying a Certificate <showcertificate>`
+-  :ref:`Deleting a Certificate <deletecertificate>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_the_certificate_list
+   creating_a_certificate
+   querying_a_certificate
+   deleting_a_certificate

api-ref/source/apis/dashboard/index.rst

@@ -0,0 +1,18 @@
+:original_name: topic_300000005.html
+
+.. _topic_300000005:
+
+Dashboard
+=========
+
+-  :ref:`Querying Website Request Statistics <liststatistics>`
+-  :ref:`Querying the QPS Statistics <listqpstimeline>`
+-  :ref:`Querying Bandwidth Usage Statistics <listbandwidthtimeline>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_website_request_statistics
+   querying_the_qps_statistics
+   querying_bandwidth_usage_statistics

api-ref/source/apis/dedicated_instance_management/index.rst

@@ -0,0 +1,24 @@
+:original_name: topic_300000000.html
+
+.. _topic_300000000:
+
+Dedicated Instance Management
+=============================
+
+-  :ref:`Creating a Dedicated WAF Engine <createinstance>`
+-  :ref:`Querying the List of Dedicated WAF Engines <listinstance>`
+-  :ref:`Querying Details about a Dedicated WAF Engine <showinstance>`
+-  :ref:`Renaming a Dedicated WAF Engine <renameinstance>`
+-  :ref:`Deleting a Dedicated WAF Engine <deleteinstance>`
+-  :ref:`Operations on a Dedicated WAF Instance <upgradeinstance>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   creating_a_dedicated_waf_engine
+   querying_the_list_of_dedicated_waf_engines
+   querying_details_about_a_dedicated_waf_engine
+   renaming_a_dedicated_waf_engine
+   deleting_a_dedicated_waf_engine
+   operations_on_a_dedicated_waf_instance

api-ref/source/apis/event_management/index.rst

@@ -0,0 +1,16 @@
+:original_name: topic_300000006.html
+
+.. _topic_300000006:
+
+Event Management
+================
+
+-  :ref:`Querying the List of Attack Events <listevent>`
+-  :ref:`Querying Attack Event Details <showevent>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_the_list_of_attack_events
+   querying_attack_event_details

api-ref/source/apis/index.rst

@@ -0,0 +1,26 @@
+:original_name: waf_02_0007.html
+
+.. _waf_02_0007:
+
+APIs
+====
+
+-  :ref:`Dedicated Instance Management <topic_300000000>`
+-  :ref:`Managing Websites Protected in Dedicated Mode <topic_300000001>`
+-  :ref:`Policy Management <topic_300000002>`
+-  :ref:`Rule Management <topic_300000003>`
+-  :ref:`Certificate Management <topic_300000004>`
+-  :ref:`Dashboard <topic_300000005>`
+-  :ref:`Event Management <topic_300000006>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   dedicated_instance_management/index
+   managing_websites_protected_in_dedicated_mode/index
+   policy_management/index
+   rule_management/index
+   certificate_management/index
+   dashboard/index
+   event_management/index

api-ref/source/apis/managing_websites_protected_in_dedicated_mode/index.rst

@@ -0,0 +1,22 @@
+:original_name: topic_300000001.html
+
+.. _topic_300000001:
+
+Managing Websites Protected in Dedicated Mode
+=============================================
+
+-  :ref:`Adding a Protected Domain Name <createpremiumhost>`
+-  :ref:`Querying Domain Names Protected by Dedicated WAF Engines <listpremiumhost>`
+-  :ref:`Querying Domain Name Settings in Dedicated Mode <showpremiumhost>`
+-  :ref:`Modifying a Domain Name Protected by a Dedicated WAF Instance <updatepremiumhost>`
+-  :ref:`Deleting a Domain Name from a Dedicated WAF Instance <deletepremiumhost>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   adding_a_protected_domain_name
+   querying_domain_names_protected_by_dedicated_waf_engines
+   querying_domain_name_settings_in_dedicated_mode
+   modifying_a_domain_name_protected_by_a_dedicated_waf_instance
+   deleting_a_domain_name_from_a_dedicated_waf_instance

api-ref/source/apis/policy_management/index.rst

@@ -0,0 +1,22 @@
+:original_name: topic_300000002.html
+
+.. _topic_300000002:
+
+Policy Management
+=================
+
+-  :ref:`Querying Protection Policies <listpolicy>`
+-  :ref:`Creating a Policy <createpolicy>`
+-  :ref:`Querying a Policy by ID <showpolicy>`
+-  :ref:`Updating a Policy <updatepolicy>`
+-  :ref:`Deleting a Policy <deletepolicy>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_protection_policies
+   creating_a_policy
+   querying_a_policy_by_id
+   updating_a_policy
+   deleting_a_policy