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

Compare commits

base: akyriako:main
Branches Tags
akyriako:main
akyriako:propose-wafd_best-practice-809
akyriako:sbv_update
akyriako:confpy
akyriako:propose-wafd_api-ref-778
akyriako:propose-wafd_umn-769
akyriako:propose-wafd_api-ref-769
akyriako:propose-wafd_api-ref-776
akyriako:propose-wafd_api-ref-588
akyriako:propose-wafd_umn-773
akyriako:service_based_view
akyriako:propose-wafd_umn-694
akyriako:propose-wafd_umn-569
akyriako:propose-wafd_api-ref-569
akyriako:tox4-cleanup
akyriako:tox4
akyriako:x4
akyriako:propose-wafd_api-ref-471
akyriako:propose-wafd_umn-472
akyriako:propose-wafd_umn-451
akyriako:propose-wafd_api-ref-451
akyriako:propose-wafd_umn-449
akyriako:propose-wafd_api-ref-449
akyriako:x2
akyriako:propose-wafd_umn-412
akyriako:propose-wafd_api-ref-412
akyriako:confpy-2
..
compare: akyriako:propose-wafd_api-ref-588
Branches Tags
akyriako:propose-wafd_best-practice-809
akyriako:main
akyriako:sbv_update
akyriako:confpy
akyriako:propose-wafd_api-ref-778
akyriako:propose-wafd_umn-769
akyriako:propose-wafd_api-ref-769
akyriako:propose-wafd_api-ref-776
akyriako:propose-wafd_api-ref-588
akyriako:propose-wafd_umn-773
akyriako:service_based_view
akyriako:propose-wafd_umn-694
akyriako:propose-wafd_umn-569
akyriako:propose-wafd_api-ref-569
akyriako:tox4-cleanup
akyriako:tox4
akyriako:x4
akyriako:propose-wafd_api-ref-471
akyriako:propose-wafd_umn-472
akyriako:propose-wafd_umn-451
akyriako:propose-wafd_api-ref-451
akyriako:propose-wafd_umn-449
akyriako:propose-wafd_api-ref-449
akyriako:x2
akyriako:propose-wafd_umn-412
akyriako:propose-wafd_api-ref-412
akyriako:confpy-2

1 Commits
main ... propose-wa

Author SHA1 Message Date
OpenTelekomCloud Proposal Bot
8c02ce68d2 Update content 2023-06-02 09:09:13 +00:00
26 changed files with 174 additions and 319 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,8 +134,6 @@ 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. |
@ -326,7 +324,7 @@ Example Requests
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0 POST https://{Endpoint}/v1/{project_id}/premium-waf/host?
{ {
"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,8 +68,6 @@ 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. |

180
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,8 +94,6 @@ 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 | No | String | Rule name. | | name | Yes | 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,7 +73,9 @@ Request Parameters
| | | | | | | | | |
| | | | - Israel: Israel | | | | | - Israel: Israel |
| | | | | | | | | |
| | | | - Iraq: Afghanistan | | | | | - Iraq: Iraq |
| | | | |
| | | | - Afghanistan: Afghanistan |
| | | | | | | | | |
| | | | - Libya: Libya | | | | | - Libya: Libya |
| | | | | | | | | |
@ -150,7 +152,9 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Afghanistan | | | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |

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

@ -88,7 +88,9 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Afghanistan | | | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |
@ -163,7 +165,7 @@ Example Requests
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0 DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?
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 | Yes | String | Content type. | | Content-Type | No | String | Content type. |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

16
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/{table_id} DELETE /v1/{project_id}/waf/valuelist/{valuelist_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 |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+ +--------------+-----------+--------+---------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List | | valuelist_id | Yes | String | Valuelist 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 by ID <showvaluelist>` - :ref:`Querying a Reference Table <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_by_id querying_a_reference_table
modifying_a_reference_table modifying_a_reference_table
deleting_a_reference_table deleting_a_reference_table

16
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/{table_id} PUT /v1/{project_id}/waf/valuelist/{valuelist_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 |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+ +--------------+-----------+--------+---------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List | | valuelist_id | Yes | String | Valuelist 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 | Yes | String | Content type | | Content-Type | No | String | Content type |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
@ -88,7 +88,9 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Afghanistan | | | | - Iraq: Iraq |
| | | |
| | | - 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 | Yes | String | Content type. | | Content-Type | No | String | Content type. |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

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

@ -2,28 +2,28 @@
.. _ShowValueList: .. _ShowValueList:
Querying a Reference Table by ID Querying a Reference Table
================================ ==========================
Function Function
-------- --------
This API is used to query a reference table by ID. This API is used to query a reference table.
URI URI
--- ---
GET /v1/{project_id}/waf/valuelist/{table_id} GET /v1/{project_id}/waf/valuelist/{valuelist_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 |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+ +--------------+-----------+--------+---------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List | | valuelist_id | Yes | String | Valuelist 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 | Yes | String | Content type. | | Content-Type | No | 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,7 +112,9 @@ Response Parameters
| | | | | | | |
| | | - Israel: Israel | | | | - Israel: Israel |
| | | | | | | |
| | | - Iraq: Afghanistan | | | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | | | | | |
| | | - Libya: Libya | | | | - Libya: Libya |
| | | | | | | |

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

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

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

@ -8,6 +8,8 @@ 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,17 +30,6 @@ 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
View File

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

File diff suppressed because it is too large Load Diff

3
doc/best-practice/source/index.rst
View File

@ -1,3 +0,0 @@
==================================================================
Welcome to the documentation of web-application-firewall-dedicated
==================================================================

11
doc/source/conf.py
View File

@ -31,17 +31,6 @@ 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 = ''
otcdocs_service_title = ''
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.

4
doc/source/index.rst
View File

@ -8,8 +8,6 @@ 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.

44
tox.ini
View File

@ -36,8 +36,6 @@ commands =
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
{[testenv:api-ref]commands} {[testenv:api-ref]commands}
{[testenv:json-api-ref]commands} {[testenv:json-api-ref]commands}
{[testenv:best-practice]commands}
{[testenv:json-best-practice]commands}
{[testenv:umn]commands} {[testenv:umn]commands}
{[testenv:json-umn]commands} {[testenv:json-umn]commands}
@ -52,7 +50,6 @@ allowlist_externals =
commands = commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
{[testenv:api-ref-pdf-docs]commands} {[testenv:api-ref-pdf-docs]commands}
{[testenv:best-practice-pdf-docs]commands}
{[testenv:umn-pdf-docs]commands} {[testenv:umn-pdf-docs]commands}
@ -101,47 +98,6 @@ commands =
cp api-ref/build/pdf/wafd-api-ref.pdf doc/build/pdf/ cp api-ref/build/pdf/wafd-api-ref.pdf doc/build/pdf/
# HTML version
[testenv:best-practice]
deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals =
cp
mkdir
commands =
sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html/best-practice
# Json version (for search)
[testenv:json-best-practice]
deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals =
cp
mkdir
sh
commands =
sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice
# Drop data useless for the search - wrap it also with sh/xargs due to bugs
# in tox
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
# PDF version
[testenv:best-practice-pdf-docs]
deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals =
rm
mkdir
make
bash
cp
commands =
rm -rf doc/best-practice/build/pdf
sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/
bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
make -C doc/best-practice/build/pdf
mkdir -p doc/build/pdf
cp doc/best-practice/build/pdf/wafd-best-practice.pdf doc/build/pdf/
# HTML version # HTML version
[testenv:umn] [testenv:umn]
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt

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,17 +30,6 @@ 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.