You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2016/11/04 14:30:48 UTC
[5/6] incubator-trafficcontrol git commit: update documentation with
missing fields
update documentation with missing fields
According to @dneuman64, these fields are present on delivery service
ssl keys responses.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/0ca69262
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/0ca69262
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/0ca69262
Branch: refs/heads/master
Commit: 0ca69262e6f8551036e1af2e2cde3778edacfb19
Parents: 8d6067b
Author: Mike Ball <mi...@gmail.com>
Authored: Tue Nov 1 06:30:27 2016 -0400
Committer: Dave Neuman <ne...@apache.org>
Committed: Fri Nov 4 08:29:54 2016 -0600
----------------------------------------------------------------------
.../traffic_ops_api/v12/deliveryservice.rst | 104 +++++++++++--------
1 file changed, 58 insertions(+), 46 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/0ca69262/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
index 379ea37..97de3c5 100644
--- a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
+++ b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
@@ -769,29 +769,33 @@ SSL Keys
**Response Properties**
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdn`` | string | The CDN entered by the user when generating certs. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservice`` | string | The delivery service entered by the user when generating certs. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -802,6 +806,8 @@ SSL Keys
"key": "key",
"csr": "csr"
},
+ "deliveryservice": "my-ds",
+ "cdn": "qa",
"businessUnit": "CDN_Eng",
"city": "Denver",
"organization": "KableTown",
@@ -839,29 +845,33 @@ SSL Keys
**Response Properties**
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdn`` | string | The CDN entered by the user when generating certs. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservice`` | string | The delivery service entered by the user when generating certs. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -872,6 +882,8 @@ SSL Keys
"key": "key",
"csr": "csr"
},
+ "deliveryservice": "my-ds",
+ "cdn": "qa",
"businessUnit": "CDN_Eng",
"city": "Denver",
"organization": "KableTown",