summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjamesc <james@opscode.com>2013-11-20 14:58:27 -0800
committerjamesc <james@opscode.com>2013-11-20 14:58:27 -0800
commit5c7cd1eaa71954156e3e40dc17918a4dae86a4ce (patch)
tree26cbccc65bf00a158e86cbff2b5ac29975d70b76
parentdb7e67ab8c13a32413bc53c4d985c6f7685fa0b6 (diff)
downloadchef-5c7cd1eaa71954156e3e40dc17918a4dae86a4ce.tar.gz
add a doc comment on the purpose of raw_http_request
-rw-r--r--lib/chef/rest.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/chef/rest.rb b/lib/chef/rest.rb
index 721c396a61..04ee0b0cb2 100644
--- a/lib/chef/rest.rb
+++ b/lib/chef/rest.rb
@@ -124,6 +124,9 @@ class Chef
alias :api_request :request
+ # Do a HTTP request where no middleware is loaded (e.g. JSON input/output
+ # conversion) but the standard Chef Authentication headers are added to the
+ # request.
def raw_http_request(method, path, headers, data)
url = create_url(path)
method, url, headers, data = @authenticator.handle_request(method, url, headers, data)