Merge pull request #148 from JaredCE/fix-cleanup-links

Fix cleanup links

Author: JaredCE

README.md

@@ -96,8 +96,6 @@ Options:
 | tags[].externalDocs.url                                   | custom.documentation.tags.externalDocumentation.url                                                                                                   |
 | tags[].externalDocs.description                           | custom.documentation.tags.externalDocumentation.description                                                                                           |
 | path[path]                                                | functions.functions.events.[http OR httpApi].path                                                                                                     |
-| path[path].summary                                        | functions.functions.summary                                                                                                                           |
-| path[path].description                                    | functions.functions.description                                                                                                                       |
 | path[path].servers[].description                          | functions.functions.servers.description                                                                                                               |
 | path[path].servers[].url                                  | functions.functions.servers.url                                                                                                                       |
 | path[path].[operation]                                    | functions.functions.[http OR httpApi].method                                                                                                          |

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-documenter",
-  "version": "0.0.82",
+  "version": "0.0.83",
   "description": "Generate OpenAPI v3 documentation and Postman Collections from your Serverless Config",
   "main": "index.js",
   "keywords": [

package.json

@@ -179,11 +179,11 @@ class DefinitionGenerator {
             throw err;
           });
 
-          if (httpFunction.functionInfo?.summary)
-            path.summary = httpFunction.functionInfo.summary;
+          // if (httpFunction.functionInfo?.summary)
+          //   path.summary = httpFunction.functionInfo.summary;
 
-          if (httpFunction.functionInfo?.description)
-            path.description = httpFunction.functionInfo.description;
+          // if (httpFunction.functionInfo?.description)
+          //   path.description = httpFunction.functionInfo.description;
 
           if (httpFunction.functionInfo?.servers) {
             const servers = this.createServers(
@@ -910,16 +910,20 @@ class DefinitionGenerator {
   cleanupLinks() {
     for (const path of Object.keys(this.openAPI.paths)) {
       for (const [name, value] of Object.entries(this.openAPI.paths[path])) {
-        for (const [statusCode, responseObj] of Object.entries(
-          value.responses
-        )) {
-          if (responseObj.links) {
-            for (const [linkName, linkObj] of Object.entries(
-              responseObj.links
-            )) {
-              const opId = linkObj.operationId;
-              if (this.functionMap[opId]) {
-                linkObj.operationId = this.functionMap[opId][0];
+        if (
+          RegExp(/(get|put|post|delete|options|head|patch|trace)/i).test(name)
+        ) {
+          for (const [statusCode, responseObj] of Object.entries(
+            value?.responses
+          )) {
+            if (responseObj.links) {
+              for (const [linkName, linkObj] of Object.entries(
+                responseObj.links
+              )) {
+                const opId = linkObj.operationId;
+                if (this.functionMap[opId]) {
+                  linkObj.operationId = this.functionMap[opId][0];
+                }
               }
             }
           }

src/definitionGenerator.js

@@ -96,6 +96,8 @@ custom:
 functions:
   getContent:
     handler: handler.getContent
+    description: this is the overarching paths description for the following paths
+    summary: overarching paths for getContent
     events:
       - httpApi:
           path: /{contentId}