This is an automated email from the ASF dual-hosted git repository. elsloo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
commit efefb8b30e63adbe3ffc165e0d5d73ca1084e061 Author: Rawlin Peters <rawlin_pet...@comcast.com> AuthorDate: Fri Nov 10 16:24:18 2017 -0700 Update API ref to show deepCachingType is now a string --- docs/source/admin/traffic_ops/using.rst | 4 +- .../traffic_ops_api/v12/deliveryservice.rst | 56 +++++++++++----------- .../development/traffic_ops_api/v12/server.rst | 8 ++-- .../development/traffic_ops_api/v12/user.rst | 8 ++-- 4 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst index 6a6c130..b11e20d 100644 --- a/docs/source/admin/traffic_ops/using.rst +++ b/docs/source/admin/traffic_ops/using.rst @@ -308,8 +308,8 @@ The fields in the Delivery Service view are: +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Deep Caching | (for HTTP routed delivery services only) When to do deep caching for this delivery service (see :ref:`Deep Caching <rl-deep-cache>` for more details): | | | | -| | - 0 - NEVER | -| | - 1 - ALWAYS | +| | - NEVER | +| | - ALWAYS | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records (``<routing-name>.<deliveryservice>.<cdn-domain>``). | +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst index 42005f7..6dee578 100644 --- a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst +++ b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst @@ -66,10 +66,10 @@ Delivery Service +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -211,7 +211,7 @@ Delivery Service "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", @@ -307,10 +307,10 @@ Delivery Service +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -460,7 +460,7 @@ Delivery Service "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", @@ -1930,10 +1930,10 @@ URL Sig Keys +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+ | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. | +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+ - | ``>deepCachingType`` | int | no | When to do Deep Caching for this Delivery Service: | + | ``>deepCachingType`` | string | no | When to do Deep Caching for this Delivery Service: | | | | | | - | | | | - 0: NEVER (default) | - | | | | - 1: ALWAYS | + | | | | - NEVER (default) | + | | | | - ALWAYS | +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+ | ``>deliveryProtocol`` | string | yes | Eg. http or http/https | +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+ @@ -1995,7 +1995,7 @@ URL Sig Keys "details": { "customer": "XYZ Corporation", "contentType": "video-on-demand", - "deepCachingType": 0, + "deepCachingType": "NEVER", "deliveryProtocol": "http", "routingType": "dns", "routingName": "foo", @@ -2082,8 +2082,8 @@ URL Sig Keys +------------------------+----------+---------------------------------------------------------------------------------------------------------+ | deepCachingType | no | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +------------------------+----------+---------------------------------------------------------------------------------------------------------+ | displayName | yes | Display name | +------------------------+----------+---------------------------------------------------------------------------------------------------------+ @@ -2255,10 +2255,10 @@ URL Sig Keys +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -2404,7 +2404,7 @@ URL Sig Keys "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", @@ -2503,8 +2503,8 @@ URL Sig Keys +------------------------+----------+---------------------------------------------------------------------------------------------------------+ | deepCachingType | no | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +------------------------+----------+---------------------------------------------------------------------------------------------------------+ | displayName | yes | Display name | +------------------------+----------+---------------------------------------------------------------------------------------------------------+ @@ -2676,10 +2676,10 @@ URL Sig Keys +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -2825,7 +2825,7 @@ URL Sig Keys "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", @@ -2951,10 +2951,10 @@ URL Sig Keys +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -3100,7 +3100,7 @@ URL Sig Keys "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", diff --git a/docs/source/development/traffic_ops_api/v12/server.rst b/docs/source/development/traffic_ops_api/v12/server.rst index 9b2a42b..779f19a 100644 --- a/docs/source/development/traffic_ops_api/v12/server.rst +++ b/docs/source/development/traffic_ops_api/v12/server.rst @@ -378,10 +378,10 @@ Server +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -521,7 +521,7 @@ Server "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", diff --git a/docs/source/development/traffic_ops_api/v12/user.rst b/docs/source/development/traffic_ops_api/v12/user.rst index b589a3b..27efc22 100644 --- a/docs/source/development/traffic_ops_api/v12/user.rst +++ b/docs/source/development/traffic_ops_api/v12/user.rst @@ -454,10 +454,10 @@ Users +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``deepCachingType`` | int | When to do Deep Caching for this Delivery Service: | + | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: | | | | | - | | | - 0: NEVER (default) | - | | | - 1: ALWAYS | + | | | - NEVER (default) | + | | | - ALWAYS | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ | ``displayName`` | string | The display name of the delivery service. | +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -597,7 +597,7 @@ Users "cdnId": "2", "cdnName": "over-the-top", "checkPath": "", - "deepCachingType": 0, + "deepCachingType": "NEVER", "displayName": "My Cool Delivery Service", "dnsBypassCname": "", "dnsBypassIp": "", -- To stop receiving notification emails like this one, please contact els...@apache.org.