Skip to content

Commit

Permalink
Fix: Exit Transformer plugin handle_unknown description (#7848)
Browse files Browse the repository at this point in the history
correct the description of handle_unknown
  • Loading branch information
lena-larionova authored Sep 5, 2024
1 parent 709e99d commit 70eed9b
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions app/_hub/kong-inc/exit-transformer/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ environment.
## Transforming 4xx and 5xx Responses

By default, the Exit Transformer is only applied to requests that match its
criteria (its Route or Service matching configuration) or globally within a Workspace.
criteria (its route or service matching configuration) or globally within a workspace.

### Handling Unmatched 400 and 404 Responses

Expand All @@ -25,14 +25,16 @@ within any specific Workspace, and standard plugin criteria will never match tho
responses. You can designate Exit Transformer configurations that _do_ handle these
responses by enabling the `handle_unexpected` (400) and `handle_unknown` (404) settings:

- The `handle_unknown` parameter should only be enabled on a single plugin configuration.
- The `handle_unexpected` parameter can be enabled on as many plugin configurations
as you want.
- The `handle_unknown` parameter must be used on a
[globally configured instance of the plugin](/hub/kong-inc/exit-transformer/how-to/basic-example/?tab=enable-globally)
running in the default workspace, and only takes effect when a 404 error occurs.
- The `handle_unexpected` parameter can be enabled for any plugin configuration -
on a service, on a route, and so on. It only takes effect when a 400 error occurs.

It's not a prerequisite for `handle_unexpected` to also have `handle_unknown` set,
if an unexpected error happened within some known Service or Route context. If a
if an unexpected error happened within some known service or route context. If a
configuration has both `handle_unknown` and `handle_unexpected` enabled, then an
unexpected error on an _unknown_ Service or Route will pass through the Exit Transformer plugin.
unexpected error on an _unknown_ service or route will pass through the Exit Transformer plugin.

### HTTP Response Status Codes {#http-msgs}

Expand Down

0 comments on commit 70eed9b

Please sign in to comment.