Skip to content

Commit d557343

Browse files
author
Juliana Cardozo
committed
add doc for PATCH netv4/netv6
1 parent 503a095 commit d557343

4 files changed

Lines changed: 76 additions & 0 deletions

File tree

docs/networkv4/url-api-v3-networkv4.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
url-api-v3-networkv4/post
77
url-api-v3-networkv4/put
88
url-api-v3-networkv4/delete
9+
url-api-v3-networkv4/patch
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
PATCH
2+
#####
3+
4+
.. _url-api-v3-networkv4-patch-partially-update-list-networkv4:
5+
6+
Partially updating list of Networkv4 in database
7+
************************************************
8+
9+
URL::
10+
11+
/api/v3/networkv4/force/
12+
13+
Request body:
14+
15+
.. code-block:: json
16+
17+
{
18+
"networks": [{
19+
"id": [integer],
20+
"active": [boolean]
21+
},..]
22+
}
23+
24+
Request Example:
25+
26+
.. code-block:: json
27+
28+
{
29+
"networks": [{
30+
"id": 1,
31+
"active": false
32+
}]
33+
}
34+
35+
In Networkv4 PATCH request, you only need to specify the fields you want to change. For now, only **active** field can be changed.
36+
37+
* **active** - If not specified, Networkv4 will be the same as before. If specified, it will be updated with the new value.

docs/networkv6/url-api-v3-networkv6.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
url-api-v3-networkv6/post
77
url-api-v3-networkv6/put
88
url-api-v3-networkv6/delete
9+
url-api-v3-networkv6/patch
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
PATCH
2+
#####
3+
4+
.. _url-api-v3-networkv6-patch-partially-update-list-networkv6:
5+
6+
Partially updating list of Networkv6 in database
7+
************************************************
8+
9+
URL::
10+
11+
/api/v3/networkv6/force/
12+
13+
Request body:
14+
15+
.. code-block:: json
16+
17+
{
18+
"networks": [{
19+
"id": [integer],
20+
"active": [boolean]
21+
},..]
22+
}
23+
24+
Request Example:
25+
26+
.. code-block:: json
27+
28+
{
29+
"networks": [{
30+
"id": 1,
31+
"active": false
32+
}]
33+
}
34+
35+
In Networkv6 PATCH request, you only need to specify the fields you want to change. For now, only **active** field can be changed.
36+
37+
* **active** - If not specified, Networkv6 will be the same as before. If specified, it will be updated with the new value.

0 commit comments

Comments
 (0)