chore(pdk): doc a known issue of get_headers()

Adressing KAG-2602, #11546
Kong · Nov 13, 2023 · 9159217 · 9159217
1 parent 8d0f9d2
commit 9159217
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/kong/pdk/service/response.lua b/kong/pdk/service/response.lua
@@ -198,6 +198,8 @@ local function new(pdk, major_version)
   --   kong.log.inspect(headers.x_another[1])    -- "foo bar"
   --   kong.log.inspect(headers["X-Another"][2]) -- "baz"
   -- end
+  -- Note that this function returns a proxy table
+  -- which cannot be iterated with pairs or used as oprand of #.
   function response.get_headers(max_headers)
     check_phase(header_body_log)