codeceptjs 2.3.4 → 2.4.1

package/docs/helpers/REST.md

@@ -1,5 +1,7 @@
 ---
-id: REST
+permalink: /helpers/REST
+editLink: false
+sidebar: auto
 title: REST
 ---
 
@@ -7,7 +9,7 @@ title: REST
 
 ## REST
 
-Extends Helper
+**Extends Helper**
 
 REST helper allows to send additional requests to the REST API during acceptance tests.
 [Axios][1] library is used to perform requests.
@@ -22,11 +24,14 @@ REST helper allows to send additional requests to the REST API during acceptance
 ## Example
 
 ```js
-REST: {
-   endpoint: 'http://site.com/api',
-   onRequest: (request) => {
-     request.headers.auth = '123';
-   }
+{
+  helpers: {
+    REST: {
+      endpoint: 'http://site.com/api',
+      onRequest: (request) => {
+      request.headers.auth = '123';
+    }
+  }
 }
 ```
 
@@ -47,21 +52,21 @@ this.helpers['REST']._executeRequest({
 
 -   `config`  
 
-### \_executeRequest
+### _executeRequest
 
 Executes axios request
 
 #### Parameters
 
--   `request` any 
+-   `request` **any** 
 
-### \_url
+### _url
 
 Generates url based on format sent (takes endpoint + url if latter lacks 'http')
 
 #### Parameters
 
--   `url` any 
+-   `url` **any** 
 
 ### sendDeleteRequest
 
@@ -73,8 +78,8 @@ I.sendDeleteRequest('/api/users/1');
 
 #### Parameters
 
--   `url` any 
--   `headers` [object][2]  
+-   `url` **any** 
+-   `headers` **[object][2]**  
 
 ### sendGetRequest
 
@@ -86,8 +91,8 @@ I.sendGetRequest('/api/users.json');
 
 #### Parameters
 
--   `url` any 
--   `headers` [object][2]  
+-   `url` **any** 
+-   `headers` **[object][2]**  
 
 ### sendPatchRequest
 
@@ -99,9 +104,9 @@ I.sendPatchRequest('/api/users.json', { "email": "user@user.com" });
 
 #### Parameters
 
--   `url` [string][3] 
--   `payload` [object][2] 
--   `headers` [object][2]  
+-   `url` **[string][3]** 
+-   `payload` **[object][2]** 
+-   `headers` **[object][2]**  
 
 ### sendPostRequest
 
@@ -113,9 +118,9 @@ I.sendPostRequest('/api/users.json', { "email": "user@user.com" });
 
 #### Parameters
 
--   `url` any 
--   `payload` any  
--   `headers` [object][2]  
+-   `url` **any** 
+-   `payload` **any**  
+-   `headers` **[object][2]**  
 
 ### sendPutRequest
 
@@ -127,9 +132,9 @@ I.sendPutRequest('/api/users.json', { "email": "user@user.com" });
 
 #### Parameters
 
--   `url` [string][3] 
--   `payload` [object][2]  
--   `headers` [object][2]  
+-   `url` **[string][3]** 
+-   `payload` **[object][2]**  
+-   `headers` **[object][2]**  
 
 ### setRequestTimeout