changeset 2259:9644ecb67081

Unified description of njs r.requestBody with perl request_body.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 19 Oct 2018 16:03:24 +0300
parents 2c8c10f00518
children 4e53813fbe21
files xml/en/docs/njs/reference.xml
diffstat 1 files changed, 9 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/njs/reference.xml
+++ b/xml/en/docs/njs/reference.xml
@@ -9,7 +9,7 @@
 <article name="Reference"
         link="/en/docs/njs/reference.html"
         lang="en"
-        rev="10">
+        rev="11">
 
 <section id="summary">
 
@@ -102,9 +102,15 @@ references the parent request object
 client address, read-only
 </tag-desc>
 
-<tag-name><literal>r.requestBody</literal></tag-name>
+<tag-name id="r_request_body"><literal>r.requestBody</literal></tag-name>
 <tag-desc>
-holds the request body, read-only
+returns the client request body if it has not been
+written to a temporary file.
+To ensure that the client request body is in memory,
+its size should be limited by
+<link doc="../http/ngx_http_core_module.xml" id="client_max_body_size"/>,
+and a sufficient buffer size should be set using
+<link doc="../http/ngx_http_core_module.xml" id="client_body_buffer_size"/>.
 </tag-desc>
 
 <tag-name><literal>r.responseBody</literal></tag-name>