serverless-openapi-documenter 0.0.109 → 0.0.111

package/README.md

@@ -12,13 +12,13 @@
   </a>
 </p>
 
-This will generate an OpenAPI V3 (up to v3.0.3) file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) from the OpenAPI file for you too. This currently works for `http` and `httpApi` configurations.
+This will generate an OpenAPI V3 (up to v3.0.4) file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) from the OpenAPI file for you too. This currently works for `http` and `httpApi` configurations.
 
 Originally based off of: https://github.com/temando/serverless-openapi-documentation
 
 ## Install
 
-This plugin works for Serverless (2.x, 3.x and 4.x) and only supports node.js 14 and up.
+This plugin works for Serverless (2.x, 3.x and 4.x) and only supports node.js 20 and up.
 
 To add this plugin to your package.json:
 
@@ -39,7 +39,7 @@ plugins:
 
 ## Adding documentation to serverless
 
-To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.3 -p postman.json`
+To Run: `serverless openapi generate -o openapi.json -f json -a 3.0.4 -p postman.json`
 
 Options:
 
@@ -316,7 +316,7 @@ custom:
         in: header
 ```
 
-It accepts all available Security Schemes and follows the specification: https://spec.openapis.org/oas/v3.0.3#security-scheme-object
+It accepts all available Security Schemes and follows the specification: https://spec.openapis.org/oas/v3.0.4#security-scheme-object
 
 #### Security on each operation
 
@@ -904,7 +904,7 @@ getContent:
 
 You can refer to the `operationId` that you created.
 
-You can read more about [links](https://swagger.io/docs/specification/links/) on the swagger.io site and in the [OpenAPI](https://spec.openapis.org/oas/v3.0.3#link-object) specification. They don't seem widely supported just yet, but perhaps they'll improve your documentation.
+You can read more about [links](https://swagger.io/docs/specification/links/) on the swagger.io site and in the [OpenAPI](https://spec.openapis.org/oas/v3.0.4#link-object) specification. They don't seem widely supported just yet, but perhaps they'll improve your documentation.
 
 ##### `responseHeaders`
 
@@ -1009,18 +1009,18 @@ I am making use of https://www.npmjs.com/package/@redocly/openapi-core, which I
 
 I have configured the validator to use these Rules:
 
-- [spec](https://redocly.com/docs/cli/rules/spec/)
-- [path-parameters-defined](https://redocly.com/docs/cli/rules/path-parameters-defined/)
-- [operation-2xx-response](https://redocly.com/docs/cli/rules/operation-2xx-response/)
-- [operation-4xx-response](https://redocly.com/docs/cli/rules/operation-4xx-response/)
-- [operation-operationId-unique](https://redocly.com/docs/cli/rules/operation-operationid-unique/)
-- [path-declaration-must-exist](https://redocly.com/docs/cli/rules/path-declaration-must-exist/)
+- [struct](https://redocly.com/docs/cli/rules/oas/struct)
+- [path-parameters-defined](https://redocly.com/docs/cli/rules/oas/path-parameters-defined)
+- [operation-2xx-response](https://redocly.com/docs/cli/rules/oas/operation-2xx-response)
+- [operation-4xx-response](https://redocly.com/docs/cli/rules/oas/operation-4xx-response)
+- [operation-operationId-unique](https://redocly.com/docs/cli/rules/oas/operation-operationId-unique)
+- [path-declaration-must-exist](https://redocly.com/docs/cli/rules/oas/path-declaration-must-exist)
 
 However, you can configure your own rules from the [ruleset available on the Redocly site](https://redocly.com/docs/cli/rules/built-in-rules/). To do this, you will need to create a `redocly.json` file within an `options` folder. The file should look like:
 
 ```json
 {
-  "spec": "error",
+  "struct": "error",
   "path-parameters-defined": "error",
   "operation-2xx-response": "error",
   "operation-4xx-response": "error",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.109",
+  "version": "0.0.111",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -51,17 +51,16 @@
     "js-yaml": "^4.1.0",
     "json-schema-for-openapi": "^0.5.0",
     "lodash.isequal": "^4.5.0",
-    "openapi-to-postmanv2": "^4.24.0",
-    "swagger2openapi": "^7.0.8",
-    "uuid": "^10.0.0"
+    "openapi-to-postmanv2": "^5.0.0",
+    "uuid": "^11.1.0"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "devDependencies": {
     "chai": "^4.5.0",
-    "mocha": "^10.7.3",
-    "nock": "^13.5.5",
-    "sinon": "^19.0.2"
+    "mocha": "^11.1.0",
+    "nock": "^14.0.2",
+    "sinon": "^20.0.0"
   }
 }

package/src/definitionGenerator.js

@@ -81,7 +81,7 @@ class DefinitionGenerator {
       this.REDOCLY_RULES = require(path.resolve("options", "redocly.json"));
     } catch (err) {
       this.REDOCLY_RULES = {
-        spec: "error",
+        struct: "error",
         "path-parameters-defined": "error",
         "operation-2xx-response": "error",
         "operation-4xx-response": "error",

package/test/helpers/redocly.json

@@ -1,4 +1,4 @@
 {
-  "spec": "error",
+  "struct": "error",
   "operation-2xx-response": "warn"
 }

package/test/unit/openAPIGenerator.spec.js

@@ -237,7 +237,9 @@ describe("OpenAPIGenerator", () => {
     it("should throw an error when writing a file fails", function () {
       const errStub = sinon.stub(logOutput.log, "error").returns("");
       const succSpy = sinon.spy(logOutput.log, "success");
-      const fsStub = sinon.stub(fs, "writeFileSync").throws(new Error());
+      const fsStub = sinon
+        .stub(fs, "writeFileSync")
+        .throws(new Error("throwing an error from writeFileSync"));
       const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
       openAPIGenerator.processCliInput();
 
@@ -258,7 +260,7 @@ describe("OpenAPIGenerator", () => {
       const errStub = sinon.spy(logOutput.log, "error");
       const succSpy = sinon.spy(logOutput.log, "success");
       const pgStub = sinon.stub(PostmanGenerator, "convert");
-      pgStub.yields(new Error());
+      pgStub.yields(new Error("throwing an error from PostmanGenerator"));
 
       const openAPIGenerator = new OpenAPIGenerator(sls, {}, logOutput);
       openAPIGenerator.processCliInput();