http: update request example

OpenFn · Jan 12, 2024 · 7094b2e · 7094b2e
1 parent 64debfe
commit 7094b2e
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/packages/http/src/Adaptor.js b/packages/http/src/Adaptor.js
@@ -47,10 +47,14 @@ export function execute(...operations) {
  * Make a HTTP request
  * @public
  * @example
- * get('/myEndpoint', {
- *   query: {foo: 'bar', a: 1},
- *   headers: {'content-type': 'application/json'},
- * })
+ * request(
+ *   'GET',
+ *   '/myEndpoint',
+ *    {
+ *      query: {foo: 'bar', a: 1},
+ *      headers: {'content-type': 'application/json'},
+ *    }
+ * )
  * @function
  * @param {string} method - The HTTP method to use
  * @param {string} path - Path to resource