[GitHub] dneuman64 closed pull request #2258: Update traffic_router_api.rst

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

dneuman64 closed pull request #2258: Update traffic_router_api.rst
URL: https://github.com/apache/incubator-trafficcontrol/pull/2258
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/source/development/traffic_router/traffic_router_api.rst b/docs/source/development/traffic_router/traffic_router_api.rst
index 2ae902f63..f56ca2e10 100644
--- a/docs/source/development/traffic_router/traffic_router_api.rst
+++ b/docs/source/development/traffic_router/traffic_router_api.rst
@@ -15,6 +15,7 @@
 
 .. _reference-tr-api:
 
+
 Traffic Router API
 ==================
 
@@ -24,7 +25,7 @@ General stats.
 
 |
 
-**/crs/stats/ip/:ipaddress**
+**/crs/stats/ip/<ipaddress>**
 
 Geolocation information for an IPv4 or IPv6 address.
 
@@ -42,49 +43,49 @@ A mapping of caches to cache groups and their current health state.
 
 |
 
-**/crs/locations/:location/caches**
+**/crs/locations/<location>/caches**
 
 A list of caches for this cache group only.
 
 |
 
-**/crs/consistenthash/cache/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
 
 The resulting cache of the consistent hash using coverage zone file for a given client IP, delivery service, and request path.
 
 |
 
-**/crs/consistenthash/cache/deep/coveragezone/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/deep/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
 
 The resulting cache of the consistent hash using deep coverage zone file (deep caching) for a given client IP, delivery service, and request path.
 
 |
 
-**/crs/consistenthash/cache/geolocation/?ip=:ip&deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/cache/geolocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
 
 The resulting cache of the consistent hash using geolocation for a given client IP, delivery service, and request path.
 
 |
 
-**/crs/consistenthash/deliveryservice/?deliveryServiceId=:deliveryServiceId&requestPath=:requestPath**
+**/crs/consistenthash/deliveryservice/?deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
 
 The resulting delivery service of the consistent hash for a given delivery service and request path -- used to test steering delivery services.
 
 |
 
-**/crs/coveragezone/caches/?deliveryServiceId=:deliveryServiceId&cacheLocationId=:cacheLocationId**
+**/crs/coveragezone/caches/?deliveryServiceId=<deliveryServiceId>&cacheLocationId=<cacheLocationId>**
 
 A list of caches for a given delivery service and cache location.
 
 |
 
-**/crs/coveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId**
+**/crs/coveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
 
 The resulting cache location for a given client IP and delivery service.
 
 |
 
-**/crs/deepcoveragezone/cachelocation/?ip=:ip&deliveryServiceId=:deliveryServiceId**
+**/crs/deepcoveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
 
 The resulting cache location using deep coverage zone file (deep caching) for a given client IP and delivery service.
 


 

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