You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2019/02/12 16:11:01 UTC
[trafficcontrol] branch master updated: Update API Documentation
with CacheURL deprecation (#3284)
This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 5c401d0 Update API Documentation with CacheURL deprecation (#3284)
5c401d0 is described below
commit 5c401d0867917608a119ba38f5f9e113083f2006
Author: Jonathan G <jh...@users.noreply.github.com>
AuthorDate: Tue Feb 12 09:10:55 2019 -0700
Update API Documentation with CacheURL deprecation (#3284)
* Update API Documentation with CacheURL deprecation
This is a precursor to work being performed on #3225
* Update Documentation formatting per review feedback
* More style fixes per review
---
docs/source/admin/traffic_ops/using.rst | 4 +++-
docs/source/api/deliveryservices.rst | 12 ++++++++++++
docs/source/api/deliveryservices_id.rst | 8 ++++++++
docs/source/api/deliveryservices_id_safe.rst | 4 ++++
docs/source/api/servers_id_deliveryservices.rst | 4 ++++
docs/source/api/users_id_deliveryservices.rst | 4 ++++
6 files changed, 35 insertions(+), 1 deletion(-)
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 4929aa8..b539b59 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -441,7 +441,9 @@ The fields in the Delivery Service view are:
| | |
| | **Note:** you will not be able to save a Regex Remap Expression if you have Query String Handling set to drop query strings at the edge. See :ref:`regex-remap`. |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Cache URL expression | Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share |
+| Cache URL expression | Deprecated in Traffic Control 3.x and subject to removal in Traffic Control 4.x or later. |
+| | |
+| | Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share |
| | a cache key, can also be used to preserve cached content if service origin is changed. |
| | |
| | **Note:** Only valid in ATS 6.X and earlier. Must be empty if using ATS 7.X and/or the |
diff --git a/docs/source/api/deliveryservices.rst b/docs/source/api/deliveryservices.rst
index e1bb0f9..7ed7e7b 100644
--- a/docs/source/api/deliveryservices.rst
+++ b/docs/source/api/deliveryservices.rst
@@ -52,6 +52,10 @@ 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
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier of the CDN to which the Delivery Service belongs
:cdnName: Name of the CDN to which the Delivery Service belongs
@@ -286,6 +290,10 @@ Request Structure
:active: If ``true``, the Delivery Service will immediately become active and serves traffic
:anonymousBlockingEnabled: An optional field which, if defined and ``true`` will cause :ref:`Anonymous Blocking <anonymous_blocking-qht>` to be used with the new Delivery Service
:cacheurl: An optional setting for a deprecated feature of now-unsupported Trafficserver versions (read: "Don't use this")
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) in seconds of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier for the CDN to which this Delivery Service shall be assigned
:checkPath: The path portion of the URL which will be used to check connections to this Delivery Service's origin server
@@ -461,6 +469,10 @@ 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
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier of the CDN to which the Delivery Service belongs
:cdnName: Name of the CDN to which the Delivery Service belongs
diff --git a/docs/source/api/deliveryservices_id.rst b/docs/source/api/deliveryservices_id.rst
index c7635e4..1398a65 100644
--- a/docs/source/api/deliveryservices_id.rst
+++ b/docs/source/api/deliveryservices_id.rst
@@ -64,6 +64,10 @@ 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
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier of the CDN to which the Delivery Service belongs
:cdnName: Name of the CDN to which the Delivery Service belongs
@@ -310,6 +314,10 @@ Request Structure
:active: If ``true``, the Delivery Service will immediately become active and serves traffic
:anonymousBlockingEnabled: An optional field which, if defined and ``true`` will cause :ref:`Anonymous Blocking <anonymous_blocking-qht>` to be used with the new Delivery Service
:cacheurl: An optional setting for a deprecated feature of now-unsupported Trafficserver versions (read: "Don't use this")
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) in seconds of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier for the CDN to which this Delivery Service shall be assigned
:checkPath: The path portion of the URL which will be used to check connections to this Delivery Service's origin server
diff --git a/docs/source/api/deliveryservices_id_safe.rst b/docs/source/api/deliveryservices_id_safe.rst
index 675e700..ac00fea 100644
--- a/docs/source/api/deliveryservices_id_safe.rst
+++ b/docs/source/api/deliveryservices_id_safe.rst
@@ -73,6 +73,10 @@ 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
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier of the CDN to which the Delivery Service belongs
:cdnName: Name of the CDN to which the Delivery Service belongs
diff --git a/docs/source/api/servers_id_deliveryservices.rst b/docs/source/api/servers_id_deliveryservices.rst
index 42bafbd..4e9e9ac 100644
--- a/docs/source/api/servers_id_deliveryservices.rst
+++ b/docs/source/api/servers_id_deliveryservices.rst
@@ -51,6 +51,10 @@ 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
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier of the CDN to which the Delivery Service belongs
:cdnName: Name of the CDN to which the Delivery Service belongs
diff --git a/docs/source/api/users_id_deliveryservices.rst b/docs/source/api/users_id_deliveryservices.rst
index a066c81..aeda4c7 100644
--- a/docs/source/api/users_id_deliveryservices.rst
+++ b/docs/source/api/users_id_deliveryservices.rst
@@ -51,6 +51,10 @@ 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
+
+ .. deprecated:: ATCv3.0
+ This field has been deprecated in Traffic Control 3.x and is subject to removal in Traffic Control 4.x or later
+
:ccrDnsTtl: The Time To Live (TTL) of the DNS response for A or AAAA record queries requesting the IP address of the Traffic Router - named "ccrDnsTtl" for legacy reasons
:cdnId: The integral, unique identifier of the CDN to which the Delivery Service belongs
:cdnName: Name of the CDN to which the Delivery Service belongs