docs

Author: devlikepro

src/N8NPropertiesBuilder.ts

@@ -21,6 +21,14 @@ export interface N8NPropertiesBuilderConfig {
     resource?: IResourceParser,
 }
 
+/**
+ *
+ * Builds n8n node "properties" from an OpenAPI document.
+ * It uses a walker to traverse the OpenAPI document and collect the necessary information.
+ * The collected information is then used to build the n8n node properties.
+ * The class uses a set of parsers to parse the OpenAPI document and build the n8n node properties.
+ *
+ */
 export class N8NPropertiesBuilder {
     private readonly doc: OpenAPIV3.Document;
     private readonly logger: pino.Logger

src/ResourceParser.ts

@@ -1,14 +1,33 @@
 import {OpenAPIV3} from "openapi-types";
 import * as lodash from "lodash";
 
+/**
+ * Extract information for n8n node from OpenAPI resource
+ */
 export interface IResourceParser {
+    /**
+     * Name of the resource (e.g. "User")
+     * @param tag
+     */
     name(tag: OpenAPIV3.TagObject): string
 
+    /**
+     * Value of the resource (e.g. "user")
+     * @note - will be used on operations as well, only "name" will be available for that
+     */
     value(tag: Pick<OpenAPIV3.TagObject, "name">): string
 
+    /**
+     * Description of the resource
+     * @param tag
+     */
     description(tag: OpenAPIV3.TagObject): string
 }
 
+/**
+ * Default behaviour for OpenAPI to n8n resource parser
+ * It will use tag name as name and value and description as description
+ */
 export class DefaultResourceParser {
     name(tag: OpenAPIV3.TagObject): string {
         return lodash.startCase(tag.name);