add more detail

changelog/unreleased/kong/feat-pdk-unlimited-body-size.yml

@@ -1,3 +1,3 @@
-message: Added negative value to support unlimited body size.
+message: Added negative value to support unlimited body size. When parameter `max_allowed_file_size` is negative, `get_raw_body` will return the entire body, but the size of this body will still be limited by Nginx's `client_max_body_size`.
 type: feature
 scope: PDK

kong/pdk/request.lua

@@ -702,7 +702,8 @@ local function new(self)
   -- @function kong.request.get_raw_body
   -- @phases rewrite, access, response, admin_api
   -- @max_allowed_file_size[opt] number the max allowed file size to be read from,
-  -- less than zero mean no limit.
+  -- less than zero mean no limit, but the size of this body will still be limited
+  -- by Nginx's client_max_body_size.
   -- @treturn string|nil The plain request body or nil if it does not fit into
   -- the NGINX temporary buffer.
   -- @treturn nil|string An error message.