Document Response-Map special header

samrocketman · Oct 27, 2023 · cc0ce64 · cc0ce64
1 parent 300e32b
commit cc0ce64
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/main/groovy/net/gleske/jervis/remotes/SimpleRestService.groovy b/src/main/groovy/net/gleske/jervis/remotes/SimpleRestService.groovy
@@ -206,6 +206,13 @@ class SimpleRestService {
         <tt>Response-Code</tt> to <tt>false</tt>.  The <tt>HEAD</tt> HTTP
         method implies returning response headers.
       </dd>
+      <dd>
+        <tt>Response-Map</tt> - Return a HashMap containing
+        <tt>response_code</tt>, <tt>response_headers</tt>,
+        <tt>response_content</tt>, and <tt>error</tt> keys.  <tt>error</tt>
+        will return <tt>true</tt> if <tt>response_code</tt> is a 4XX or 5XX
+        HTTP code.
+      </dd>
       </dl>
 
       @param api_url A URL of a REST endpoint in which to make an HTTP call.