openstack
/
octavia
Code Issues Proposed changes

Standardizes terminology in Listener documentation 

This addresses the potentially confusing use of two terms
(TERMINATED_TLS and TERMINATED_HTTPS) used to describe the same
behavior by standardizing on the term TERMINATED_HTTPS in the
parameters of the documentation.

Change-Id: I3f444ba8e68ba8fc692ba41eec1ad4672ba5a16b
Story: 2006405
Task: 36289
This commit is contained in:
Colin Gibbons 2019-08-15 13:36:07 -07:00
parent b8cc5ae533
commit 3b5a19c386
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/source/parameters.yaml
View File

@ -284,7 +284,7 @@ client_ca_tls_container_ref:
description: |
The ref of the `key manager service
<https://docs.openstack.org/castellan/latest/>`__ secret containing a
PEM format client CA certificate bundle for ``TERMINATED_TLS``
PEM format client CA certificate bundle for ``TERMINATED_HTTPS``
listeners.
in: body
min_version: 2.8
@ -294,7 +294,7 @@ client_ca_tls_container_ref-optional:
description: |
The ref of the `key manager service
<https://docs.openstack.org/castellan/latest/>`__ secret containing a
PEM format client CA certificate bundle for ``TERMINATED_TLS``
PEM format client CA certificate bundle for ``TERMINATED_HTTPS``
listeners.
in: body
min_version: 2.8
@ -304,7 +304,7 @@ client_crl_container_ref:
description: |
The URI of the `key manager service
<https://docs.openstack.org/castellan/latest/>`__ secret containing a
PEM format CA revocation list file for ``TERMINATED_TLS`` listeners.
PEM format CA revocation list file for ``TERMINATED_HTTPS`` listeners.
in: body
min_version: 2.8
required: true
@ -313,7 +313,7 @@ client_crl_container_ref-optional:
description: |
The URI of the `key manager service
<https://docs.openstack.org/castellan/latest/>`__ secret containing a
PEM format CA revocation list file for ``TERMINATED_TLS`` listeners.
PEM format CA revocation list file for ``TERMINATED_HTTPS`` listeners.
in: body
min_version: 2.8
required: false
@ -383,9 +383,9 @@ default_tls_container_ref:
description: |
The URI of the `key manager service
<https://docs.openstack.org/castellan/latest/>`__ secret containing a
PKCS12 format certificate/key bundle for ``TERMINATED_TLS`` listeners.
PKCS12 format certificate/key bundle for ``TERMINATED_HTTPS`` listeners.
DEPRECATED: A secret container of type "certificate" containing the
certificate and key for ``TERMINATED_TLS`` listeners.
certificate and key for ``TERMINATED_HTTPS`` listeners.
in: body
required: true
type: string
@ -393,9 +393,9 @@ default_tls_container_ref-optional:
description: |
The URI of the `key manager service
<https://docs.openstack.org/castellan/latest/>`__ secret containing a
PKCS12 format certificate/key bundle for ``TERMINATED_TLS`` listeners.
PKCS12 format certificate/key bundle for ``TERMINATED_HTTPS`` listeners.
DEPRECATED: A secret container of type "certificate" containing the
certificate and key for ``TERMINATED_TLS`` listeners.
certificate and key for ``TERMINATED_HTTPS`` listeners.
in: body
required: false
type: string
@ -1291,9 +1291,9 @@ sni_container_refs:
description: |
A list of URIs to the `key manager service
<https://docs.openstack.org/barbican/latest/>`__ secrets containing
PKCS12 format certificate/key bundles for ``TERMINATED_TLS`` listeners.
PKCS12 format certificate/key bundles for ``TERMINATED_HTTPS`` listeners.
(DEPRECATED) Secret containers of type "certificate" containing the
certificates and keys for ``TERMINATED_TLS`` listeners.
certificates and keys for ``TERMINATED_HTTPS`` listeners.
in: body
required: true
type: array
@ -1301,9 +1301,9 @@ sni_container_refs-optional:
description: |
A list of URIs to the `key manager service
<https://docs.openstack.org/barbican/latest/>`__ secrets containing
PKCS12 format certificate/key bundles for ``TERMINATED_TLS`` listeners.
PKCS12 format certificate/key bundles for ``TERMINATED_HTTPS`` listeners.
(DEPRECATED) Secret containers of type "certificate" containing the
certificates and keys for ``TERMINATED_TLS`` listeners.
certificates and keys for ``TERMINATED_HTTPS`` listeners.
in: body
required: false
type: array