A200161411/web-application-firewall-dedicated
1
0
Fork 0
forked from docs/web-application-firewall-dedicated
Code Pull Requests Activity

Compare commits

base: A200161411:propose-wafd_api-ref-588
Branches Tags
A200161411:main
A200161411:minify_sphinx_gitea
A200161411:propose-wafd_best-practice-948
A200161411:propose-wafd_best-practice-809
A200161411:propose-wafd_umn-945
A200161411:propose-wafd_best-practice-928
A200161411:propose-wafd_umn-834
A200161411:propose-wafd_api-ref-834
A200161411:propose-wafd_umn-833
A200161411:propose-wafd_best-practice-833
A200161411:propose-wafd_api-ref-833
A200161411:constraints
A200161411:sbv_update
A200161411:confpy
A200161411:propose-wafd_api-ref-778
A200161411:propose-wafd_umn-769
A200161411:propose-wafd_api-ref-769
A200161411:propose-wafd_api-ref-776
A200161411:propose-wafd_api-ref-588
A200161411:propose-wafd_umn-773
A200161411:service_based_view
A200161411:propose-wafd_umn-694
A200161411:propose-wafd_umn-569
A200161411:propose-wafd_api-ref-569
A200161411:tox4-cleanup
A200161411:tox4
A200161411:x4
A200161411:propose-wafd_api-ref-471
A200161411:propose-wafd_umn-472
A200161411:propose-wafd_umn-451
A200161411:propose-wafd_api-ref-451
A200161411:propose-wafd_umn-449
A200161411:propose-wafd_api-ref-449
A200161411:x2
A200161411:propose-wafd_umn-412
A200161411:propose-wafd_api-ref-412
A200161411:confpy-2
..
compare: A200161411:main
Branches Tags
A200161411:main
A200161411:minify_sphinx_gitea
A200161411:propose-wafd_best-practice-948
A200161411:propose-wafd_best-practice-809
A200161411:propose-wafd_umn-945
A200161411:propose-wafd_best-practice-928
A200161411:propose-wafd_umn-834
A200161411:propose-wafd_api-ref-834
A200161411:propose-wafd_umn-833
A200161411:propose-wafd_best-practice-833
A200161411:propose-wafd_api-ref-833
A200161411:constraints
A200161411:sbv_update
A200161411:confpy
A200161411:propose-wafd_api-ref-778
A200161411:propose-wafd_umn-769
A200161411:propose-wafd_api-ref-769
A200161411:propose-wafd_api-ref-776
A200161411:propose-wafd_api-ref-588
A200161411:propose-wafd_umn-773
A200161411:service_based_view
A200161411:propose-wafd_umn-694
A200161411:propose-wafd_umn-569
A200161411:propose-wafd_api-ref-569
A200161411:tox4-cleanup
A200161411:tox4
A200161411:x4
A200161411:propose-wafd_api-ref-471
A200161411:propose-wafd_umn-472
A200161411:propose-wafd_umn-451
A200161411:propose-wafd_api-ref-451
A200161411:propose-wafd_umn-449
A200161411:propose-wafd_api-ref-449
A200161411:x2
A200161411:propose-wafd_umn-412
A200161411:propose-wafd_api-ref-412
A200161411:confpy-2

8 Commits
propose-wa ... main

Author SHA1 Message Date
Gode, Sebastian
ccad9617d3 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:47:45 +00:00
proposalbot
bad4eefb1a Changes to wafd_best-practice from docs/doc-exports#928 (adding best practice do 
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-23 23:34:34 +00:00
Hasko, Vladimir
1bc7ad86dd fix sphinx problems with constraints 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-08-10 16:24:34 +00:00
Hasko, Vladimir
03dfa28ad9 adding description for best practice 
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-07-18 08:08:25 +00:00
Hasko, Vladimir
ead72230ce Update tox.ini && conf.py file 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-07-17 18:38:45 +00:00
proposalbot
3a15b1ebd8 Changes to wafd_api-ref from docs/doc-exports#769 (chore: use convertor from sep 
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-06-03 08:14:37 +00:00
proposalbot
d0437f6afb Changes to wafd_umn from docs/doc-exports#769 (chore: use convertor from separat 
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-06-03 07:57:40 +00:00
proposalbot
c25c20bac6 Changes to wafd_api-ref from docs/doc-exports#776 (re-introducing changes before 
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-06-02 12:28:18 +00:00
28 changed files with 391 additions and 230 deletions
Show Stats Expand all files Collapse all files

