serverless-openapi-documenter 0.0.90 → 0.0.92

package/README.md

@@ -942,6 +942,15 @@ This will set the `Cache-Control` Response Header to have a value of "no-store"
 
 Validation for the OpenAPI Description is now (as of 0.0.90) done by [Redocly](https://redocly.com/). This is a slightly less opinionated validator for an OpenAPI Description, it should result in less errors around "YAML Anchors". It's also a maintained library, and has support for OpenAPI 3.1.0 which I hope to be able to support very soon.
 
+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/)
+
 I am making use of https://www.npmjs.com/package/@redocly/openapi-core, which I have been warned is likely to change. If you notice anything going wrong with validation of your OpenAPI Description, feel free to open an issue here. I make active use of this library, so will hopefully come across those issues too.
 
 ## Example configuration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.90",
+  "version": "0.0.92",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [
@@ -20,7 +20,10 @@
     "Postman Collections",
     "AWS",
     "AWS APIGateway",
-    "Api Gateway"
+    "Api Gateway",
+    "APIGateway",
+    "AWSAPIGateway",
+    "Serverless OpenAPI"
   ],
   "scripts": {
     "test": "mocha --config './test/.mocharc.js'"
@@ -41,7 +44,7 @@
     "@redocly/openapi-core": "^1.2.0",
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
-    "json-schema-for-openapi": "^0.4.1",
+    "json-schema-for-openapi": "^0.4.3",
     "lodash.isequal": "^4.5.0",
     "openapi-to-postmanv2": "^4.18.0",
     "swagger2openapi": "^7.0.8",
@@ -51,9 +54,9 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "chai": "^4.3.8",
+    "chai": "^4.3.10",
     "mocha": "^10.2.0",
-    "nock": "^13.3.3",
-    "sinon": "^16.0.0"
+    "nock": "^13.4.0",
+    "sinon": "^17.0.1"
   }
 }

package/src/definitionGenerator.js

@@ -946,6 +946,7 @@ class DefinitionGenerator {
       )
         return true;
     };
+
     const functionNames = this.serverless.service.getAllFunctions();
 
     return functionNames
@@ -957,16 +958,14 @@ class DefinitionGenerator {
       })
       .map((functionType) => {
         const event = functionType.events.filter(isHttpFunction);
-        const name = functionType.name.split(
-          `${this.serverless.service.service}-${this.serverless.service.provider.stage}-`
-        )[1];
+        const operationName = functionType.name.split("-").slice(-1).pop();
 
         Object.assign(this.functionMap, {
-          [name]: [],
+          [operationName]: [],
         });
 
         return {
-          operationName: name,
+          operationName: operationName,
           functionInfo: functionType,
           handler: functionType.handler,
           name: functionType.name,