Skip to content

Commit

Permalink
docs(autodoc) add missing entries for new upstream fields (Kong#8903)
Browse files Browse the repository at this point in the history
  • Loading branch information
flrgh authored Jun 6, 2022
1 parent 7ef980d commit 43477a0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
4 changes: 4 additions & 0 deletions autodoc/admin-api/data/admin-api.lua
Original file line number Diff line number Diff line change
Expand Up @@ -1576,6 +1576,10 @@ return {
["hash_fallback_header"] = { kind = "semi-optional", skip_in_example = true, description = [[The header name to take the value from as hash input. Only required when `hash_fallback` is set to `header`.]] },
["hash_on_cookie"] = { kind = "semi-optional", skip_in_example = true, description = [[The cookie name to take the value from as hash input. Only required when `hash_on` or `hash_fallback` is set to `cookie`. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.]] },
["hash_on_cookie_path"] = { kind = "semi-optional", skip_in_example = true, description = [[The cookie path to set in the response headers. Only required when `hash_on` or `hash_fallback` is set to `cookie`.]] },
["hash_on_query_arg"] = { kind = "semi-optional", skip_in_example = true, description = [[The name of the query string argument to take the value from as hash input. Only required when `hash_on` is set to `query_arg`.]] },
["hash_fallback_query_arg"] = { kind = "semi-optional", skip_in_example = true, description = [[The name of the query string argument to take the value from as hash input. Only required when `hash_fallback` is set to `query_arg`.]] },
["hash_on_uri_capture"] = { kind = "semi-optional", skip_in_example = true, description = [[The name of the route URI capture to take the value from as hash input. Only required when `hash_on` is set to `uri_capture`.]] },
["hash_fallback_uri_capture"] = { kind = "semi-optional", skip_in_example = true, description = [[The name of the route URI capture to take the value from as hash input. Only required when `hash_fallback` is set to `uri_capture`.]] },
["host_header"] = { description = [[The hostname to be used as `Host` header when proxying requests through Kong.]], example = "example.com", },
["client_certificate"] = { description = [[If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.]] },
["healthchecks.active.timeout"] = { description = [[Socket timeout for active health checks (in seconds).]] },
Expand Down
2 changes: 2 additions & 0 deletions autodoc/admin-api/openapi-gen.lua
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
setmetatable(_G, nil) -- silence OpenResty's global var warnings

local admin_api_data = require "autodoc.admin-api.data.admin-api"
local kong_meta = require "kong.meta"
local lfs = require "lfs"
Expand Down

0 comments on commit 43477a0

Please sign in to comment.