diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/development_middleware.rst | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/source/development_middleware.rst b/doc/source/development_middleware.rst index 24d6fb7c7..1f7e9e369 100644 --- a/doc/source/development_middleware.rst +++ b/doc/source/development_middleware.rst @@ -178,13 +178,25 @@ Middleware may advertize its availability and capabilities via Swift's :ref:`discoverability` support by using :func:`.register_swift_info`:: - from swift.common.utils import register_swift_info + from swift.common.registry import register_swift_info def webhook_factory(global_conf, **local_conf): register_swift_info('webhook') def webhook_filter(app): return WebhookMiddleware(app) return webhook_filter +If a middleware handles sensitive information in headers or query parameters +that may need redaction when logging, use the :func:`.register_sensitive_header` +and :func:`.register_sensitive_param` functions. This should be done in the +filter factory:: + + from swift.common.registry import register_sensitive_header + def webhook_factory(global_conf, **local_conf): + register_sensitive_header('webhook-api-key') + def webhook_filter(app): + return WebhookMiddleware(app) + return webhook_filter + -------------- Swift Metadata |