@5minds/node-red-openapi-generator 1.1.2

package/.github/workflows/build-and-publish.yaml

@@ -0,0 +1,104 @@
+name: Build and Publish
+
+on:
+  push:
+    branches:
+      - '*'
+      - '*/*'
+
+env:
+  CI_TOOLS_VERSION: '^5.0.0'
+  # NOTE: Um den Releasezyklus von Alpha nach Beta zu ändern, einfach die nachfolgend deklarierten Env Variablen switchen.
+  CI_TOOLS_ALPHA_BRANCH: next
+  CI_TOOLS_ALPHA_NPM_TAG: next
+  # CI_TOOLS_BETA_BRANCH: next
+  # CI_TOOLS_BETA_NPM_TAG: next
+  BOX_RELEASE_TAG: 2025-1
+
+jobs:
+  test:
+    name: 'Run Tests'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Check if tests exist
+        id: check_tests
+        run: |
+          if grep -q '"test":' package.json && [ "$(npm pkg get scripts.test)" != '{}' ] && [ "$(npm pkg get scripts.test)" != 'null' ]; then
+            echo "has_tests=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_tests=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Run tests
+        if: steps.check_tests.outputs.has_tests == 'true'
+        run: npm test
+
+  build_and_publish:
+    name: 'Build and publish sources'
+    runs-on: ubuntu-latest
+    needs: test
+    if: ${{ !(contains(github.actor, 'process-engine-ci') || contains(github.actor, 'admin')) }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Use Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install CI Tools
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm i -g @5minds/product_ci_tools@${{ env.CI_TOOLS_VERSION }}
+
+      - name: 'Install Dependencies'
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+
+      - name: 'Prepare Version'
+        if: ${{ !startsWith(github.ref_name, 'renovate') }}
+        run: ci_tools prepare-version --allow-dirty-workdir
+
+      - name: 'Commit & Tag Version'
+        if: ${{ !startsWith(github.ref_name, 'renovate') }}
+        env:
+          GH_USER: ${{ github.actor }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          ci_tools commit-and-tag-version --only-on-primary-branches
+          ci_tools update-github-release --only-on-primary-branches --use-title-and-text-from-git-tag
+
+      - name: 'Publish Version'
+        if: ${{ !startsWith(github.ref_name, 'renovate') }}
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: ci_tools publish-npm-package --create-tag-from-branch-name
+
+      - name: Add Box-Release Tag
+        if: github.ref == 'refs/heads/main'
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          VERSION="$(ci_tools get-version)"
+          PACKAGE_NAME="$(npm pkg get name | tr -d \")"
+          npm dist-tag add $PACKAGE_NAME@$VERSION ${{ env.BOX_RELEASE_TAG }}

package/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "singleQuote": true,
+    "printWidth": 120,
+    "arrowParens": "always",
+    "tabWidth": 4
+}

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,173 @@
+# Node-RED OpenAPI3 Documentation Generator
+
+This package provides a set of tools for generating OpenAPI3 documentation based on the HTTP nodes deployed in a flow. 
+
+It is a fork of the https://github.com/node-red/node-red-node-swagger repo with some significant updates of dependencies and restructuring due to the OpenAPI3-update. The package is not a complete implementation of all features of OpenAPI3 but some basics to generate correct .json files and Swagger-UI details.
+
+## Usage
+
+1. Install the node module
+
+2. If you want to provide a template OpenAPI file in `settings.js`:
+
+        openapi: {
+          template: {
+            openapi: "3.0.0",
+            info: {
+              title: "My Node-RED API",
+              version: "0.0.1",
+              description: "API documentation generated by Node-RED"
+            },
+            servers: [
+              {
+                url: "http://localhost:1880/",
+                description: "Local server"
+              }
+            ],
+            paths: {},
+            components: {
+              schemas: {},
+              responses: {},
+              parameters: {},
+              securitySchemes: {}
+              // Add other components here
+            }
+          }
+        }
+
+3. This template will remain unchanged and serve as the basis for the OpenAPI documentation.
+
+  **Note:** You may additionally add components like `schemas`, `responses`, `parameters`, `securitySchemes`, etc., to the OpenAPI file in `settings.js` to have those components available for reuse in the generated OpenAPI documentation.
+
+        openapi: {
+          template: {
+            // ... (rest of your OpenAPI template)
+          },
+          components: {
+            schemas: {
+              MySchema: {
+                type: "object",
+                properties: {
+                  name: {
+                    type: "string"
+                  }
+                }
+              }
+            },
+            securitySchemes: {
+              ApiKeyAuth: {
+                type: "apiKey",
+                in: "header",
+                name: "X-API-Key"
+              }
+            }
+            // Add other reusable components here
+          }
+        }
+
+4. After installing the package, you have the option to identify metadata for each HTTP-In node that will be used in the OpenAPI doc generation.
+
+5. The generated OpenAPI documentation is then available at <http://localhost:1880/http-api/swagger.json>.
+
+## Path OpenAPI Generation
+
+Via the editor, you can define metadata for each particular HTTP-In node to be used in OpenAPI generation.
+
+To do so:
+
+1. Select an HTTP-In node in the editor.
+![HTTP-In Node](readme_images/Capture_00.PNG?raw=true)
+
+2. From the config panel, you can select a user-defined OpenAPI doc from the dropdown. You may create a new metadata definition by selecting "Add new swagger-doc..." and clicking the edit button.
+![Config Panel](readme_images/Capture_01.PNG?raw=true)
+
+3. This will launch the OpenAPI config panel, where you have three distinct tabs that make up the OpenAPI documentation.
+
+#### Info
+
+![Info Tab](readme_images/Capture_02.PNG?raw=true)
+
+This tab allows you to provide the basic information about the attached paths.
+
+* Summary - A short summary of what the operation does. For maximum readability in the Swagger-UI, this field SHOULD be less than 120 characters.
+* Description - A verbose explanation of the operation behavior. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
+* Tags - A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. These should be provided as a comma-separated list.
+* Deprecated - Declares this operation to be deprecated. Usage of the declared operation should be refrained.
+
+#### Parameters
+
+![Parameters Tab](readme_images/Capture_03.PNG?raw=true)
+
+This tab allows you to configure the parameters that can be used with the particular operation.
+
+* Name - The name of the parameter. Parameter names are case sensitive.
+* In - The location of the parameter. There are four supported locations of the parameter:
+  * _Query_ - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`.
+  * _Header_ - Custom headers that are expected as part of the request.
+* Description - A brief description of the parameter. This could contain examples of use. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
+* Required - Determines whether this parameter is mandatory.
+* Type - The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object).
+* Format - The extending format for the previously mentioned type.
+
+If a body parameter is selected, the user will provide properties included in the body object, rather than specifying a type.
+
+#### Responses
+
+![Responses Tab](readme_images/Capture_04.PNG?raw=true)
+
+This tab allows you to define the applicable responses that a user may receive back from the operation.
+
+* Code - You can either select to define the default response, or to provide a specific HTTP status code that the response will be applicable for. A default response is used to cover other undeclared responses.
+* Description - A short description of the response. This could contain examples of use. [GFM syntax](https://help.github.com/articles/github-flavored-markdown) can be used for rich text representation.
+* Properties - The properties are the components that build up the schema of the response.
+* Name - The key name for the particular property.
+* Type - The type of the property.
+* Format - The extending format for the previously mentioned type.
+
+If no responses are provided, a default response with the reply "success" will be used.
+
+#### Request Body
+
+This tab allows you to define the request body for the operation.
+
+* Description - A brief description of the request body.
+* Required - A checkbox to indicate if the request body is required.
+* Content Type - The media type of the request body (e.g., application/json).
+* JSON Schema - A text area where you can define the JSON schema for the request body.
+Example JSON Schema:
+```json
+{
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "example": "John Doe"
+    },
+    "age": {
+      "type": "integer",
+      "example": 30
+    },
+    "email": {
+      "type": "string",
+      "format": "email",
+      "example": "john.doe@example.com"
+    }
+  },
+  "required": ["name", "email"]
+}
+
+```
+
+## Swagger-UI
+
+![Swagger-UI](readme_images/Capture_Swagger_UI.PNG?raw=true)
+
+Swagger-UI is included in the plugin. Once loaded, the plugin will show a Swagger tab in the Node-RED sidebar. From here, you can see the dynamically generated OpenAPI documentation for the current flow. Additionally, you can use the test function to try out your API directly from the editor, providing any parameters you have defined in the docs for the HTTP-In nodes. The Swagger-UI will automatically refresh any time the flow is redeployed.
+
+## Notes
+
+- The `paths` entry of the OpenAPI documentation is generated based on the `HTTP In` nodes present in the flow.
+- If an OpenAPI template is not provided, the example above is used as the default.
+- If `basePath` is not set in the template, it is set to the value of `httpNodeRoot` if that value is something other than `/`.
+
+###### Attribute definitions provided come from the [OpenAPI Specification Version 3.1.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md)

package/package.json

@@ -0,0 +1,39 @@
+{
+    "name": "@5minds/node-red-openapi-generator",
+    "version": "1.1.2",
+    "description": "A set of tools for generating OpenAPI3/Swagger documentation based on the HTTP nodes deployed in a flow. An updated version of the Node-RED Swagger Documentation Generator to support OpenAPI3, based of the @digital-tvilling/node-red-openapi-generator.",
+    "license": "Apache",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/5minds/node-red-openapi-generator"
+    },
+    "authors": [
+        {
+            "name": "Diana Stefan",
+            "email": "diana.stefan@5Minds.de"
+        }
+    ],
+    "scripts": {
+        "lint": "prettier --write --config ./.prettierrc.json \"**/*.{html,js}\""
+    },
+    "keywords": [
+        "node-red",
+        "swagger",
+        "open-api"
+    ],
+    "node-red": {
+        "version": ">=4.2.0",
+        "nodes": {
+            "swagger": "swagger/swagger.js"
+        }
+    },
+    "conflicts": {
+        "node-red-node-swagger": "<0.3.0"
+    },
+    "dependencies": {
+        "swagger-ui-dist": "^5.29.0"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+      }
+}

package/swagger/locales/en-US/swagger.json

@@ -0,0 +1,72 @@
+{
+    "swagger": {
+        "sidebar": {
+            "label": "swagger",
+            "name": "Swagger UI"
+        },
+        "label": {
+            "path": "Path",
+            "summary": "Summary",
+            "description": "Description",
+            "tags": "Tags",
+            "consumes": "Consumes",
+            "produces": "Produces",
+            "deprecated": "Deprecated",
+            "parameter": "parameter",
+            "parameters-help": "Parameters Help",
+            "response": "response",
+            "responses-help": "Responses Help",
+            "property": "property"
+        },
+        "placeholder": {
+            "tags": "Comma-separated list of Tags",
+            "consumes": "Comma-separated list of Mime Types",
+            "produces": "Comma-separated list of Mime Types"
+        },
+        "data-content": {
+            "summary": "A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.",
+            "description": "A verbose explanation of the operation behavior. GitHub Flavored Markup syntax can be used for rich text representation.",
+            "tags": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.",
+            "consumes": "A list of MIME types the operation can consume.",
+            "produces": "A list of MIME types the operation can produce.",
+            "deprecated": "Declares this operation to be deprecated. Usage of the declared operation should be refrained."
+        },
+        "content": {
+            "parameter-info": "<div style=\"max-width: 450px\"><p>A list of parameters that are applicable for this operation.</p><p>To add a parameter, click the <span class='btn btn-mini' id='node-config-input-add-parameter'><i class='fa fa-plus'></i> parameter</span> button.</p><p>There are four possible parameter types.</p><ul><li>Query - Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.</li><li>Header - Custom headers that are expected as part of the request.</li><li>Body - The payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only.</li><li>Form - Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data are used as the content type of the request (in Swagger's definition, the consumes property of an operation). This is the only parameter type that can be used to send files, thus supporting the file type.</li></ul></div>",
+            "response-info": "<div><p>The list of possible responses as they are returned from executing this operation.</p><p>You may supply responses for individual status codes, and/or a default response.</p><p>To add a parameter, click the <span class='btn btn-mini' id='node-config-input-add-parameter'><i class='fa fa-plus'></i> response</span> button.</p><p>If no responses are entered, a default response returning 'success' will be added for you.</p></div>",
+            "type": "The type of the attribute, limited to primitive types.",
+            "format": "The extending format for the previously mentioned type.",
+            "parameter-description": "A brief description of the parameter. This could contain examples of use. GitHub Flavored Markup syntax can be used for rich text representation.",
+            "required": "Determines whether this parameter is mandatory.",
+            "response-description": "A brief description of the response. This could contain examples of use. GitHub Flavored Markup syntax can be used for rich text representation."
+        },
+        "tabs-label": {
+            "info": "Info",
+            "parameters": "Parameters",
+            "responses": "Responses",
+            "requestBody": "Request Body"
+        },
+        "text": {
+            "type": "Type",
+            "format": "Format",
+            "name": "Name",
+            "in": "in",
+            "path": "path",
+            "description": "Description",
+            "required": "Required?",
+            "properties": "Properties",
+            "file": "file",
+            "code": "Code",
+            "default": "Default"
+        },
+        "helpBox": {
+            "title": "I see you're lacking Swagger doc...",
+            "swaggerIntro": "Swagger is a simple yet powerful way to document your REST API.",
+            "swaggerInfo": "The Swagger plug-in dynamically generates Swagger documentation based on input provided when setting up your HTTP endpoint nodes.",
+            "swaggerInstructions0": "After building your REST APIs in the editor, click the HTTP endpoint node. You can then attach additional Swagger documentation to that node by clicking the add button next to Docs.",
+            "swaggerInstructions1": "You are able to add additional details on the types of inputs and outputs expected from your endpoint by quickly navigating through the screens and providing some information.",
+            "swaggerInstructions2": "Once your flow is deployed, this tab will be automatically populated by a visual representation of your API.",
+            "swaggerOutro": "You can then use this Swagger-UI tab to effortlessly test your APIs."
+        }
+    }
+}