Fix ssl documentation (#7869)

* fix ssl documentation * fix ssl docs
apache · Nov 21, 2023 · 09e4671 · 09e4671
1 parent 7a3e1e0
commit 09e4671
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 38 deletions.
diff --git a/docs/source/api/v3/deliveryservices_sslkeys_add.rst b/docs/source/api/v3/deliveryservices_sslkeys_add.rst
@@ -38,6 +38,10 @@ Request Structure
 	:csr: The csr file for the :term:`Delivery Service` identified by ``key``
 	:key: The private key for the :term:`Delivery Service` identified by ``key``
 
+:hostname:        The desired hostname of the :term:`Delivery Service`
+
+	.. note:: In most cases, this must be the same as the :term:`Delivery Service` URL'
+
 :key:     The :ref:`ds-xmlid` of the :term:`Delivery Service` to which these keys will be assigned
 :version: An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
 
@@ -49,6 +53,8 @@ Request Structure
 	Content-Type: application/json
 
 	{
+		"cdn": "test-cdn",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"key": "ds-01",
 		"version": "1",
 		"certificate": {

diff --git a/docs/source/api/v3/deliveryservices_sslkeys_generate.rst b/docs/source/api/v3/deliveryservices_sslkeys_generate.rst
@@ -29,17 +29,20 @@ Generates an SSL certificate, csr, and private key for a :term:`Delivery Service
 
 Request Structure
 -----------------
-:city:     A required field which will represent the resident city of the generated SSL certificate
-:country:  A required field which will represent the resident country of the generated SSL certificate
-:hostname: The desired hostname of the :term:`Delivery Service`
+:authType:        The certificate provider correlating to an :abbr:`ACME (Automatic Certificate Management Environment)` account in :ref:`cdn.conf` or Let's Encrypt.
+:businessUnit:    A required field which will represent the business unit for which the SSL certificate was generated
+:cdn:             A required field which will represent the CDN of the :term:`Delivery Service` for which keys will be generated
+:city:            A required field which will represent the resident city of the generated SSL certificate
+:country:         A required field which will represent the resident country of the generated SSL certificate
+:deliveryService: The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
+:hostname:        The desired hostname of the :term:`Delivery Service`
 
 	.. note:: In most cases, this must be the same as the :term:`Delivery Service` URL'
 
-:key:          The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
-:organization: A required field which will represent the organization for which the SSL certificate was generated
-:state:        A required field which will represent the resident state or province of the generated SSL certificate
-:businessUnit: A required field which will represent the business unit for which the SSL certificate was generated
-:version:      An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
+:key:             The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
+:organization:    A required field which will represent the organization for which the SSL certificate was generated
+:state:           A required field which will represent the resident state or province of the generated SSL certificate
+:version:         An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
 
 .. code-block:: http
 	:caption: Request Example
@@ -48,12 +51,13 @@ Request Structure
 	Content-Type: application/json
 
 	{
+		"cdn": "test-cdn",
 		"key": "ds-01",
 		"businessUnit": "CDN Engineering",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"country": "US",
-		"organization": "Kabletown",
+		"organization": "CDN",
 		"city": "Denver",
 		"state": "Colorado"
 	}

diff --git a/docs/source/api/v3/deliveryservices_sslkeys_generate_letsencrypt.rst b/docs/source/api/v3/deliveryservices_sslkeys_generate_letsencrypt.rst
@@ -48,7 +48,7 @@ Request Structure
 		"key": "ds-01",
 		"deliveryservice": "ds-01",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"cdn":"test-cdn"
 	}
 

diff --git a/docs/source/api/v3/deliveryservices_xmlid_xmlid_sslkeys.rst b/docs/source/api/v3/deliveryservices_xmlid_xmlid_sslkeys.rst
@@ -87,7 +87,7 @@ Response Structure
 		"cdn": "qa",
 		"businessUnit": "CDN_Eng",
 		"city": "Denver",
-		"organization": "KableTown",
+		"organization": "CDN",
 		"hostname": "foober.com",
 		"country": "US",
 		"state": "Colorado",

diff --git a/docs/source/api/v4/deliveryservices_sslkeys_add.rst b/docs/source/api/v4/deliveryservices_sslkeys_add.rst
@@ -39,6 +39,10 @@ Request Structure
 	:csr: The csr file for the :term:`Delivery Service` identified by ``key``
 	:key: The private key for the :term:`Delivery Service` identified by ``key``
 
+:hostname:        The desired hostname of the :term:`Delivery Service`
+
+	.. note:: In most cases, this must be the same as the :term:`Delivery Service` URL'
+
 :key:     The :ref:`ds-xmlid` of the :term:`Delivery Service` to which these keys will be assigned
 :version: An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
 
@@ -50,6 +54,8 @@ Request Structure
 	Content-Type: application/json
 
 	{
+		"cdn": "test-cdn",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"key": "ds-01",
 		"version": "1",
 		"certificate": {

diff --git a/docs/source/api/v4/deliveryservices_sslkeys_generate.rst b/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
@@ -30,17 +30,20 @@ Generates an SSL certificate, csr, and private key for a :term:`Delivery Service
 
 Request Structure
 -----------------
-:city:     A required field which will represent the resident city of the generated SSL certificate
-:country:  A required field which will represent the resident country of the generated SSL certificate
-:hostname: The desired hostname of the :term:`Delivery Service`
+:authType:        The certificate provider correlating to an :abbr:`ACME (Automatic Certificate Management Environment)` account in :ref:`cdn.conf` or Let's Encrypt.
+:businessUnit:    A required field which will represent the business unit for which the SSL certificate was generated
+:cdn:             A required field which will represent the CDN of the :term:`Delivery Service` for which keys will be generated
+:city:            A required field which will represent the resident city of the generated SSL certificate
+:country:         A required field which will represent the resident country of the generated SSL certificate
+:deliveryService: The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
+:hostname:        The desired hostname of the :term:`Delivery Service`
 
 	.. note:: In most cases, this must be the same as the :term:`Delivery Service` URL'
 
-:key:          The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
-:organization: A required field which will represent the organization for which the SSL certificate was generated
-:state:        A required field which will represent the resident state or province of the generated SSL certificate
-:businessUnit: A required field which will represent the business unit for which the SSL certificate was generated
-:version:      An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
+:key:             The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
+:organization:    A required field which will represent the organization for which the SSL certificate was generated
+:state:           A required field which will represent the resident state or province of the generated SSL certificate
+:version:         An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
 
 .. code-block:: http
 	:caption: Request Example
@@ -49,12 +52,13 @@ Request Structure
 	Content-Type: application/json
 
 	{
+		"cdn": "test-cdn",
 		"key": "ds-01",
 		"businessUnit": "CDN Engineering",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"country": "US",
-		"organization": "Kabletown",
+		"organization": "CDN",
 		"city": "Denver",
 		"state": "Colorado"
 	}

diff --git a/docs/source/api/v4/deliveryservices_sslkeys_generate_acme.rst b/docs/source/api/v4/deliveryservices_sslkeys_generate_acme.rst
@@ -53,7 +53,7 @@ Request Structure
 		"key": "ds-01",
 		"deliveryservice": "ds-01",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"cdn":"test-cdn"
 	}
 

diff --git a/docs/source/api/v4/deliveryservices_sslkeys_generate_letsencrypt.rst b/docs/source/api/v4/deliveryservices_sslkeys_generate_letsencrypt.rst
@@ -51,7 +51,7 @@ Request Structure
 		"key": "ds-01",
 		"deliveryservice": "ds-01",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"cdn":"test-cdn"
 	}
 

diff --git a/docs/source/api/v4/deliveryservices_xmlid_xmlid_sslkeys.rst b/docs/source/api/v4/deliveryservices_xmlid_xmlid_sslkeys.rst
@@ -91,7 +91,7 @@ Response Structure
 		"cdn": "qa",
 		"businessUnit": "CDN_Eng",
 		"city": "Denver",
-		"organization": "KableTown",
+		"organization": "CDN",
 		"hostname": "foober.com",
 		"country": "US",
 		"state": "Colorado",

diff --git a/docs/source/api/v5/deliveryservices_sslkeys_add.rst b/docs/source/api/v5/deliveryservices_sslkeys_add.rst
@@ -39,6 +39,10 @@ Request Structure
 	:csr: The csr file for the :term:`Delivery Service` identified by ``key``
 	:key: The private key for the :term:`Delivery Service` identified by ``key``
 
+:hostname:        The desired hostname of the :term:`Delivery Service`
+
+	.. note:: In most cases, this must be the same as the :term:`Delivery Service` URL'
+
 :key:     The :ref:`ds-xmlid` of the :term:`Delivery Service` to which these keys will be assigned
 :version: An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
 
@@ -50,6 +54,8 @@ Request Structure
 	Content-Type: application/json
 
 	{
+		"cdn": "test-cdn",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"key": "ds-01",
 		"version": "1",
 		"certificate": {

diff --git a/docs/source/api/v5/deliveryservices_sslkeys_generate.rst b/docs/source/api/v5/deliveryservices_sslkeys_generate.rst
@@ -30,17 +30,20 @@ Generates an SSL certificate, csr, and private key for a :term:`Delivery Service
 
 Request Structure
 -----------------
-:city:     A required field which will represent the resident city of the generated SSL certificate
-:country:  A required field which will represent the resident country of the generated SSL certificate
-:hostname: The desired hostname of the :term:`Delivery Service`
+:authType:        The certificate provider correlating to an :abbr:`ACME (Automatic Certificate Management Environment)` account in :ref:`cdn.conf` or Let's Encrypt.
+:businessUnit:    A required field which will represent the business unit for which the SSL certificate was generated
+:cdn:             A required field which will represent the CDN of the :term:`Delivery Service` for which keys will be generated
+:city:            A required field which will represent the resident city of the generated SSL certificate
+:country:         A required field which will represent the resident country of the generated SSL certificate
+:deliveryService: The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
+:hostname:        The desired hostname of the :term:`Delivery Service`
 
 	.. note:: In most cases, this must be the same as the :term:`Delivery Service` URL'
 
-:key:          The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
-:organization: A required field which will represent the organization for which the SSL certificate was generated
-:state:        A required field which will represent the resident state or province of the generated SSL certificate
-:businessUnit: A required field which will represent the business unit for which the SSL certificate was generated
-:version:      An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
+:key:             The :ref:`ds-xmlid` of the :term:`Delivery Service` for which keys will be generated
+:organization:    A required field which will represent the organization for which the SSL certificate was generated
+:state:           A required field which will represent the resident state or province of the generated SSL certificate
+:version:         An integer that defines the "version" of the key - which may be thought of as the sequential generation; that is, the higher the number the more recent the key
 
 .. code-block:: http
 	:caption: Request Example
@@ -49,12 +52,13 @@ Request Structure
 	Content-Type: application/json
 
 	{
+		"cdn": "test-cdn",
 		"key": "ds-01",
 		"businessUnit": "CDN Engineering",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"country": "US",
-		"organization": "Kabletown",
+		"organization": "CDN",
 		"city": "Denver",
 		"state": "Colorado"
 	}

diff --git a/docs/source/api/v5/deliveryservices_sslkeys_generate_acme.rst b/docs/source/api/v5/deliveryservices_sslkeys_generate_acme.rst
@@ -51,7 +51,7 @@ Request Structure
 		"key": "ds-01",
 		"deliveryservice": "ds-01",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"cdn":"test-cdn"
 	}
 

diff --git a/docs/source/api/v5/deliveryservices_sslkeys_generate_letsencrypt.rst b/docs/source/api/v5/deliveryservices_sslkeys_generate_letsencrypt.rst
@@ -51,7 +51,7 @@ Request Structure
 		"key": "ds-01",
 		"deliveryservice": "ds-01",
 		"version": "3",
-		"hostname": "tr.ds-01.ott.kabletown.com",
+		"hostname": "tr.ds-01.mycdn.ciab.test",
 		"cdn":"test-cdn"
 	}
 

diff --git a/docs/source/api/v5/deliveryservices_xmlid_xmlid_sslkeys.rst b/docs/source/api/v5/deliveryservices_xmlid_xmlid_sslkeys.rst
@@ -89,7 +89,7 @@ Response Structure
 		"cdn": "qa",
 		"businessUnit": "CDN_Eng",
 		"city": "Denver",
-		"organization": "KableTown",
+		"organization": "CDN",
 		"hostname": "foober.com",
 		"country": "US",
 		"state": "Colorado",