4
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst
View File

@ -134,6 +134,8 @@ Response Parameters
+-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protect_status | Integer | WAF status of the protected domain name. | | protect_status | Integer | WAF status of the protected domain name. |
| | | | | | | |
| | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. |
| | | |
| | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy. | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy. |
+-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| access_status | Integer | Whether a domain name is connected to WAF. | | access_status | Integer | Whether a domain name is connected to WAF. |
@ -324,7 +326,7 @@ Example Requests
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/premium-waf/host? POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0
{ {
"hostname" : "www.demo.com", "hostname" : "www.demo.com",

2
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst
View File

@ -68,6 +68,8 @@ Response Parameters
+-----------------------+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| protect_status | Integer | WAF status of the protected domain name. The value can be: | | protect_status | Integer | WAF status of the protected domain name. The value can be: |
| | | | | | | |
| | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. |
| | | |
| | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. |
| | | | | | | |
| | | - 1: Enabled. WAF detects attacks based on the configured policy. | | | | - 1: Enabled. WAF detects attacks based on the configured policy. |

120
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst
View File

@ -94,6 +94,8 @@ Response Parameters
+-----------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protect_status | Integer | WAF status of the protected domain name. The value can be: | | protect_status | Integer | WAF status of the protected domain name. The value can be: |
| | | | | | | |
| | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. |
| | | |
| | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. |
| | | | | | | |
| | | - 1: Enabled. WAF detects attacks based on the configured policy. | | | | - 1: Enabled. WAF detects attacks based on the configured policy. |

2
api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst
View File

@ -45,7 +45,7 @@ Request Parameters
+--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+====================+=================+=================+============================================================================================================================================================================================================+ +====================+=================+=================+============================================================================================================================================================================================================+
| name | Yes | String | Rule name. | | name | No | String | Rule name. |
+--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Rule description. | | description | No | String | Rule description. |
+--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

8
api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst
View File

@ -73,9 +73,7 @@ Request Parameters
| | | | | | | | | |
| | | | - Israel: Israel | | | | | - Israel: Israel |
| | | | | | | | | |
| | | | - Iraq: Iraq | | | | | - Iraq: Afghanistan |
| | | | |
| | | | - Afghanistan: Afghanistan |
| | | | | | | | | |
| | | | - Libya: Libya | | | | | - Libya: Libya |
| | | | | | | | | |
@ -152,9 +150,7 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Iraq | | | | - Iraq: Afghanistan |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |

6
api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst
View File

@ -88,9 +88,7 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Iraq | | | | - Iraq: Afghanistan |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |
@ -165,7 +163,7 @@ Example Requests
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}? DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0
Example Responses Example Responses
----------------- -----------------

2
api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst
View File

@ -45,7 +45,7 @@ Request Parameters
+=================+=================+=================+==============================================================================================================+ +=================+=================+=================+==============================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). | | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+
| Content-Type | No | String | Content type. | | Content-Type | Yes | String | Content type. |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

12
api-ref/source/apis/rule_management/deleting_a_reference_table.rst
View File

