updated basics in readme

Author: fasblom

README.md

@@ -13,39 +13,61 @@ based on the HTTP nodes deployed in a flow.
 
         npm install node-red/node-red-node-swagger
 
-2. Provide a template swagger file in `settings.js`:
-
-        swagger: {
-          "template": {
-            "swagger": "2.0",
-            "info": {
-              "title": "My Node-RED API",
-              "version": "0.0.1"
+2. 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 swagger doc.
+3. This template will remain unchanged and serve as the basis for the OpenAPI documentation.
 
-  **Note:** You may additionally add parameters to the swagger file in 'settings.js' to have those parameters automatically added to each path in the generated swagger doc.
-  
-        "swagger": {
-          "template": {
-            "swagger": "2.0",
-            "info": {
-              "title": "My Node-RED API",
-              "version": "0.0.1"
-            }
+  **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)
           },
-          "parameters": [
-            {
-              "name": "parameterA",
-              "type": "string",
-              "in": "header",
-              "required": false,
-              "description": "This is a test parameter to show how parameters are automatically added to each path in the generated swagger doc."
+          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 swagger doc generation.
@@ -131,4 +153,4 @@ Swagger-UI is including in the plugin. Once loaded, the plugin will show a swagg
   if that value is something other than `/`.
 
 
-###### Attribute definitions provided come from the [Swagger 2.0 Spec](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md)
+###### 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)