serverless-openapi-documenter 0.0.124 → 0.1.1

package/README.md

@@ -12,7 +12,9 @@
   </a>
 </p>
 
-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.
+This will generate an OpenAPI V3 (up to v3.1.2) 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.
+
+As of version 0.1.0, you can now create [OpenAPI V3.1 (3.1.x)](https://spec.openapis.org/oas/v3.1.2.html) Documents, should you run the command `serverless openapi generate -o openapi.json -f json -a 3.1.2 -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.
 
 Originally based off of: https://github.com/temando/serverless-openapi-documentation
 
@@ -1109,7 +1111,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",
+  "version": "0.1.1",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -17,7 +17,11 @@
     "swagger",
     "openAPI",
     "openAPIv3",
+    "openAPIv3.1",
     "openAPI3",
+    "openAPI3.1",
+    "OpenAPI 3",
+    "OpenAPI 3.1",
     "Postman",
     "PostmanCollections",
     "Postman-Collections",
@@ -49,8 +53,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",
+    "@usebruno/converters": "^0.17.1",
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.1",
     "json-schema-for-openapi": "^0.5.0",

package/src/schemaHandler.js

@@ -16,6 +16,12 @@ 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();
@@ -53,7 +59,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;
       }
@@ -82,7 +88,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 {
@@ -119,8 +125,7 @@ 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(
@@ -179,18 +184,30 @@ class SchemaHandler {
       }
     );
 
-    this.logger.verbose(
-      `dereferenced model: ${JSON.stringify(dereferencedSchema)}`
-    );
+    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(`converting model: ${name}`);
-    const convertedSchemas = SchemaConvertor.convert(dereferencedSchema, name);
+      this.logger.verbose(
+        `converted schemas: ${JSON.stringify(convertedSchemas)}`
+      );
+      return convertedSchemas;
+    }
 
     this.logger.verbose(
-      `converted schemas: ${JSON.stringify(convertedSchemas)}`
+      `dereferenced model: ${JSON.stringify({
+        schemas: { [name]: dereferencedSchema },
+      })}`
     );
 
-    return convertedSchemas;
+    return { schemas: { [name]: dereferencedSchema } };
   }
 
   async __dereferenceSchema(schema) {
@@ -292,10 +309,8 @@ 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)}`
       );
     }