@mimik/api-helper 2.0.9 → 3.0.0

package/README.md

@@ -55,7 +55,7 @@ The default formats for validation are: `date`, `time`, `date-time`, `byte`, `uu
 <a name="module_api-helper..getAPIFile"></a>
 
 ### api-helper~getAPIFile(apiFilename, correlationId, options) ⇒ <code>Promise.&lt;object&gt;</code>
-Gets the API file from swaggerhub and store it in the given PATH location.
+Gets the API file from swaggerhub and stores it in the given PATH location.
 
 **Kind**: inner method of [<code>api-helper</code>](#module_api-helper)  
 **Returns**: <code>Promise.&lt;object&gt;</code> - The API file itself.  
@@ -72,7 +72,7 @@ Gets the API file from swaggerhub and store it in the given PATH location.
      "username": "username for bitbucket",
      "password": "password for bitbucket"
    },
-   "apiApiKey": "apiKey for access private API on swaggerhub, can be optional if the API is accessible publicly"
+   "apiApiKey": "apiKey to access private API on swaggerhub, can be optional if the API is accessible publicly"
 }
 ```
 

package/index.js

@@ -228,7 +228,7 @@ const buildProviderRequest = (params, apiInfo, apiFilename) => {
 
 /**
  *
- * Gets the API file from swaggerhub and store it in the given PATH location.
+ * Gets the API file from swaggerhub and stores it in the given PATH location.
  *
  * @function getAPIFile
  * @category async
@@ -252,7 +252,7 @@ const buildProviderRequest = (params, apiInfo, apiFilename) => {
  *      "username": "username for bitbucket",
  *      "password": "password for bitbucket"
  *    },
- *    "apiApiKey": "apiKey for access private API on swaggerhub, can be optional if the API is accessible publicly"
+ *    "apiApiKey": "apiKey to access private API on swaggerhub, can be optional if the API is accessible publicly"
  * }
  * ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/api-helper",
-  "version": "2.0.9",
+  "version": "3.0.0",
   "description": "helper for openAPI backend and mimik service",
   "main": "./index.js",
   "type": "module",
@@ -29,7 +29,7 @@
   "dependencies": {
     "@mimik/request-retry": "^4.0.9",
     "@mimik/response-helper": "^4.0.10",
-    "@mimik/sumologic-winston-logger": "^2.1.13",
+    "@mimik/sumologic-winston-logger": "^2.1.14",
     "@mimik/swagger-helper": "^5.0.3",
     "ajv-formats": "3.0.1",
     "js-base64": "3.7.8",
@@ -42,7 +42,7 @@
     "@eslint/js": "9.32.0",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
     "@stylistic/eslint-plugin": "5.9.0",
-    "c8": "10.1.3",
+    "c8": "11.0.0",
     "chai": "6.2.2",
     "eslint": "9.32.0",
     "eslint-plugin-import": "2.32.0",

package/test/oauthValidation-helper.test.js

@@ -115,7 +115,7 @@ describe('oauthValidation-helper', () => {
       expect(validateApiKey(schemes, 'ApiKeySecurity')).to.equal('ApiKeySecurity');
     });
 
-    it('should throw when in is not header', () => {
+    it('should throw when not in header', () => {
       const schemes = {
         ApiKeySecurity: { in: 'query', name: 'apiKey' },
       };