diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..67acc6d41 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "2.7" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: requirements_docs.txt diff --git a/docs/networkv4/url-api-v3-networkv4.rst b/docs/networkv4/url-api-v3-networkv4.rst index 405f2cfa7..aa2eb9343 100644 --- a/docs/networkv4/url-api-v3-networkv4.rst +++ b/docs/networkv4/url-api-v3-networkv4.rst @@ -6,3 +6,4 @@ url-api-v3-networkv4/post url-api-v3-networkv4/put url-api-v3-networkv4/delete + url-api-v3-networkv4/patch diff --git a/docs/networkv4/url-api-v3-networkv4/patch.rst b/docs/networkv4/url-api-v3-networkv4/patch.rst new file mode 100644 index 000000000..5f6189aff --- /dev/null +++ b/docs/networkv4/url-api-v3-networkv4/patch.rst @@ -0,0 +1,37 @@ +PATCH +##### + +.. _url-api-v3-networkv4-patch-partially-update-list-networkv4: + +Partially updating list of Networkv4 in database +************************************************ + +URL:: + + /api/v3/networkv4/force/ + +Request body: + +.. code-block:: json + + { + "networks": [{ + "id": [integer], + "active": [boolean] + },..] + } + +Request Example: + +.. code-block:: json + + { + "networks": [{ + "id": 1, + "active": false + }] + } + +In Networkv4 PATCH request, you only need to specify the fields you want to change. For now, only **active** field can be changed. + +* **active** - If not specified, Networkv4 will be the same as before. If specified, it will be updated with the new value. diff --git a/docs/networkv6/url-api-v3-networkv6.rst b/docs/networkv6/url-api-v3-networkv6.rst index 60fbbd2f1..75f906880 100644 --- a/docs/networkv6/url-api-v3-networkv6.rst +++ b/docs/networkv6/url-api-v3-networkv6.rst @@ -6,3 +6,4 @@ url-api-v3-networkv6/post url-api-v3-networkv6/put url-api-v3-networkv6/delete + url-api-v3-networkv6/patch diff --git a/docs/networkv6/url-api-v3-networkv6/patch.rst b/docs/networkv6/url-api-v3-networkv6/patch.rst new file mode 100644 index 000000000..f3430cb4d --- /dev/null +++ b/docs/networkv6/url-api-v3-networkv6/patch.rst @@ -0,0 +1,37 @@ +PATCH +##### + +.. _url-api-v3-networkv6-patch-partially-update-list-networkv6: + +Partially updating list of Networkv6 in database +************************************************ + +URL:: + + /api/v3/networkv6/force/ + +Request body: + +.. code-block:: json + + { + "networks": [{ + "id": [integer], + "active": [boolean] + },..] + } + +Request Example: + +.. code-block:: json + + { + "networks": [{ + "id": 1, + "active": false + }] + } + +In Networkv6 PATCH request, you only need to specify the fields you want to change. For now, only **active** field can be changed. + +* **active** - If not specified, Networkv6 will be the same as before. If specified, it will be updated with the new value.