Skip to content

Commit

Permalink
docs(pdk): fix missing doc for set_header related pdk (#12249)
Browse files Browse the repository at this point in the history
fix missing doc for #12164
  • Loading branch information
oowl authored Dec 26, 2023
1 parent 75ee3a0 commit 6e91c99
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions kong/pdk/response.lua
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ local function new(self, major_version)
-- @function kong.response.set_header
-- @phases rewrite, access, header_filter, response, admin_api
-- @tparam string name The name of the header
-- @tparam string|number|boolean value The new value for the header.
-- @tparam array of strings|string|number|boolean value The new value for the header.
-- @return Nothing; throws an error on invalid input.
-- @usage
-- kong.response.set_header("X-Foo", "value")
Expand Down Expand Up @@ -445,7 +445,7 @@ local function new(self, major_version)
-- @function kong.response.add_header
-- @phases rewrite, access, header_filter, response, admin_api
-- @tparam string name The header name.
-- @tparam string|number|boolean value The header value.
-- @tparam array of strings|string|number|boolean value The header value.
-- @return Nothing; throws an error on invalid input.
-- @usage
-- kong.response.add_header("Cache-Control", "no-cache")
Expand Down
4 changes: 2 additions & 2 deletions kong/pdk/service/request.lua
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ local function new(self)
-- @function kong.service.request.set_header
-- @phases `rewrite`, `access`, `balancer`
-- @tparam string header The header name. Example: "X-Foo".
-- @tparam string|boolean|number value The header value. Example: "hello world".
-- @tparam array of strings|string|boolean|number value The header value. Example: "hello world".
-- @return Nothing; throws an error on invalid inputs.
-- @usage
-- kong.service.request.set_header("X-Foo", "value")
Expand Down Expand Up @@ -323,7 +323,7 @@ local function new(self)
-- @function kong.service.request.add_header
-- @phases `rewrite`, `access`
-- @tparam string header The header name. Example: "Cache-Control".
-- @tparam string|number|boolean value The header value. Example: "no-cache".
-- @tparam array of strings|string|number|boolean value The header value. Example: "no-cache".
-- @return Nothing; throws an error on invalid inputs.
-- @usage
-- kong.service.request.add_header("Cache-Control", "no-cache")
Expand Down

0 comments on commit 6e91c99

Please sign in to comment.