From e3943893f760321b8c32d814112facae38e37743 Mon Sep 17 00:00:00 2001 From: kyle Date: Thu, 26 Oct 2017 15:03:14 -0700 Subject: [PATCH] Update interceptor documentation For #3830 --- docs/usage/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 7ff75c58..205f51d3 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -25,6 +25,6 @@ displayRequestDuration | Controls the display of the request duration (in millis maxDisplayedTags | If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations. filter | If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be true/false to enable or disable, or an explicit filter string in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. deepLinking | If set to `true`, enables dynamic deep linking for tags and operations. [Docs](https://github.com/swagger-api/swagger-ui/blob/master/docs/deep-linking.md) -requestInterceptor | MUST be a function. Function to intercept try-it-out requests. Accepts one argument requestInterceptor(request) and must return the potentially modified request. -responseInterceptor | MUST be a function. Function to intercept try-it-out responses. Accepts one argument responseInterceptor(response) and must return the potentially modified response. +requestInterceptor | MUST be a function. Function to intercept document fetching and try-it-out requests. Accepts one argument requestInterceptor(request) and MUST return the potentially modified request. +responseInterceptor | MUST be a function. Function to intercept document fetching and try-it-out responses. Accepts one argument responseInterceptor(response) and MUST return the potentially modified response. showMutatedRequest | If set to `true` (the default), uses the mutated request returned from a rquestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used.