[GitHub] ocket8888 commented on a change in pull request #3284: Update API Documentation with CacheURL deprecation

[GitBox <gi...@apache.org>]

ocket8888 commented on a change in pull request #3284: Update API Documentation with CacheURL deprecation
URL: https://github.com/apache/trafficcontrol/pull/3284#discussion_r252409147
 
 

 ##########
 File path: docs/source/api/servers_id_deliveryservices.rst
 ##########
 @@ -50,7 +50,7 @@ Response Structure
 ------------------
 :active:                   ``true`` if the Delivery Service is active, ``false`` otherwise
 :anonymousBlockingEnabled: ``true`` if :ref:`Anonymous Blocking <anonymous_blocking-qht>` has been configured for the Delivery Service, ``false`` otherwise
-:cacheurl:                 A setting for a deprecated feature of now-unsupported Trafficserver versions
+:cacheurl:                 Deprecated. A setting for a deprecated feature of now-unsupported Trafficserver versions
 
 Review comment:
   You should use the `deprecated` directive. It would look like this:
   
   ```rst
   :cacheurl:                 A setting for a deprecated feature of now-unsupported Trafficserver versions
   
       .. deprecated:: 3.0
           This field is deprecated as of Traffic Control 3.0, and will be removed in version 4.0
   
   :ccrDnsTtl:                The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP 
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services