ocket8888 commented on code in PR #7224:
URL: https://github.com/apache/trafficcontrol/pull/7224#discussion_r1036398114


##########
docs/source/api/v3/deliveryservices_required_capabilities.rst:
##########
@@ -19,6 +19,8 @@
 ``deliveryservices_required_capabilities``
 ******************************************
 
+.. deprecated:: ATCv7

Review Comment:
   A few notes on these deprecation notices
   
   - all of APIv3 is deprecated, so it's superfluous to note that for any 
specific endpoint/method thereof
   - If an entire endpoint is being deprecated, you don't also need to 
individually deprecate each request method it supports
   - Generally you want to specify the _API_ version that something was 
deprecated, unless it's not possible to do that for some reason or it just 
makes more sense to list the ATC version instead.
   - Ideally the notice will come with some information about why it's being 
deprecated and/or what to use instead. This makes generating changelogs using 
Sphinx much more useful.



-- 
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]

Reply via email to