dangogh closed pull request #1975: Doc updates for TR Header Parameters
URL: https://github.com/apache/incubator-trafficcontrol/pull/1975
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
index aac6dae54..fca9e4929 100644
--- a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
+++ b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
@@ -191,9 +191,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenantId`` | int | Owning tenant ID
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -440,9 +440,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenantId`` | int | Owning tenant ID
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2200,9 +2200,11 @@ URL Sig Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| tenantId | No | Owning tenant ID
|
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trRequestHeaders | no | Traffic router log request headers
|
+ | trRequestHeaders | no | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log |
+ | | | entries under the "rh=" token.
|
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trResponseHeaders | no | Traffic router additional response
headers |
+ | trResponseHeaders | no | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all |
+ | | | TR HTTP responses.
|
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| typeId | yes | The type of this deliveryservice (one
of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -2384,9 +2386,9 @@ URL Sig Keys
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``sslKeyVersion`` | int |
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2621,9 +2623,11 @@ URL Sig Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| tenantId | No | Owning tenant ID
|
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trRequestHeaders | no | Traffic router log request headers
|
+ | trRequestHeaders | no | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log |
+ | | | entries under the "rh=" token.
|
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trResponseHeaders | no | Traffic router additional response
headers |
+ | trResponseHeaders | no | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all |
+ | | | TR HTTP responses.
|
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| typeId | yes | The type of this deliveryservice (one
of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -2805,9 +2809,9 @@ URL Sig Keys
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``sslKeyVersion`` | int |
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -3080,9 +3084,9 @@ URL Sig Keys
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``sslKeyVersion`` | int |
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``typeId`` | int | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/development/traffic_ops_api/v12/server.rst
b/docs/source/development/traffic_ops_api/v12/server.rst
index 779f19aca..accc23415 100644
--- a/docs/source/development/traffic_ops_api/v12/server.rst
+++ b/docs/source/development/traffic_ops_api/v12/server.rst
@@ -499,9 +499,9 @@ Server
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenantId`` | int | Owning tenant ID.
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/development/traffic_ops_api/v12/user.rst
b/docs/source/development/traffic_ops_api/v12/user.rst
index 27efc22e0..8d22fc72a 100644
--- a/docs/source/development/traffic_ops_api/v12/user.rst
+++ b/docs/source/development/traffic_ops_api/v12/user.rst
@@ -575,9 +575,9 @@ Users
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``tenantId`` | int | Owning tenant ID.
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string |
|
+ | ``trRequestHeaders`` | string | List of header keys separated by
``__RETURN__``. Listed headers will be included in TR access log entries under
the "rh=" token. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string |
|
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs
separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP
responses. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The type of this deliveryservice (one
of :ref:to-api-v11-types use_in_table='deliveryservice').
|
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
