Document the request_json and request_raw functions and make them…

… part of the public API (#94)
JuliaHealth · Nov 25, 2020 · 96dfa88 · 96dfa88 · DilumAluthge · Nov 25, 2020
1 parent 6a4c0b8
commit 96dfa88
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/requests.jl b/src/requests.jl
@@ -86,6 +86,12 @@ end
     return full_url_uri
 end
 
+"""
+    request_raw(client, verb, path; query, body, headers)
+    request_raw(client, verb, path; query, headers)
+    request_raw(client, verb, path; body, headers)
+    request_raw(client, verb, path; headers)
+"""
 @inline function request_raw(client::Client,
                              verb::AbstractString,
                              path::AbstractString;
@@ -117,6 +123,12 @@ end
     return body_string
 end
 
+"""
+    request_json(client, verb, path; query, body, headers)
+    request_json(client, verb, path; query, headers)
+    request_json(client, verb, path; body, headers)
+    request_json(client, verb, path; headers)
+"""
 @inline function request_json(client::Client,
                               verb::AbstractString,
                               path::AbstractString;