From 670f83b0de1359dd301dd65ac2c2571f9d3ee193 Mon Sep 17 00:00:00 2001 From: Brian Haley Date: Fri, 3 Sep 2021 14:28:50 -0400 Subject: [PATCH] Fix some api-ref typos 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 --- api-ref/source/v2/bfd_monitors.inc | 5 +---- api-ref/source/v2/bgp_peer.inc | 2 +- api-ref/source/v2/bgp_speaker.inc | 2 +- api-ref/source/v2/firewall_log.inc | 4 ++-- api-ref/source/v2/logging_resource.inc | 4 ++-- api-ref/source/v2/qos.inc | 30 ++++++-------------------- 6 files changed, 13 insertions(+), 34 deletions(-) diff --git a/api-ref/source/v2/bfd_monitors.inc b/api-ref/source/v2/bfd_monitors.inc index 1778cd869..2d5ca3054 100644 --- a/api-ref/source/v2/bfd_monitors.inc +++ b/api-ref/source/v2/bfd_monitors.inc @@ -173,10 +173,7 @@ Update BFD monitor Updates a BFD monitor. -If the request is valid, the service returns the ``Accepted (202)`` -response code. - -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404, 412 diff --git a/api-ref/source/v2/bgp_peer.inc b/api-ref/source/v2/bgp_peer.inc index 5a9ac374c..372642dcd 100644 --- a/api-ref/source/v2/bgp_peer.inc +++ b/api-ref/source/v2/bgp_peer.inc @@ -145,7 +145,7 @@ Update a BGP Peer Update a specific BGP Peer. -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404, 41 diff --git a/api-ref/source/v2/bgp_speaker.inc b/api-ref/source/v2/bgp_speaker.inc index ac13a57d8..0533f7d17 100644 --- a/api-ref/source/v2/bgp_speaker.inc +++ b/api-ref/source/v2/bgp_speaker.inc @@ -169,7 +169,7 @@ Update a BGP Speaker Issue ``PUT`` request to ``/v2.0/bgp-speakers/`` to update a specific BGP Speaker. Following attributes can be updated. -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404, 41 diff --git a/api-ref/source/v2/firewall_log.inc b/api-ref/source/v2/firewall_log.inc index c1dbd4d94..e4d0c068e 100644 --- a/api-ref/source/v2/firewall_log.inc +++ b/api-ref/source/v2/firewall_log.inc @@ -60,7 +60,7 @@ Create Firewall Log Creates a firewall log. -Normal response codes: 200 +Normal response codes: 201 Error response codes: 400, 401, 403 @@ -204,7 +204,7 @@ Delete Firewall Log Deletes a firewall log. -Normal response codes: 202 +Normal response codes: 204 Error response codes: 400, 401, 403, 404 diff --git a/api-ref/source/v2/logging_resource.inc b/api-ref/source/v2/logging_resource.inc index 7a7230247..5e8fff4e4 100644 --- a/api-ref/source/v2/logging_resource.inc +++ b/api-ref/source/v2/logging_resource.inc @@ -59,7 +59,7 @@ Create Logging Resource Creates a logging resource. -Normal response codes: 200 +Normal response codes: 201 Error response codes: 400, 401, 403 @@ -201,7 +201,7 @@ Delete Logging Resource Deletes a logging resource. -Normal response codes: 202 +Normal response codes: 204 Error response codes: 400, 401, 403, 404 diff --git a/api-ref/source/v2/qos.inc b/api-ref/source/v2/qos.inc index d5a98efa4..6c72d7947 100644 --- a/api-ref/source/v2/qos.inc +++ b/api-ref/source/v2/qos.inc @@ -292,10 +292,7 @@ Update QoS policy Updates a QoS policy. -If the request is valid, the service returns the ``Accepted (202)`` -response code. - -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404, 412 @@ -512,10 +509,7 @@ Update bandwidth limit rule Updates a bandwidth limit rule for a QoS policy. -If the request is valid, the service returns the ``Accepted (202)`` -response code. - -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404 @@ -709,10 +703,7 @@ Update DSCP marking rule Updates a DSCP marking rule for a QoS policy. -If the request is valid, the service returns the ``Accepted (202)`` -response code. - -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404 @@ -913,13 +904,10 @@ Update minimum bandwidth rule 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 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 @@ -1123,13 +1111,10 @@ Update minimum packet rate rule 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 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 @@ -1337,10 +1322,7 @@ Update packet rate limit rule Updates a packet rate limit rule for a QoS policy. -If the request is valid, the service returns the ``Accepted (202)`` -response code. - -Normal response codes: 202 +Normal response codes: 200 Error response codes: 400, 401, 404