default tag

Author: devlikepro

src/N8NPropertiesBuilder.spec.ts

@@ -938,3 +938,120 @@ test('multiple tags', () => {
         ]
     );
 });
+
+test('no tags - default tag', () => {
+    const paths = {
+        '/api/entities': {
+            get: {
+                operationId: 'EntityController_list',
+                summary: 'List all entities',
+                parameters: [
+                    {
+                        name: 'all',
+                        required: false,
+                        in: 'query',
+                        example: false,
+                        description: 'Boolean flag description',
+                        schema: {
+                            type: 'boolean',
+                        },
+                    },
+                ],
+                tags: [],
+            },
+        },
+    };
+
+    const parser = new N8NPropertiesBuilder({paths});
+    const result = parser.build()
+
+    expect(result).toEqual(
+        [
+            {
+                "default": "",
+                "displayName": "Resource",
+                "name": "resource",
+                "noDataExpression": true,
+                "options": [
+                    {
+                        "description": "",
+                        "name": "Default",
+                        "value": "Default"
+                    }
+                ],
+                "type": "options"
+            },
+            {
+                "default": "",
+                "displayName": "Operation",
+                "displayOptions": {
+                    "show": {
+                        "resource": [
+                            "Default"
+                        ]
+                    }
+                },
+                "name": "operation",
+                "noDataExpression": true,
+                "options": [
+                    {
+                        "action": "List all entities",
+                        "description": "List all entities",
+                        "name": "List",
+                        "routing": {
+                            "request": {
+                                "method": "GET",
+                                "url": "=/api/entities"
+                            }
+                        },
+                        "value": "List"
+                    }
+                ],
+                "type": "options"
+            },
+            {
+                "default": "",
+                "displayName": "GET /api/entities",
+                "displayOptions": {
+                    "show": {
+                        "operation": [
+                            "List"
+                        ],
+                        "resource": [
+                            "Default"
+                        ]
+                    }
+                },
+                "name": "operation",
+                "type": "notice",
+                "typeOptions": {
+                    "theme": "info"
+                }
+            },
+            {
+                "default": false,
+                "description": "Boolean flag description",
+                "displayName": "All",
+                "displayOptions": {
+                    "show": {
+                        "operation": [
+                            "List"
+                        ],
+                        "resource": [
+                            "Default"
+                        ]
+                    }
+                },
+                "name": "all",
+                "routing": {
+                    "request": {
+                        "qs": {
+                            "all": "={{ $value }}"
+                        }
+                    }
+                },
+                "type": "boolean"
+            }
+        ]
+    );
+});

src/OperationParser.ts

@@ -15,11 +15,7 @@ export interface IOperationParser {
 
 export class N8NOperationParser implements IOperationParser {
     getResources(operation: OpenAPIV3.OperationObject, context: OperationContext): string[] {
-        const tags = operation.tags;
-        if (!tags || tags.length === 0) {
-            // TODO: Add "default" tag
-            throw new Error(`No tags found for operation '${operation}'`);
-        }
+        const tags = operation.tags as string[]
         return tags.map(toResourceName)
     }
 

src/ResourcePropertiesCollector.ts

@@ -45,15 +45,19 @@ export class ResourcePropertiesCollector implements OpenAPIVisitor {
         tags.sort((a, b) => {
             return this.tagsOrder.get(a.name,)! - this.tagsOrder.get(b.name)!;
         })
+        // put "default" at the end if not present explicitly in 'tags"
+        if (!this.tagsOrder.has('default')) {
+            const defaultTag = tags.find((tag) => tag.name === 'default')
+            if (defaultTag) {
+                tags.splice(tags.indexOf(defaultTag), 1)
+                tags.push(defaultTag)
+            }
+        }
         return tags;
     }
 
     visitOperation(operation: OpenAPIV3.OperationObject, context: OperationContext) {
-        let tags = operation.tags
-        if (!tags || tags.length === 0) {
-            // TODO: add 'default' at the end
-            return;
-        }
+        let tags = operation.tags as string[]
         tags.forEach((tag) => this.addTagByName(tag))
     }
 

src/openapi/OpenAPIWalker.ts

@@ -44,6 +44,9 @@ export class OpenAPIWalker {
                 if (!HttpMethods.includes(method)) {
                     continue;
                 }
+                if (!operation.tags || operation.tags.length === 0) {
+                    operation.tags = ['default']
+                }
                 if (operation && visitor.visitOperation) {
                     const context = {pattern: path, path: pathItem, method: method as OpenAPIV3.HttpMethods};
                     visitor.visitOperation(operation, context);