ocket8888 commented on code in PR #7315:
URL: https://github.com/apache/trafficcontrol/pull/7315#discussion_r1088107909
##########
docs/source/api/v4/cdn_locks.rst:
##########
@@ -214,3 +214,13 @@ Response Structure
],
"lastUpdated": "2021-05-26T10:59:10-06"
}}
+
+Response Structure
+-----------------
+:HTTPstatuscode: This would typically be a 204 No Content for a successful
deletion, or a 4xx status code (such as 400 Bad Request, 401 Unauthorized, or
403 Forbidden) if the deletion was not successful.
+:Message: This would provide additional information about the outcome of the
request. For example, it may include an error message if the request failed, or
a success message if the lock was deleted.
+:Additionaldata: Depending on the specific implementation of the API, the
response object may include additional data such as the ID of the deleted lock,
the timestamp of when the lock was deleted, or other information relevant to
the request.
+
Review Comment:
Thank you for your contribution, but this section is not correct. It should
be a a listing of the fields of the `response` property of the JSON object in
the server's response body, just like those that appear under the "Response
Structure" of the other methods for this endpoint.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
