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

package/README.md

@@ -12,9 +12,9 @@
   </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.
+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.
 
-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.
+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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.124-beta.1",
+  "version": "0.1.0",
   "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",

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;