From 609295fd06af640ef546d2800b4c5d55281060a1 Mon Sep 17 00:00:00 2001 From: Jaromir Obr Date: Wed, 31 Aug 2022 18:41:26 +0200 Subject: [PATCH 1/2] REST: Changed endpoint to optional REST API methods can be called with absolute URL ("https://") and therefore the property "endpoint" doesn't need to be specified in general --- lib/helper/REST.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/helper/REST.js b/lib/helper/REST.js index 2f7e880de..9dbaa1295 100644 --- a/lib/helper/REST.js +++ b/lib/helper/REST.js @@ -9,7 +9,7 @@ const { beautify } = require('../utils'); * * @typedef RESTConfig * @type {object} - * @prop {string} endpoint - API base URL + * @prop {string} [endpoint] - API base URL * @prop {boolean} [prettyPrintJson=false] - pretty print json for response/request on console logs * @prop {number} [timeout=1000] - timeout for requests in milliseconds. 10000ms by default * @prop {object} [defaultHeaders] - a list of default headers From a3dab5742f48258cd53baab6692b73c3d7224bf9 Mon Sep 17 00:00:00 2001 From: Jaromir Obr Date: Tue, 13 Sep 2022 20:00:46 +0200 Subject: [PATCH 2/2] Fixed REST helper docs --- docs/helpers/REST.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/helpers/REST.md b/docs/helpers/REST.md index b5b3c50ea..be5a91bc7 100644 --- a/docs/helpers/REST.md +++ b/docs/helpers/REST.md @@ -22,7 +22,7 @@ Type: [object][4] ### Properties -- `endpoint` **[string][3]** API base URL +- `endpoint` **[string][3]?** API base URL - `prettyPrintJson` **[boolean][6]?** pretty print json for response/request on console logs - `timeout` **[number][5]?** timeout for requests in milliseconds. 10000ms by default - `defaultHeaders` **[object][4]?** a list of default headers