This is an automated email from the ASF dual-hosted git repository.
ocket8888 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 48b30a807f List the minor version that introduced ttlOverride (#7351)
48b30a807f is described below
commit 48b30a807f162f768c2e592dcb673a64a3afc7b4
Author: Zach Hoffman <[email protected]>
AuthorDate: Thu Feb 16 13:29:37 2023 -0700
List the minor version that introduced ttlOverride (#7351)
* List the minor version that introduced ttlOverride
* Add `ttlOverride` field to documentation for `PUT cdns/{{ID}}`
---
docs/source/api/v4/cdns.rst | 8 +++++++-
docs/source/api/v4/cdns_id.rst | 11 +++++++++--
docs/source/api/v5/cdns_id.rst | 7 +++++--
3 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/docs/source/api/v4/cdns.rst b/docs/source/api/v4/cdns.rst
index 9726b9c439..ba2adfc5a0 100644
--- a/docs/source/api/v4/cdns.rst
+++ b/docs/source/api/v4/cdns.rst
@@ -69,6 +69,8 @@ Response Structure
:name: The name of the CDN
:ttlOverride: A :abbr:`TTL (Time To Live)` value, in seconds, that, if set,
overrides all set TTL values on :term:`Delivery Services` in this :abbr:`CDN
(Content Delivery Network)`
+ .. versionadded:: 4.1
+
.. code-block:: http
:caption: Response Example
@@ -117,7 +119,9 @@ Request Structure
:dnssecEnabled: If ``true``, this CDN will use DNSSEC, if ``false`` it will not
:domainName: The top-level domain (TLD) belonging to the new CDN
:name: Name of the new CDN
-:ttlOverride: A :abbr:`TTL (Time To Live)` value, in seconds, that, if set,
overrides all set TTL values on :term:`Delivery Services` in this :abbr:`CDN
(Content Delivery Network)`
+:ttlOverride: Optional an nullable. A :abbr:`TTL (Time To Live)` value, in
seconds, that, if set, overrides all set TTL values on :term:`Delivery
Services` in this :abbr:`CDN (Content Delivery Network)`
+
+ .. versionadded:: 4.1
.. code-block:: http
:caption: Request Structure
@@ -140,6 +144,8 @@ Response Structure
:name: The newly created CDN's name
:ttlOverride: A :abbr:`TTL (Time To Live)` value, in seconds, that, if set,
overrides all set TTL values on :term:`Delivery Services` in this :abbr:`CDN
(Content Delivery Network)`
+ .. versionadded:: 4.1
+
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/v4/cdns_id.rst b/docs/source/api/v4/cdns_id.rst
index 55b2ebe859..a30a00fd76 100644
--- a/docs/source/api/v4/cdns_id.rst
+++ b/docs/source/api/v4/cdns_id.rst
@@ -41,6 +41,9 @@ Request Structure
:dnssecEnabled: If ``true``, this CDN will use DNSSEC, if ``false`` it will not
:domainName: The top-level domain (TLD) belonging to the CDN
:name: Name of the new CDN
+:ttlOverride: Optional an nullable. A :abbr:`TTL (Time To Live)` value, in
seconds, that, if set, overrides all set TTL values on :term:`Delivery
Services` in this :abbr:`CDN (Content Delivery Network)`
+
+ .. versionadded:: 4.1
.. code-block:: http
:caption: Request Example
@@ -53,7 +56,7 @@ Request Structure
Content-Length: 63
Content-Type: application/json
- {"name": "quest", "domainName": "test", "dnssecEnabled": false}
+ {"name": "quest", "domainName": "test", "dnssecEnabled": false,
"ttlOverride": 60}
Response Structure
------------------
@@ -61,6 +64,9 @@ Response Structure
:domainName: The top-level domain (TLD) assigned to the newly created CDN
:id: An integral, unique identifier for the newly created CDN
:name: The newly created CDN's name
+:ttlOverride: A :abbr:`TTL (Time To Live)` value, in seconds, that, if set,
overrides all set TTL values on :term:`Delivery Services` in this :abbr:`CDN
(Content Delivery Network)`
+
+ .. versionadded:: 4.1
.. code-block:: http
@@ -89,7 +95,8 @@ Response Structure
"domainName": "test",
"id": 4,
"lastUpdated": "2018-11-14 20:54:33+00",
- "name": "quest"
+ "name": "quest",
+ "ttlOverride": 60
}}
``DELETE``
diff --git a/docs/source/api/v5/cdns_id.rst b/docs/source/api/v5/cdns_id.rst
index 87949dd742..d5b26ff3e8 100644
--- a/docs/source/api/v5/cdns_id.rst
+++ b/docs/source/api/v5/cdns_id.rst
@@ -41,6 +41,7 @@ Request Structure
:dnssecEnabled: If ``true``, this CDN will use DNSSEC, if ``false`` it will not
:domainName: The top-level domain (TLD) belonging to the CDN
:name: Name of the new CDN
+:ttlOverride: Optional an nullable. A :abbr:`TTL (Time To Live)` value, in
seconds, that, if set, overrides all set TTL values on :term:`Delivery
Services` in this :abbr:`CDN (Content Delivery Network)`
.. code-block:: http
:caption: Request Example
@@ -53,7 +54,7 @@ Request Structure
Content-Length: 63
Content-Type: application/json
- {"name": "quest", "domainName": "test", "dnssecEnabled": false}
+ {"name": "quest", "domainName": "test", "dnssecEnabled": false,
"ttlOverride": 60}
Response Structure
------------------
@@ -61,6 +62,7 @@ Response Structure
:domainName: The top-level domain (TLD) assigned to the newly created CDN
:id: An integral, unique identifier for the newly created CDN
:name: The newly created CDN's name
+:ttlOverride: A :abbr:`TTL (Time To Live)` value, in seconds, that, if set,
overrides all set TTL values on :term:`Delivery Services` in this :abbr:`CDN
(Content Delivery Network)`
.. code-block:: http
@@ -89,7 +91,8 @@ Response Structure
"domainName": "test",
"id": 4,
"lastUpdated": "2018-11-14 20:54:33+00",
- "name": "quest"
+ "name": "quest",
+ "ttlOverride": 60
}}
``DELETE``
