Ds active flag

CHANGELOG.md

@@ -79,6 +79,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - The format of the `/servers/{{host name}}/update_status` Traffic Ops API endpoint has been changed to use a top-level `response` property, in keeping with (most of) the rest of the API.
 - The API v4 Traffic Ops Go client has been overhauled compared to its predecessors to have a consistent call signature that allows passing query string parameters and HTTP headers to any client method.
 - Updated BouncyCastle libraries in Traffic Router to v1.68.
+- Delivery Service 'Active' properties are now a trinary "ACTIVE"/"PRIMED"/"INACTIVE" field rather than a strict boolean (as of Traffic Ops APIv4).
 
 ### Deprecated
 - The Riak Traffic Vault backend is now deprecated and its support may be removed in a future release. It is highly recommended to use the new PostgreSQL backend instead.

docs/source/admin/environment_creation.rst

@@ -51,4 +51,4 @@ Audience for Ansible-based Lab Deployment
 	:caption: Read more
 	:glob:
 
- 	ansible-labs/*
+	ansible-labs/*

docs/source/admin/traffic_portal/usingtrafficportal.rst

@@ -370,7 +370,7 @@ Use the `Quick Search` to search across all table columns or the column filter t
 :Cache Group:       [Visible by default] The :ref:`Name of the Cache Group <cache-group-name>` to which this server belongs
 :CDN:               [Visible by default] The name of the CDN to which the server belongs
 :Domain:            [Visible by default] The domain part of the server's :abbr:`FQDN (Fully Qualified Domain Name)`
-:Hash ID:			The identifier of the server used in Traffic Router's consistent hashing algorithm.
+:Hash ID:           The identifier of the server used in Traffic Router's consistent hashing algorithm.
 :Host:              [Visible by default] The (short) hostname of the server
 :HTTPS Port:        The port on which the server listens for incoming HTTPS connections/requests
 :ID:                An integral, unique identifier for this server

docs/source/api/v1/api_capabilities.rst

@@ -60,7 +60,7 @@ Response Structure
 
 :httpRoute:   The request route for which this capability applies - relative to the Traffic Ops server's URL
 :id:          An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in ISO format
+:lastUpdated: The time at which this capability was last updated, in an ISO-like format
 
 .. code-block:: http
 	:caption: Response Example
@@ -150,7 +150,7 @@ Response Structure
 
 :httpRoute:   The request route for which this capability applies - relative to the Traffic Ops server's URL
 :id:          An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in ISO format
+:lastUpdated: The time at which this capability was last updated, in an ISO-like format
 
 .. code-block:: http
 	:caption: Response Example
@@ -182,4 +182,3 @@ Response Structure
 		"id": 273,
 		"capability": "types-write"
 	}}
-

docs/source/api/v1/api_capabilities_id.rst

@@ -161,7 +161,7 @@ Response Structure
 
 :httpRoute:   The request route for which this capability applies - relative to the Traffic Ops server's URL
 :id:          An integer which uniquely identifies this capability
-:lastUpdated: The time at which this capability was last updated, in ISO format
+:lastUpdated: The time at which this capability was last updated, in an ISO-like format
 
 .. code-block:: http
 	:caption: Response Example

docs/source/api/v1/cachegroupparameters.rst

@@ -156,7 +156,7 @@ Response Structure
 :parameterId:  An integer that is the :ref:`parameter-id` of the :term:`Parameter` which has been assigned
 
 .. code-block:: http
- 	:caption: Response Example
+	:caption: Response Example
 
 	HTTP/1.1 200 OK
 	Access-Control-Allow-Credentials: true
@@ -184,4 +184,3 @@ Response Structure
 			"parameterId": 124
 		}
 	]}
-

docs/source/api/v1/capabilities_name.rst

@@ -55,7 +55,7 @@ Request Structure
 Response Structure
 ------------------
 :description: Describes the APIs covered by the capability
-:lastUpdated: Date and time of the last update made to this capability, in ISO format
+:lastUpdated: Date and time of the last update made to this capability, in an ISO-like format
 :name:        Name of the capability
 
 .. code-block:: http
@@ -129,7 +129,7 @@ Request Structure
 Response Structure
 ------------------
 :description: Describes the APIs covered by the capability.
-:lastUpdated: Date and time of the last update made to this capability, in ISO format
+:lastUpdated: Date and time of the last update made to this capability, in an ISO-like format
 :name:        The name of the capability
 
 .. code-block:: http

docs/source/api/v1/cdns.rst

@@ -64,7 +64,7 @@ Response Structure
 :dnssecEnabled: ``true`` if DNSSEC is enabled on this CDN, otherwise ``false``
 :domainName:    Top Level Domain name within which this CDN operates
 :id:            The integral, unique identifier for the CDN
-:lastUpdated:   Date and time when the CDN was last modified in ISO format
+:lastUpdated:   Date and time when the CDN was last modified in an ISO-like format
 :name:          The name of the CDN
 
 .. code-block:: http

docs/source/api/v1/cdns_id.rst

@@ -45,7 +45,7 @@ Response Structure
 :dnssecEnabled: ``true`` if DNSSEC is enabled on this CDN, otherwise ``false``
 :domainName:    Top Level Domain name within which this CDN operates
 :id:            The integral, unique identifier for the CDN
-:lastUpdated:   Date and time when the CDN was last modified in ISO format
+:lastUpdated:   Date and time when the CDN was last modified in an ISO-like format
 :name:          The name of the CDN
 
 .. code-block:: http
@@ -193,4 +193,3 @@ Response Structure
 			"level": "success"
 		}
 	]}
-

docs/source/api/v1/cdns_name_federations.rst

@@ -79,7 +79,7 @@ Response Structure
 
 	.. note:: This key will only be present if the description was provided when the federation was created. Refer to the ``POST`` method of this endpoint to see how federations can be created.
 
-:lastUpdated: The date and time at which this federation was last modified, in ISO format
+:lastUpdated: The date and time at which this federation was last modified, in an ISO-like format
 :ttl:         Time to Live (TTL) for the ``cname``, in hours
 
 .. code-block:: http
@@ -161,7 +161,7 @@ Response Structure
 
 	.. note:: This key will only be present if the description was provided when the federation was created
 
-:lastUpdated: The date and time at which this federation was last modified, in ISO format
+:lastUpdated: The date and time at which this federation was last modified, in an ISO-like format
 :ttl:         Time to Live (TTL) for the ``cname``, in hours
 
 

docs/source/api/v1/cdns_name_federations_id.rst

@@ -82,7 +82,7 @@ Response Structure
 
 	.. note:: This key will only be present if the description was provided when the federation was created. Refer to the ``POST`` method of the :ref:`to-api-v1-cdns-name-federations` endpoint to see how federations can be created.
 
-:lastUpdated: The date and time at which this federation was last modified, in ISO format
+:lastUpdated: The date and time at which this federation was last modified, in an ISO-like format
 :ttl:         Time to Live (TTL) for the ``cname``, in hours
 
 .. code-block:: http
@@ -172,7 +172,7 @@ Response Structure
 
 	.. note:: This key will only be present if the description was provided when the federation was created
 
-:lastUpdated: The date and time at which this federation was last modified, in ISO format
+:lastUpdated: The date and time at which this federation was last modified, in an ISO-like format
 :ttl:         Time to Live (TTL) for the ``cname``, in hours
 
 

docs/source/api/v1/cdns_name_name.rst

@@ -45,7 +45,7 @@ Response Structure
 :dnssecEnabled: ``true`` if DNSSEC is enabled on this CDN, otherwise ``false``
 :domainName:    Top Level Domain name within which this CDN operates
 :id:            The integral, unique identifier for the CDN
-:lastUpdated:   Date and time when the CDN was last modified in ISO format
+:lastUpdated:   Date and time when the CDN was last modified in an ISO-like format
 :name:          The name of the CDN
 
 .. code-block:: http
@@ -120,4 +120,3 @@ Response Structure
 			"level": "success"
 		}
 	]}
-

docs/source/api/v1/deliveryservices.rst

@@ -63,7 +63,7 @@ Request Structure
 
 Response Structure
 ------------------
-:active:                   A boolean that defines :ref:`ds-active`.
+:active:                   A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
 :cacheurl:                 A :ref:`ds-cacheurl`
 
@@ -113,7 +113,7 @@ Response Structure
 :infoUrl:             An :ref:`ds-info-url`
 :initialDispersion:  The :ref:`ds-initial-dispersion`
 :ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated:        The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:lastUpdated:        The date and time at which this :term:`Delivery Service` was last updated, in an ISO-like format
 :logsEnabled:        A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
 :longDesc:           The :ref:`ds-longdesc` of this :term:`Delivery Service`
 :longDesc1:          The :ref:`ds-longdesc2` of this :term:`Delivery Service`
@@ -279,7 +279,7 @@ Allows users to create :term:`Delivery Service`.
 
 Request Structure
 -----------------
-:active:                   A boolean that defines :ref:`ds-active`.
+:active:                   A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
 :cacheurl:                 A :ref:`ds-cacheurl`
 
@@ -419,7 +419,7 @@ Request Structure
 
 Response Structure
 ------------------
-:active:                   A boolean that defines :ref:`ds-active`.
+:active:                   A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
 :cacheurl:                 A :ref:`ds-cacheurl`
 
@@ -469,7 +469,7 @@ Response Structure
 :infoUrl:             An :ref:`ds-info-url`
 :initialDispersion:   The :ref:`ds-initial-dispersion`
 :ipv6RoutingEnabled:  A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated:         The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:lastUpdated:         A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :logsEnabled:         A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
 :longDesc:            The :ref:`ds-longdesc` of this :term:`Delivery Service`
 :longDesc1:           The :ref:`ds-longdesc2` of this :term:`Delivery Service`

docs/source/api/v1/deliveryservices_id.rst

@@ -71,7 +71,7 @@ Request Structure
 
 Response Structure
 ------------------
-:active:                   A boolean that defines :ref:`ds-active`.
+:active:                   A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
 :cacheurl:                 A :ref:`ds-cacheurl`
 
@@ -121,7 +121,7 @@ Response Structure
 :infoUrl:             An :ref:`ds-info-url`
 :initialDispersion:   The :ref:`ds-initial-dispersion`
 :ipv6RoutingEnabled:  A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated:         The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:lastUpdated:         The date and time at which this :term:`Delivery Service` was last updated, in an ISO-like format
 :logsEnabled:         A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
 :longDesc:            The :ref:`ds-longdesc` of this :term:`Delivery Service`
 :longDesc1:           The :ref:`ds-longdesc2` of this :term:`Delivery Service`
@@ -291,7 +291,7 @@ Allows users to edit an existing :term:`Delivery Service`.
 
 Request Structure
 -----------------
-:active:                   A boolean that defines :ref:`ds-active`.
+:active:                   A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
 :cacheurl:                 A :ref:`ds-cacheurl`
 

docs/source/api/v1/deliveryservices_id_safe.rst

@@ -61,7 +61,7 @@ Request Structure
 
 Response Structure
 ------------------
-:active:                   A boolean that defines :ref:`ds-active`.
+:active:                   A boolean that defines :ref:`ds-active`. ``true`` means that the Delivery Service is ACTIVE, while ``false`` means that it is either PRIMED or INACTIVE (API versions earlier than 4 are incapable of distinguishing between the two).
 :anonymousBlockingEnabled: A boolean that defines :ref:`ds-anonymous-blocking`
 :cacheurl:                 A :ref:`ds-cacheurl`
 
@@ -111,7 +111,7 @@ Response Structure
 :infoUrl:             An :ref:`ds-info-url`
 :initialDispersion:  The :ref:`ds-initial-dispersion`
 :ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated:        The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:lastUpdated:        The date and time at which this :term:`Delivery Service` was last updated, in an ISO-like format
 :logsEnabled:        A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
 :longDesc:           The :ref:`ds-longdesc` of this :term:`Delivery Service`
 :longDesc1:          The :ref:`ds-longdesc2` of this :term:`Delivery Service`

docs/source/api/v1/divisions.rst

@@ -55,7 +55,7 @@ Request Structure
 Response Structure
 ------------------
 :id:          An integral, unique identifier for this Division
-:lastUpdated: The date and time at which this Division was last modified, in ISO format
+:lastUpdated: The date and time at which this Division was last modified, in an ISO-like format
 :name:        The Division name
 
 .. code-block:: http
@@ -115,7 +115,7 @@ Request Structure
 Response Structure
 ------------------
 :id:          An integral, unique identifier for this Division
-:lastUpdated: The date and time at which this Division was last modified, in ISO format
+:lastUpdated: The date and time at which this Division was last modified, in an ISO-like format
 :name:        The Division name
 
 .. code-block:: http

docs/source/api/v1/divisions_id.rst

@@ -71,7 +71,7 @@ Request Structure
 Response Structure
 ------------------
 :id:          An integral, unique identifier for this Division
-:lastUpdated: The date and time at which this Division was last modified, in ISO format
+:lastUpdated: The date and time at which this Division was last modified, in an ISO-like format
 :name:        The Division name
 
 .. code-block:: http
@@ -137,7 +137,7 @@ Request Structure
 Response Structure
 ------------------
 :id:          An integral, unique identifier for this Division
-:lastUpdated: The date and time at which this Division was last modified, in ISO format
+:lastUpdated: The date and time at which this Division was last modified, in an ISO-like format
 :name:        The Division name
 
 .. code-block:: http

docs/source/api/v1/keys_ping.rst

@@ -43,8 +43,8 @@ No parameters available.
 
 Response Structure
 ------------------
-:server:	The hostname and port of :ref:`tv-overview`.
-:status:	The `reason phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
+:server: The hostname and port of :ref:`tv-overview`.
+:status: The `reason phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
 
 .. code-block:: http
 	:caption: Response Example

docs/source/api/v1/logs.rst

@@ -52,7 +52,7 @@ Request Structure
 Response Structure
 ------------------
 :id:          Integral, unique identifier for the Log entry
-:lastUpdated: Date and time at which the change was made, in ISO format
+:lastUpdated: Date and time at which the change was made, in an ISO-like format
 :level:       Log categories for each entry, e.g. 'UICHANGE', 'OPER', 'APICHANGE'
 :message:     Log detail about what occurred
 :ticketNum:   Optional field to cross reference with any bug tracking systems

docs/source/api/v1/logs_days_days.rst

@@ -60,7 +60,7 @@ Request Structure
 Response Structure
 ------------------
 :id:          Integral, unique identifier for the Log entry
-:lastUpdated: Date and time at which the change was made, in ISO format
+:lastUpdated: Date and time at which the change was made, in an ISO-like format
 :level:       Log categories for each entry, e.g. 'UICHANGE', 'OPER', 'APICHANGE'
 :message:     Log detail about what occurred
 :ticketNum:   Optional field to cross reference with any bug tracking systems

docs/source/api/v1/phys_locations.rst

@@ -70,7 +70,7 @@ Response Structure
 :comments:    Any and all human-readable comments
 :email:       The email address of the physical location's ``poc``
 :id:          An integral, unique identifier for the physical location
-:lastUpdated: The date and time at which the physical location was last updated, in ISO format
+:lastUpdated: The date and time at which the physical location was last updated, in an ISO-like format
 :name:        The name of the physical location
 :phone:       A phone number where the the physical location's ``poc`` might be reached
 :poc:         The name of a "point of contact" for the physical location
@@ -171,7 +171,7 @@ Response Structure
 :comments:    Any and all human-readable comments
 :email:       The email address of the physical location's ``poc``
 :id:          An integral, unique identifier for the physical location
-:lastUpdated: The date and time at which the physical location was last updated, in ISO format
+:lastUpdated: The date and time at which the physical location was last updated, in an ISO-like format
 :name:        The name of the physical location
 :phone:       A phone number where the the physical location's ``poc`` might be reached
 :poc:         The name of a "point of contact" for the physical location

docs/source/api/v1/phys_locations_id.rst

@@ -75,7 +75,7 @@ Response Structure
 :comments:    Any and all human-readable comments
 :email:       The email address of the physical location's ``poc``
 :id:          An integral, unique identifier for the physical location
-:lastUpdated: The date and time at which the physical location was last updated, in ISO format
+:lastUpdated: The date and time at which the physical location was last updated, in an ISO-like format
 :name:        The name of the physical location
 :phone:       A phone number where the the physical location's ``poc`` might be reached
 :poc:         The name of a "point of contact" for the physical location
@@ -190,7 +190,7 @@ Response Structure
 :comments:    Any and all human-readable comments
 :email:       The email address of the physical location's ``poc``
 :id:          An integral, unique identifier for the physical location
-:lastUpdated: The date and time at which the physical location was last updated, in ISO format
+:lastUpdated: The date and time at which the physical location was last updated, in an ISO-like format
 :name:        The name of the physical location
 :phone:       A phone number where the the physical location's ``poc`` might be reached
 :poc:         The name of a "point of contact" for the physical location

docs/source/api/v1/profiles_id_unassigned_parameters.rst

@@ -74,7 +74,7 @@ Response Structure
 	Date: Wed, 05 Dec 2018 21:37:50 GMT
 	Transfer-Encoding: chunked
 
-	{	"alerts": [{
+	{ "alerts": [{
 			"level": "warning",
 			"text": "This endpoint is deprecated, and will be removed in the future"
 		}],