@ -13,17 +13,17 @@ This API is used to delete a reference table.
URI URI
--- ---
DELETE /v1/{project_id}/waf/valuelist/{valuelist_id} DELETE /v1/{project_id}/waf/valuelist/{table_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+==============+===========+========+=======================================================================================+ +============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID | | project_id | Yes | String | Project ID |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
| valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List | | table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

4
api-ref/source/apis/rule_management/index.rst
View File

@ -58,7 +58,7 @@ Rule Management
- :ref:`Deleting a Geolocation Access Control Rule <deletegeoiprule>` - :ref:`Deleting a Geolocation Access Control Rule <deletegeoiprule>`
- :ref:`Querying the Reference Table List <listvaluelist>` - :ref:`Querying the Reference Table List <listvaluelist>`
- :ref:`Creating a Reference Table <createvaluelist>` - :ref:`Creating a Reference Table <createvaluelist>`
- :ref:`Querying a Reference Table <showvaluelist>` - :ref:`Querying a Reference Table by ID <showvaluelist>`
- :ref:`Modifying a Reference Table <updatevaluelist>` - :ref:`Modifying a Reference Table <updatevaluelist>`
- :ref:`Deleting a Reference Table <deletevaluelist>` - :ref:`Deleting a Reference Table <deletevaluelist>`
@ -119,6 +119,6 @@ Rule Management
deleting_a_geolocation_access_control_rule deleting_a_geolocation_access_control_rule
querying_the_reference_table_list querying_the_reference_table_list
creating_a_reference_table creating_a_reference_table
querying_a_reference_table querying_a_reference_table_by_id
modifying_a_reference_table modifying_a_reference_table
deleting_a_reference_table deleting_a_reference_table

12
api-ref/source/apis/rule_management/modifying_a_reference_table.rst
View File

@ -13,17 +13,17 @@ This API is used to modify a reference table.
URI URI
--- ---
PUT /v1/{project_id}/waf/valuelist/{valuelist_id} PUT /v1/{project_id}/waf/valuelist/{table_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+==============+===========+========+=======================================================================================+ +============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID | | project_id | Yes | String | Project ID |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
| valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List | | table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

6
api-ref/source/apis/rule_management/querying_a_geolocation_access_control_rule_by_id.rst
View File

@ -37,7 +37,7 @@ Request Parameters
+=================+=================+=================+============================================+ +=================+=================+=================+============================================+
| X-Auth-Token | Yes | String | User token | | X-Auth-Token | Yes | String | User token |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
| Content-Type | No | String | Content type | | Content-Type | Yes | String | Content type |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
@ -88,9 +88,7 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Iraq | | | | - Iraq: Afghanistan |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |

2
api-ref/source/apis/rule_management/querying_a_javascript_anti-crawler_rule.rst
View File

@ -45,7 +45,7 @@ Request Parameters
+=================+=================+=================+==============================================================================================================+ +=================+=================+=================+==============================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). | | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+
| Content-Type | No | String | Content type. | | Content-Type | Yes | String | Content type. |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

18
api-ref/source/apis/rule_management/querying_a_reference_table.rst → api-ref/source/apis/rule_management/querying_a_reference_table_by_id.rst
View File

@ -2,28 +2,28 @@
.. _ShowValueList: .. _ShowValueList:
Querying a Reference Table Querying a Reference Table by ID
========================== ================================
Function Function
-------- --------
This API is used to query a reference table. This API is used to query a reference table by ID.
URI URI
--- ---
GET /v1/{project_id}/waf/valuelist/{valuelist_id} GET /v1/{project_id}/waf/valuelist/{table_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+==============+===========+========+=======================================================================================+ +============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID | | project_id | Yes | String | Project ID |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
| valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List | | table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+ +------------+-----------+--------+---------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

2
api-ref/source/apis/rule_management/querying_the_javascript_anti-crawler_rule_list.rst
View File

@ -53,7 +53,7 @@ Request Parameters
+=================+=================+=================+==============================================================================================================+ +=================+=================+=================+==============================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). | | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+
| Content-Type | No | String | Content type. | | Content-Type | Yes | String | Content type. |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

4
api-ref/source/apis/rule_management/querying_the_list_of_geolocation_access_control_rules.rst
View File

@ -112,9 +112,7 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Iraq | | | | - Iraq: Afghanistan |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |

8
api-ref/source/apis/rule_management/updating_a_geolocation_access_control_rule.rst
View File

@ -75,9 +75,7 @@ Request Parameters
| | | | | | | | | |
| | | | - Israel: Israel | | | | | - Israel: Israel |
| | | | | | | | | |
| | | | - Iraq: Iraq | | | | | - Iraq: Afghanistan |
| | | | |
| | | | - Afghanistan: Afghanistan |
| | | | | | | | | |
| | | | - Libya: Libya | | | | | - Libya: Libya |
| | | | | | | | | |
@ -154,9 +152,7 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Iraq | | | | - Iraq: Afghanistan |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |

2
api-ref/source/change_history.rst
View File

@ -8,8 +8,6 @@ Change History
+-----------------------------------+----------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+====================================================================================================+ +===================================+====================================================================================================+
| 2023-04-23 | Revised the document based on review comments. |
+-----------------------------------+----------------------------------------------------------------------------------------------------+
| 2023-03-30 | - Added "Geographical Location Codes." | | 2023-03-30 | - Added "Geographical Location Codes." |
| | - Revised the document based on review comments. | | | - Revised the document based on review comments. |
+-----------------------------------+----------------------------------------------------------------------------------------------------+ +-----------------------------------+----------------------------------------------------------------------------------------------------+

13
api-ref/source/conf.py
View File

@ -18,7 +18,7 @@ import os
import sys import sys
extensions = [ extensions = [
'otcdocstheme' 'otcdocstheme',
] ]
otcdocs_auto_name = False otcdocs_auto_name = False
@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/web-application-firewall-dedicated'
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 = 'internal'
otcdocs_doc_link = '/web-application-firewall-dedicated/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'security-services'
otcdocs_service_title = 'Dedicated Web Application Firewall'
otcdocs_service_type = 'wafd'
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.

0
doc/best-practice/source/_static/.placeholder Normal file
View File

117
doc/best-practice/source/conf.py Normal file
View File

File diff suppressed because it is too large Load Diff

2
doc/best-practice/source/docutils.conf Normal file
View File

@ -0,0 +1,2 @@
[html writers]
table-style: table, caption-top

4
doc/best-practice/source/index.rst Normal file
View File

@ -0,0 +1,4 @@
==================================================
Dedicated Web Application Firewall - Best Practice
==================================================

3
doc/requirements.txt
View File

@ -1,7 +1,10 @@
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

11
doc/source/conf.py
View File

@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/web-application-firewall-dedicated'
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 = 'security-services'
otcdocs_service_title = 'Dedicated Web Application Firewall'
otcdocs_service_type = 'wafd'
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.

2
doc/source/index.rst
View File

@ -8,6 +8,8 @@ Web Application Firewall (WAF) keeps web services stable and secure. It examines
:class: container-sbv :class: container-sbv
.. service_card:: .. service_card::
:environment: internal
:service_type: wafd :service_type: wafd
:umn: This document helps you know about the Web Application Firewall (Dedicated) and guide you on how to use the service. :umn: This document helps you know about the Web Application Firewall (Dedicated) and guide you on how to use the service.
:api-ref: This document describes application programming interfaces (APIs) of the Web Application Firewall (Dedicated) and provides API parameter description and example values. :api-ref: This document describes application programming interfaces (APIs) of the Web Application Firewall (Dedicated) and provides API parameter description and example values.
:best-practice: To use Web Application Firewall (Dedicated) more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.

166
tox.ini
View File

File diff suppressed because it is too large Load Diff

13
umn/source/conf.py
View File

@ -18,7 +18,7 @@ import os
import sys import sys
extensions = [ extensions = [
'otcdocstheme' 'otcdocstheme',
] ]
otcdocs_auto_name = False otcdocs_auto_name = False
@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/web-application-firewall-dedicated'
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 = 'internal'
otcdocs_doc_link = '/web-application-firewall-dedicated/umn/'
otcdocs_doc_title = 'User Guide'
otcdocs_doc_type = 'umn'
otcdocs_service_category = 'security-services'
otcdocs_service_title = 'Dedicated Web Application Firewall'
otcdocs_service_type = 'wafd'
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.