serverless-openapi-documenter 0.0.110 → 0.0.112

package/README.md

@@ -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.110",
+  "version": "0.0.112",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -50,7 +50,6 @@
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
     "json-schema-for-openapi": "^0.5.0",
-    "lodash.isequal": "^4.5.0",
     "openapi-to-postmanv2": "^5.0.0",
     "uuid": "^11.1.0"
   },

package/src/definitionGenerator.js

@@ -1,5 +1,6 @@
 "use strict";
 
+const isEqual = require("node:util").isDeepStrictEqual;
 const path = require("path");
 
 const {
@@ -8,7 +9,6 @@ const {
   stringifyYaml,
   createConfig,
 } = require("@redocly/openapi-core");
-const isEqual = require("lodash.isequal");
 const { v4: uuid } = require("uuid");
 
 const SchemaHandler = require("./schemaHandler");
@@ -39,7 +39,11 @@ class DefinitionGenerator {
       },
     };
 
-    this.schemaHandler = new SchemaHandler(serverless, this.openAPI);
+    this.schemaHandler = new SchemaHandler(
+      serverless,
+      this.openAPI,
+      this.logger
+    );
 
     this.operationIdMap = {};
     this.functionMap = {};
@@ -81,7 +85,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/src/schemaHandler.js

@@ -1,14 +1,16 @@
 "use strict";
 
+const isEqual = require("node:util").isDeepStrictEqual;
 const path = require("path");
 
 const $RefParser = require("@apidevtools/json-schema-ref-parser");
 const SchemaConvertor = require("json-schema-for-openapi");
-const isEqual = require("lodash.isequal");
 const { v4: uuid } = require("uuid");
 
 class SchemaHandler {
-  constructor(serverless, openAPI) {
+  constructor(serverless, openAPI, logger) {
+    this.logger = logger;
+
     this.apiGatewayModels =
       serverless.service?.provider?.apiGateway?.request?.schemas || {};
     this.documentation = serverless.service.custom.documentation;
@@ -19,6 +21,12 @@ class SchemaHandler {
     this.__standardiseModels();
 
     try {
+      this.logger.verbose(
+        `Trying to resolve Ref-Parser config from: ${path.resolve(
+          "options",
+          "ref-parser.js"
+        )}`
+      );
       this.refParserOptions = require(path.resolve("options", "ref-parser.js"));
     } catch (err) {
       this.refParserOptions = {};
@@ -63,6 +71,7 @@ class SchemaHandler {
       const modelName = model.name;
       const modelSchema = model.schema;
 
+      this.logger.verbose(`dereferencing model: ${model.name}`);
       const dereferencedSchema = await this.__dereferenceSchema(
         modelSchema
       ).catch((err) => {
@@ -76,6 +85,7 @@ class SchemaHandler {
         return modelSchema;
       });
 
+      this.logger.verbose(`convering model: ${model.name}`);
       const convertedSchemas = SchemaConvertor.convert(
         dereferencedSchema,
         modelName

package/test/helpers/redocly.json

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

package/test/unit/openAPIGenerator.spec.js

@@ -57,6 +57,7 @@ describe("OpenAPIGenerator", () => {
         notice: (str) => {},
         error: (str) => {},
         success: (str) => {},
+        verbose: (str) => {},
       },
     };
   });