tracker issue : CF-3859391

select a category, or use search below
(searches all categories and all time range)
Title:

[ANeff] Doc Bug for: getHTTPRequestData(true|false) undocumented boolean parameter

| View in Tracker

Status/Resolution/Reason: Closed/Fixed/

Reporter/Name(from Bugbase): Aaron Neff / Aaron Neff (Aaron Neff)

Created: 11/28/2014

Components: Documentation

Versions: 11.0

Failure Type:

Found In Build/Fixed In Build: CF11_Final /

Priority/Frequency: Minor / Some users will encounter

Locale/System: ALL / Platforms All

Vote Count: 0

Listed in the version 2016.0.0.297996 Issues Fixed doc
Verification notes: verified_fixed on November 23, 2015 using build 2016.0.01.298513 
getHTTPRequestData() accepts a boolean parameter, but it is undocumented.

I previously referred to it here: #3042675

Adobe refers to it here: #3581691 (getHTTPRequestData() steals request body and leaves <cfhttp> empty-handed, due to switch from JRun to Tomcat - marked NotABug)

This boolean parameter should be documented, and the #3581691 regression should be re-opened and fixed.

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3859391

External Customer Info:
External Company:  
External Customer Name: itisdesign
External Customer Email:

Attachments:

Comments:

* <cfhttp> should've been REST
Comment by External U.
9888 | November 28, 2014 07:37:26 PM GMT
Regarding getHTTPRequestData() accepting paramter, moving this bug to "ToFix", but #CF-3581691, is still NotABug, as once the body of the request data is retrieved, it can not read it again.
Comment by HariKrishna K.
9889 | December 08, 2014 06:09:00 AM GMT
Hi Hari, Yeah CF-3581691 is a backward-compat bug. You can't just switch the underlying engine from JRun to Tomcat and then say everything that broke is not a bug. CF-3581691 worked in JRun but broke in Tomcat (and that breaking change was never documented either - ppl were left to stumble into it on their own). Thanks!, -Aaron
Comment by External U.
9890 | September 23, 2015 12:29:49 PM GMT
[jayakarr]: Changes: reason=Fixed
Comment by Weasley B.
9891 | September 23, 2015 09:39:57 PM GMT
Hi Adobe, I see GetHttpRequestData()'s "Usage" section was updated (good/thanks!), but it's "Syntax" section wasn't updated. Also, a "Parameters" section was not created. Should I file a ticket for the following suggestions, or can they be considered as part of this ticket?: Function syntax ======================= GetHttpRequestData(includeBody) Parameters ======================= Parameter | Description ----------------------- includeBody | A boolean value specifying whether to retrieve the body of the request. The default is false. Thanks!, -Aaron
Comment by External U.
9892 | November 13, 2015 01:12:35 AM GMT
Updated content available here now: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-functions/functions-e-g/gethttprequestdata.html
Comment by Jacob J.
9893 | November 13, 2015 03:13:19 AM GMT
Hi Jacob, Thanks for updating the doc! But there is still an issue: The function does not take 2 parameters. The function only takes 1 parameter; thus, the parameters section should only list 1 parameter. And, for consistency w/ the other CF docs, the syntax section should only list parameters (it shouldn't list possible parameter values). See what I mean? Thanks!, -Aaron
Comment by External U.
9894 | November 13, 2015 04:45:33 AM GMT
Thanks Aaron, I have updated it accordingly.
Comment by Jacob J.
9895 | November 13, 2015 05:13:09 AM GMT
Hi Jacob, Thanks for updating the doc. The description should mention that true is the default. Also, it shouldn't be called the "false parameter" since it also accepts true. How about naming it "includeBody"? As in: GetHttpRequestData(includeBody) How about this description?: -------------------------------------------- A boolean value specifying whether to retrieve the body of the request. Once it is retrieved, it cannot be read again. The default is true. If you need to retrieve anything other than body from the request, use GetHttpRequestData(false). -------------------------------------------- Then that same wording beneath "Usage" could be removed. Since this is a breaking change introduced in CF10, a History section should be added: -------------------------------------------- - ColdFusion 10: Once the body of the request is retrieved, it cannot be read again. This was possible in JRun but not in Tomcat. -------------------------------------------- Thanks!, -Aaron
Comment by External U.
9896 | November 14, 2015 04:28:00 PM GMT
*bump* GetHttpRequestData(true) is also valid. The documentation should clarify that true is the default value. The function doesn't take a "false" parameter. It takes a parameter that accepts true or false. Thanks!, -Aaron
Comment by External U.
9897 | November 16, 2015 02:31:10 AM GMT
Hi Jacob, I see the doc has been updated. Thanks very much! -Aaron
Comment by External U.
9898 | November 23, 2015 05:45:45 AM GMT