openstack/neutron-lib
Code Issues Proposed changes

Fix some api-ref typos

Browse Source 
There were some places in the API ref that it shows a 202 is
returned on Update, but we always return a 200 (HTTPOk).
Fixed a few other cases where Create (should be 201) and
Delete (should be 204) were wrong as well.

Change-Id: I4f6eb742f4420d0844e9c254ce989fc62973b0cf
Closes-bug: #1942448
This commit is contained in:
Brian Haley 2021-09-03 14:28:50 -04:00
parent 5e9ced2793
commit 670f83b0de
6 changed files with 13 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api-ref/source/v2/bfd_monitors.inc
View File

@ -173,10 +173,7 @@ Update BFD monitor
Updates a BFD monitor. Updates a BFD monitor.
If the request is valid, the service returns the ``Accepted (202)`` Normal response codes: 200
response code.
Normal response codes: 202
Error response codes: 400, 401, 404, 412 Error response codes: 400, 401, 404, 412

2
api-ref/source/v2/bgp_peer.inc
View File

@ -145,7 +145,7 @@ Update a BGP Peer
Update a specific BGP Peer. Update a specific BGP Peer.
Normal response codes: 202 Normal response codes: 200
Error response codes: 400, 401, 404, 41 Error response codes: 400, 401, 404, 41

2
api-ref/source/v2/bgp_speaker.inc
View File

@ -169,7 +169,7 @@ Update a BGP Speaker
Issue ``PUT`` request to ``/v2.0/bgp-speakers/<bgp-speaker-id>`` to update a Issue ``PUT`` request to ``/v2.0/bgp-speakers/<bgp-speaker-id>`` to update a
specific BGP Speaker. Following attributes can be updated. specific BGP Speaker. Following attributes can be updated.
Normal response codes: 202 Normal response codes: 200
Error response codes: 400, 401, 404, 41 Error response codes: 400, 401, 404, 41

4
api-ref/source/v2/firewall_log.inc
View File

@ -60,7 +60,7 @@ Create Firewall Log
Creates a firewall log. Creates a firewall log.
Normal response codes: 200 Normal response codes: 201
Error response codes: 400, 401, 403 Error response codes: 400, 401, 403
@ -204,7 +204,7 @@ Delete Firewall Log
Deletes a firewall log. Deletes a firewall log.
Normal response codes: 202 Normal response codes: 204
Error response codes: 400, 401, 403, 404 Error response codes: 400, 401, 403, 404

4
api-ref/source/v2/logging_resource.inc
View File

@ -59,7 +59,7 @@ Create Logging Resource
Creates a logging resource. Creates a logging resource.
Normal response codes: 200 Normal response codes: 201
Error response codes: 400, 401, 403 Error response codes: 400, 401, 403
@ -201,7 +201,7 @@ Delete Logging Resource
Deletes a logging resource. Deletes a logging resource.
Normal response codes: 202 Normal response codes: 204
Error response codes: 400, 401, 403, 404 Error response codes: 400, 401, 403, 404

30
api-ref/source/v2/qos.inc
View File

@ -292,10 +292,7 @@ Update QoS policy
Updates a QoS policy. Updates a QoS policy.
If the request is valid, the service returns the ``Accepted (202)`` Normal response codes: 200
response code.
Normal response codes: 202
Error response codes: 400, 401, 404, 412 Error response codes: 400, 401, 404, 412
@ -512,10 +509,7 @@ Update bandwidth limit rule
Updates a bandwidth limit rule for a QoS policy. Updates a bandwidth limit rule for a QoS policy.
If the request is valid, the service returns the ``Accepted (202)`` Normal response codes: 200
response code.
Normal response codes: 202
Error response codes: 400, 401, 404 Error response codes: 400, 401, 404
@ -709,10 +703,7 @@ Update DSCP marking rule
Updates a DSCP marking rule for a QoS policy. Updates a DSCP marking rule for a QoS policy.
If the request is valid, the service returns the ``Accepted (202)`` Normal response codes: 200
response code.
Normal response codes: 202
Error response codes: 400, 401, 404 Error response codes: 400, 401, 404
@ -913,13 +904,10 @@ Update minimum bandwidth rule
Updates a minimum bandwidth rule for a QoS policy. Updates a minimum bandwidth rule for a QoS policy.
If the request is valid, the service returns the ``Accepted (202)``
response code.
Note that the rule cannot be updated, and the update is rejected with error Note that the rule cannot be updated, and the update is rejected with error
code 501, if there is any bound port referring to the rule via the qos policy. code 501, if there is any bound port referring to the rule via the qos policy.
Normal response codes: 202 Normal response codes: 200
Error response codes: 400, 401, 404, 501 Error response codes: 400, 401, 404, 501
@ -1123,13 +1111,10 @@ Update minimum packet rate rule
Updates a minimum packet rate rule for a QoS policy. Updates a minimum packet rate rule for a QoS policy.
If the request is valid, the service returns the ``Accepted (202)``
response code.
Note that the rule cannot be updated, and the update is rejected with error Note that the rule cannot be updated, and the update is rejected with error
code 501, if there is any bound port referring to the rule via the qos policy. code 501, if there is any bound port referring to the rule via the qos policy.
Normal response codes: 202 Normal response codes: 200
Error response codes: 400, 401, 404, 409, 501 Error response codes: 400, 401, 404, 409, 501
@ -1337,10 +1322,7 @@ Update packet rate limit rule
Updates a packet rate limit rule for a QoS policy. Updates a packet rate limit rule for a QoS policy.
If the request is valid, the service returns the ``Accepted (202)`` Normal response codes: 200
response code.
Normal response codes: 202
Error response codes: 400, 401, 404 Error response codes: 400, 401, 404