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 818047df5c Updated deliveryservices/sslkeys/generate documentation,
added required to specific fields (#7141)
818047df5c is described below
commit 818047df5ce287105b8b98d1195d08e8dd046b9c
Author: Sumit S. Agrawal <[email protected]>
AuthorDate: Mon Oct 17 20:22:15 2022 +0530
Updated deliveryservices/sslkeys/generate documentation, added required to
specific fields (#7141)
---
docs/source/api/v3/deliveryservices_sslkeys_generate.rst | 10 +++++-----
docs/source/api/v4/deliveryservices_sslkeys_generate.rst | 10 +++++-----
docs/source/api/v5/deliveryservices_sslkeys_generate.rst | 10 +++++-----
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/source/api/v3/deliveryservices_sslkeys_generate.rst
b/docs/source/api/v3/deliveryservices_sslkeys_generate.rst
index 3b19e632db..0794aade7b 100644
--- a/docs/source/api/v3/deliveryservices_sslkeys_generate.rst
+++ b/docs/source/api/v3/deliveryservices_sslkeys_generate.rst
@@ -29,16 +29,16 @@ Generates an SSL certificate, csr, and private key for a
:term:`Delivery Service
Request Structure
-----------------
-:city: An optional field which, if present, will represent the resident
city of the generated SSL certificate
-:country: An optional field which, if present, will represent the resident
country of the generated SSL certificate
+: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`
.. 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: An optional field which, if present, will represent the
organization for which the SSL certificate was generated
-:state: An optional field which, if present, will represent the
resident state or province of the generated SSL certificate
-:businessUnit: An optional field which, if present, will represent the
business unit for which the SSL certificate was 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
.. code-block:: http
diff --git a/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
b/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
index 1a3f47b376..e7585d3c64 100644
--- a/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
+++ b/docs/source/api/v4/deliveryservices_sslkeys_generate.rst
@@ -30,16 +30,16 @@ Generates an SSL certificate, csr, and private key for a
:term:`Delivery Service
Request Structure
-----------------
-:city: An optional field which, if present, will represent the resident
city of the generated SSL certificate
-:country: An optional field which, if present, will represent the resident
country of the generated SSL certificate
+: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`
.. 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: An optional field which, if present, will represent the
organization for which the SSL certificate was generated
-:state: An optional field which, if present, will represent the
resident state or province of the generated SSL certificate
-:businessUnit: An optional field which, if present, will represent the
business unit for which the SSL certificate was 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
.. code-block:: http
diff --git a/docs/source/api/v5/deliveryservices_sslkeys_generate.rst
b/docs/source/api/v5/deliveryservices_sslkeys_generate.rst
index a383fd79a9..62b061d9dc 100644
--- a/docs/source/api/v5/deliveryservices_sslkeys_generate.rst
+++ b/docs/source/api/v5/deliveryservices_sslkeys_generate.rst
@@ -30,16 +30,16 @@ Generates an SSL certificate, csr, and private key for a
:term:`Delivery Service
Request Structure
-----------------
-:city: An optional field which, if present, will represent the resident
city of the generated SSL certificate
-:country: An optional field which, if present, will represent the resident
country of the generated SSL certificate
+: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`
.. 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: An optional field which, if present, will represent the
organization for which the SSL certificate was generated
-:state: An optional field which, if present, will represent the
resident state or province of the generated SSL certificate
-:businessUnit: An optional field which, if present, will represent the
business unit for which the SSL certificate was 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
.. code-block:: http
