You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by "Kasambx (via GitHub)" <gi...@apache.org> on 2023/01/26 10:09:31 UTC
[GitHub] [trafficcontrol] Kasambx opened a new pull request, #7315: update CDN API v4 Locks documentation missing response structure #7312
Kasambx opened a new pull request, #7315:
URL: https://github.com/apache/trafficcontrol/pull/7315
<!--
Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
If this closes or relates to an existing issue, please reference it using one of the following:
Closes: #ISSUE #7312
Related: #ISSUE
the following pull request provides some context for the deletion request of the API v4
<!-- **^ Add meaningful description above** --><hr/>
-->
- Documentation
- the following pull request provides some context for the deletion request of the API v4
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update API v4 cdn_locks documentation to include currently missing response structure [trafficcontrol]
Posted by "mitchell852 (via GitHub)" <gi...@apache.org>.
mitchell852 commented on PR #7315:
URL: https://github.com/apache/trafficcontrol/pull/7315#issuecomment-1830843000
@Kasambx - are you able to make the requested change?
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update API v4 cdn_locks documentation to include currently missing response structure [trafficcontrol]
Posted by "ocket8888 (via GitHub)" <gi...@apache.org>.
ocket8888 closed pull request #7315: Update API v4 cdn_locks documentation to include currently missing response structure
URL: https://github.com/apache/trafficcontrol/pull/7315
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update API v4 cdn_locks documentation to include currently missing response structure [trafficcontrol]
Posted by "ocket8888 (via GitHub)" <gi...@apache.org>.
ocket8888 commented on PR #7315:
URL: https://github.com/apache/trafficcontrol/pull/7315#issuecomment-1969882916
After a full year without activity, I'm closing this.
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on a diff in pull request #7315: Update API v4 cdn_locks documentation to include currently missing response structure
Posted by "ocket8888 (via GitHub)" <gi...@apache.org>.
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org