openstack
/
octavia
Code Issues Proposed changes

Update API-REF for x-forwarded-port is string 

The API reference document had a typo where the "X-Forwarded-Port"
parameter for the HTTP header insertions was listed as an integer
instead of as a string. It also corrects "X-Forwarded-For" to be a
string. This patch corrects that mistake.

Change-Id: I3996d5e1950f8d979eb1c354dfac70a0ddefdca2
This commit is contained in:
Michael Johnson 2018-03-29 10:35:46 -07:00 committed by Jacky Hu
parent e2f2a10d5e
commit aab5e6645f
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
api-ref/source/v2/listener.inc
View File

@ -156,20 +156,18 @@ Supported HTTP Header Insertions
header insertions.
+------------------+---------+------------------------------------------------+
| Key | Value | Description |
+==================+=========+================================================+
| X-Forwarded-For | boolean | When ``true`` a ``X-Forwarded-For`` header is |
| | | inserted into the request to the backend |
| | | ``member`` that specifies the client IP |
| | | address. |
+------------------+---------+------------------------------------------------+
| X-Forwarded-Port | integer | A ``X-Forwarded-Port`` header is inserted into |
| | | the request to the backend ``member`` that |
| | | specifies the integer provided. Typically this |
| | | is used to indicate the port the client |
| | | connected to on the load balancer. |
+------------------+---------+------------------------------------------------+
+------------------+--------+------------------------------------------------+
| Key | Value | Description |
+==================+========+================================================+
| X-Forwarded-For | string | When "``true``" a ``X-Forwarded-For`` header |
| | | is inserted into the request to the backend |
| | | ``member`` that specifies the client IP |
| | | address. |
+------------------+--------+------------------------------------------------+
| X-Forwarded-Port | string | When "``true``" a ``X-Forwarded-Port`` header |
| | | is inserted into the request to the backend |
| | | ``member`` that specifies the listener port. |
+------------------+--------+------------------------------------------------+
Request Example
----------------