serverless-openapi-documenter 0.0.124-beta.1 → 0.0.124

package/README.md

@@ -12,9 +12,7 @@
   </a>
 </p>
 
-This will generate an OpenAPI V3 (up to v3.0.4) Document file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) or (as of 0.0.120) [Bruno Collection](https://docs.usebruno.com/) from the OpenAPI file. This currently works for `http` and `httpApi` configurations.
-
-If you are using the beta of 0.0.115, it will now try and create [OpenAPI V3.1 (3.1.x)](https://spec.openapis.org/oas/v3.1.0.html) Document for you, should you run the command `serverless openapi generate -o openapi.json -f json -a 3.1.1 -p postman.json`. Please see this [guide on migrating to V3.1](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). Whilst I perosnally use this plugin all the time, please do open and report bugs, and I will do my best to fix them.
+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) or (as of 0.0.120) [Bruno Collection](https://docs.usebruno.com/) from the OpenAPI file. This currently works for `http` and `httpApi` configurations.
 
 Originally based off of: https://github.com/temando/serverless-openapi-documentation
 
@@ -1111,7 +1109,7 @@ module.exports = {
   dereference: {
     circular: false, // Don't allow circular $refs
     excludedPathMatcher: (
-      path, // Skip dereferencing content under any 'example' key
+      path // Skip dereferencing content under any 'example' key
     ) => path.includes("/example/"),
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.124-beta.1",
+  "version": "0.0.124",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -49,8 +49,8 @@
   "license": "MIT",
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.1.0",
+    "@redocly/openapi-core": "^1.2.0",
     "@usebruno/converters": "^0.16.0",
-    "@redocly/openapi-core": "^1.34.5",
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.1",
     "json-schema-for-openapi": "^0.5.0",

package/src/definitionGenerator.js

@@ -713,7 +713,6 @@ class DefinitionGenerator {
         }
 
         if (contentKey) {
-
           const obj = {};
           let schema;
           if (mediaTypeDocumentation.content) {
@@ -734,7 +733,9 @@ class DefinitionGenerator {
             }
 
             if (mediaTypeDocumentation.examples) {
-              obj.example = mediaTypeDocumentation.examples;
+              obj.examples = this.createExamples(
+                mediaTypeDocumentation.examples
+              );
             }
 
             schema = mediaTypeDocumentation.schema;

package/src/schemaHandler.js

@@ -16,12 +16,6 @@ class SchemaHandler {
     this.documentation = serverless.service.custom.documentation;
     this.openAPI = openAPI;
 
-    this.shouldConvert = true;
-    if (/(3\.1\.\d)/g.test(this.openAPI.openapi)) this.shouldConvert = false;
-
-    this.logger.verbose(`OpenAPI version: ${this.openAPI.openapi}`);
-    this.logger.verbose(`Convert Schemas: ${this.shouldConvert}`);
-
     this.modelReferences = {};
 
     this.__standardiseModels();
@@ -59,7 +53,7 @@ class SchemaHandler {
         model.schema = null;
         model.schemas = {};
         for (const key in model.content) {
-          Object.assign(model.schemas, { [key]: { schema: model.content[key].schema } });
+          Object.assign(model.schemas, {[key]: {schema: model.content[key].schema}});
         }
         // model.schema = model.content[contentType].schema;
       }
@@ -88,7 +82,7 @@ class SchemaHandler {
     for (const model of this.models) {
       const modelName = model.name;
       const schemas = []
-      if (model.schema) {
+      if (model.schema){
         // const modelSchema = model.schema;
         schemas.push(model.schema)
       } else {
@@ -125,7 +119,8 @@ class SchemaHandler {
           }
         } else {
           throw new Error(
-            `There was an error converting the ${model.name
+            `There was an error converting the ${
+              model.name
             } schema. Model received looks like: \n\n${JSON.stringify(
               model
             )}.  The convereted schema looks like \n\n${JSON.stringify(
@@ -184,30 +179,18 @@ class SchemaHandler {
       }
     );
 
-    if (this.shouldConvert) {
-      this.logger.verbose(
-        `dereferenced model: ${JSON.stringify(dereferencedSchema)}`
-      );
-
-      this.logger.verbose(`converting model: ${name}`);
-      const convertedSchemas = SchemaConvertor.convert(
-        dereferencedSchema,
-        name
-      );
+    this.logger.verbose(
+      `dereferenced model: ${JSON.stringify(dereferencedSchema)}`
+    );
 
-      this.logger.verbose(
-        `converted schemas: ${JSON.stringify(convertedSchemas)}`
-      );
-      return convertedSchemas;
-    }
+    this.logger.verbose(`converting model: ${name}`);
+    const convertedSchemas = SchemaConvertor.convert(dereferencedSchema, name);
 
     this.logger.verbose(
-      `dereferenced model: ${JSON.stringify({
-        schemas: { [name]: dereferencedSchema },
-      })}`
+      `converted schemas: ${JSON.stringify(convertedSchemas)}`
     );
 
-    return { schemas: { [name]: dereferencedSchema } };
+    return convertedSchemas;
   }
 
   async __dereferenceSchema(schema) {
@@ -309,8 +292,10 @@ class SchemaHandler {
   __HTTPError(error, model) {
     if (error.message.includes("HTTP ERROR")) {
       throw new Error(
-        `There was an error dereferencing ${model.name
-        } schema.  \n\n dereferencing message: ${error.message
+        `There was an error dereferencing ${
+          model.name
+        } schema.  \n\n dereferencing message: ${
+          error.message
         } \n\n Model received: ${JSON.stringify(model)}`
       );
     }