Skip to content

Commit

Permalink
docs(api) document header regex in autodocs admin api (#8572)
Browse files Browse the repository at this point in the history
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
  • Loading branch information
kikito and lena-larionova committed Apr 6, 2022
1 parent 0855e00 commit bca5b02
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions autodoc/admin-api/data/admin-api.lua
Original file line number Diff line number Diff line change
Expand Up @@ -984,6 +984,8 @@ return {
match if present in the request.
The `Host` header cannot be used with this attribute: hosts should be specified
using the `hosts` attribute.
When `headers` contains only one value and that value starts with
the special prefix `~*`, the value is interpreted as a regular expression.
]],
examples = { { ["x-my-header"] = {"foo", "bar"}, ["x-another-header"] = {"bla"} }, nil },
skip_in_example = true, -- hack so we get HTTP fields in the first example and Stream fields in the second
Expand Down

0 comments on commit bca5b02

Please sign in to comment.