From 53afda72e38326e74d0d8f0864287989527b862c Mon Sep 17 00:00:00 2001 From: Damien Baty Date: Fri, 2 Dec 2016 14:31:33 +0100 Subject: [PATCH 1/2] docs: Fix typo. --- docs/usage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index c8fa933..cf45ffb 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -66,7 +66,7 @@ customize it with ``CID_RESPONSE_HEADER`` in the settings: CID_RESPONSE_HEADER = 'X-Correlation-Id' If you don't want the header to appear in the HTTP response, you must -explicitly set ``CID_REQUEST_HEADER`` to ``None``. +explicitly set ``CID_RESPONSE_HEADER`` to ``None``. .. code-block:: python From fbea4df9154272bc2d9c144367e02eb30493ee5c Mon Sep 17 00:00:00 2001 From: Damien Baty Date: Fri, 2 Dec 2016 14:30:26 +0100 Subject: [PATCH 2/2] docs: List `CID_RESPONSE_HEADER` in the Settings page. I documented it in the "Usage" page a few commits ago, but forgot to list it here. --- docs/settings.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/settings.rst b/docs/settings.rst index 47b1d33..5bfb0f2 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -8,6 +8,11 @@ Settings The HTTP header to extract the correlation id from. Default value: ``X_CORRELATION_ID`` + ``CID_RESPONSE_HEADER`` + The HTTP *response* header where the correlation id will be set. + Default value: same name as ``CID_HEADER``. Set to ``None`` if + you do not want the response to include the header. + ``CID_GENERATE`` Tell the cid middleware to generate a correlation id if it doesn't already exist. Default value: ``False``.