@asyncapi/converter 0.7.0 → 0.7.1

package/.github/workflows/automerge.yml

@@ -6,21 +6,15 @@ name: Automerge release bump PR
 on:
   pull_request_target:
     types:
-      - labeled
-      - unlabeled
-      - synchronize
       - opened
-      - edited
-      - ready_for_review
-      - reopened
-      - unlocked
-  pull_request_review:
-    types:
-      - submitted
+      - synchronize
 
 jobs:
   autoapprove:
-    if: github.event.pull_request.draft == false && (github.actor == 'asyncapi-bot' || github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]') && !contains(github.event.pull_request.labels.*.name, 'released')
+    if: >
+      contains(fromJson('["asyncapi-bot", "dependabot[bot]", "dependabot-preview[bot]"]'), github.event.pull_request.user.login) &&
+      contains(fromJson('["asyncapi-bot", "dependabot[bot]", "dependabot-preview[bot]"]'), github.actor) &&
+      !contains(github.event.pull_request.labels.*.name, 'released')
     runs-on: ubuntu-latest
     steps:
       - name: Autoapproving
@@ -42,7 +36,6 @@ jobs:
 
   automerge:
     needs: [autoapprove]
-    if: github.event.pull_request.user.login == 'asyncapi-bot' || github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'dependabot-preview[bot]'
     runs-on: ubuntu-latest
     steps:
       - name: Automerging

package/.github/workflows/bump.yml

@@ -15,6 +15,7 @@ on:
 
 jobs:
   bump:
+    if: startsWith(github.event.commits[0].message, 'chore(release):')
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -22,9 +23,9 @@ jobs:
       - name: Check if Node.js project and has package.json
         id: packagejson
         run: test -e ./package.json && echo "::set-output name=exists::true" || echo "::set-output name=exists::false"
-      - if: steps.packagejson.outputs.exists == 'true' && startsWith(github.event.commits[0].message, 'chore(release):')
+      - if: steps.packagejson.outputs.exists == 'true'
         name: Bumping latest version of this package in other repositories
-        uses: derberg/npm-dependency-manager-for-your-github-org@v3
+        uses: derberg/npm-dependency-manager-for-your-github-org@v4
         with:
           github_token: ${{ secrets.GH_TOKEN }}
           committer_username: asyncapi-bot

package/.github/workflows/if-go-pr-testing.yml

@@ -6,16 +6,21 @@ name: PR testing - if Go project
 on:
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
-
+    
 jobs:
   lint:
-    if: github.event.pull_request.draft == false
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
+      - if: "github.event.pull_request.draft == false &&!((github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'ci: update global workflows')) || (github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'chore(release):')) || (github.actor == 'allcontributors' && startsWith(github.event.pull_request.title, 'docs: add')))"
+        id: should_run
+        name: Should Run
+        run: echo "::set-output name=shouldrun::true"
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Checkout repository
         uses: actions/checkout@v2
-      - name: Check if Go project and has go.mod
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Check if Go project and has go.mod
         id: gomod
         run: test -e ./go.mod && echo "::set-output name=exists::true" || echo "::set-output name=exists::false"
         shell: bash
@@ -31,16 +36,21 @@ jobs:
           skip-go-installation: true # we wanna control the version of Go in use
   
   test:
-    if: github.event.pull_request.draft == false
     name: ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
-      - name: Checkout repository
+      - if: "github.event.pull_request.draft == false &&!((github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'ci: update global workflows')) || (github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'chore(release):')) || (github.actor == 'allcontributors' && startsWith(github.event.pull_request.title, 'docs: add')))"
+        id: should_run
+        name: Should Run
+        run: echo "::set-output name=shouldrun::true"
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Checkout repository
         uses: actions/checkout@v2
-      - name: Check if Go project and has go.mod
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Check if Go project and has go.mod
         id: gomod
         run: test -e ./go.mod && echo "::set-output name=exists::true" || echo "::set-output name=exists::false"
         shell: bash

package/.github/workflows/if-nodejs-pr-testing.yml

@@ -9,20 +9,26 @@ on:
 
 jobs:
   test:
-    if: github.event.pull_request.draft == false
     name: ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
-      - name: Set git to use LF #to once and for all finish neverending fight between Unix and Windows
+      - if: "github.event.pull_request.draft == false &&!((github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'ci: update global workflows')) || (github.actor == 'asyncapi-bot' && startsWith(github.event.pull_request.title, 'chore(release):')) || (github.actor == 'allcontributors' && startsWith(github.event.pull_request.title, 'docs: add')))"
+        id: should_run
+        name: Should Run
+        run: echo "::set-output name=shouldrun::true"
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Set git to use LF #to once and for all finish neverending fight between Unix and Windows
         run: |
           git config --global core.autocrlf false
           git config --global core.eol lf
-      - name: Checkout repository
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Checkout repository
         uses: actions/checkout@v2
-      - name: Check if Node.js project and has package.json
+      - if: steps.should_run.outputs.shouldrun == 'true' 
+        name: Check if Node.js project and has package.json
         id: packagejson
         run: test -e ./package.json && echo "::set-output name=exists::true" || echo "::set-output name=exists::false"
         shell: bash

package/.github/workflows/notify-tsc-members-mention.yml

@@ -0,0 +1,142 @@
+#This action is centrally managed in https://github.com/asyncapi/.github/
+#Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo
+
+#This action notifies community on slack whenever there is a new issue, PR or discussion started in given repository
+name: Notify slack whenever TSC members are mentioned in GitHub
+
+on:
+    issue_comment:
+      types: 
+        - created
+        - edited
+        
+    discussion_comment:
+      types: 
+        - created
+        - edited
+        
+    issues:
+      types:
+        - opened
+        - reopened
+
+    pull_request_target:
+      types: 
+        - opened
+        - reopened
+        - ready_for_review
+
+    discussion:
+      types: 
+        - created
+        - edited
+
+jobs:
+
+    issue:
+      if: github.event_name == 'issues' && contains(github.event.issue.body, '@asyncapi/tsc_members')
+      name: On every new issue
+      runs-on: ubuntu-latest
+      steps:
+        - name: Convert markdown to slack markdown
+          uses: LoveToKnow/slackify-markdown-action@v1.0.0
+          id: issuemarkdown
+          with:
+            text: "[${{github.event.issue.title}}](${{github.event.issue.html_url}}) \n ${{github.event.issue.body}}"
+        - name: Send info about issue
+          uses: rtCamp/action-slack-notify@v2
+          env:
+            SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}
+            SLACK_TITLE: 🆘 New issue that requires TSC Members attention 🆘
+            SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}
+            MSG_MINIMAL: true
+
+    pull_request:
+      if: github.event_name == 'pull_request_target' && contains(github.event.pull_request.body, '@asyncapi/tsc_members')
+      name: On every new pull request
+      runs-on: ubuntu-latest
+      steps:
+        - name: Convert markdown to slack markdown
+          uses: LoveToKnow/slackify-markdown-action@v1.0.0
+          id: prmarkdown
+          with:
+            text: "[${{github.event.pull_request.title}}](${{github.event.pull_request.html_url}}) \n ${{github.event.pull_request.body}}"
+        - name: Send info about pull request
+          uses: rtCamp/action-slack-notify@v2
+          env:
+            SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}
+            SLACK_TITLE: 🆘 New PR that requires TSC Members attention 🆘
+            SLACK_MESSAGE: ${{steps.prmarkdown.outputs.text}}
+            MSG_MINIMAL: true
+    
+    discussion:
+      if: github.event_name == 'discussion' && contains(github.event.discussion.body, '@asyncapi/tsc_members')
+      name: On every new discussion
+      runs-on: ubuntu-latest
+      steps:
+        - name: Convert markdown to slack markdown
+          uses: LoveToKnow/slackify-markdown-action@v1.0.0
+          id: discussionmarkdown
+          with:
+            text: "[${{github.event.discussion.title}}](${{github.event.discussion.html_url}}) \n ${{github.event.discussion.body}}"
+        - name: Send info about pull request
+          uses: rtCamp/action-slack-notify@v2
+          env:
+            SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}
+            SLACK_TITLE: 🆘 New discussion that requires TSC Members attention 🆘
+            SLACK_MESSAGE: ${{steps.discussionmarkdown.outputs.text}}
+            MSG_MINIMAL: true
+
+    issue_comment:
+      if: ${{ github.event_name == 'issue_comment' && !github.event.issue.pull_request && contains(github.event.comment.body, '@asyncapi/tsc_members') }}
+      name: On every new comment in issue
+      runs-on: ubuntu-latest
+      steps:
+        - name: Convert markdown to slack markdown
+          uses: LoveToKnow/slackify-markdown-action@v1.0.0
+          id: issuemarkdown
+          with:
+            text: "[${{github.event.issue.title}}](${{github.event.comment.html_url}}) \n ${{github.event.comment.body}}"
+        - name: Send info about issue comment
+          uses: rtCamp/action-slack-notify@v2
+          env:
+            SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}
+            SLACK_TITLE: 🆘 New comment under existing issue that requires TSC Members attention 🆘
+            SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}
+            MSG_MINIMAL: true
+
+    pr_comment:
+      if: github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@asyncapi/tsc_members')
+      name: On every new comment in pr
+      runs-on: ubuntu-latest
+      steps:
+        - name: Convert markdown to slack markdown
+          uses: LoveToKnow/slackify-markdown-action@v1.0.0
+          id: prmarkdown
+          with:
+            text: "[${{github.event.issue.title}}](${{github.event.comment.html_url}}) \n ${{github.event.comment.body}}"
+        - name: Send info about PR comment
+          uses: rtCamp/action-slack-notify@v2
+          env:
+            SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}
+            SLACK_TITLE: 🆘 New comment under existing PR that requires TSC Members attention 🆘
+            SLACK_MESSAGE: ${{steps.prmarkdown.outputs.text}}
+            MSG_MINIMAL: true
+
+    discussion_comment:
+      if: github.event_name == 'discussion_comment' && contains(github.event.comment.body, '@asyncapi/tsc_members')
+      name: On every new comment in discussion
+      runs-on: ubuntu-latest
+      steps:
+        - name: Convert markdown to slack markdown
+          uses: LoveToKnow/slackify-markdown-action@v1.0.0
+          id: discussionmarkdown
+          with:
+            text: "[${{github.event.discussion.title}}](${{github.event.comment.html_url}}) \n ${{github.event.comment.body}}"
+        - name: Send info about discussion comment
+          uses: rtCamp/action-slack-notify@v2
+          env:
+            SLACK_WEBHOOK: ${{secrets.SLACK_TSC_MEMBERS_NOTIFY}}
+            SLACK_TITLE: 🆘 New comment under existing discussion that requires TSC Members attention 🆘
+            SLACK_MESSAGE: ${{steps.discussionmarkdown.outputs.text}}
+            MSG_MINIMAL: true

package/cli.js

@@ -37,9 +37,16 @@ if (!version) {
 
 try {
   const asyncapi = fs.readFileSync(asyncapiFile, 'utf-8');
-  console.log(converter.convert(asyncapi, version, {
+  let converted = converter.convert(asyncapi, version, {
     id: program.id,
-  }));
+  });
+
+  // JSON case
+  if (typeof converted === 'object') {
+    converted = JSON.stringify(converted, undefined, 2);
+  }
+
+  console.log(converted);
 } catch (e) {
   showErrorAndExit(e);
 }

package/lib/helpers.js

@@ -3,16 +3,34 @@ const yaml = require('js-yaml');
 const helpers = module.exports;
 
 helpers.serialize = (text) => {
+    if (typeof text === 'object') {
+        return {
+            isYAML: false,
+            parsed: text,
+        };
+    }
+
     try {
+        const maybeJSON = JSON.parse(text);
+        if (typeof maybeJSON === 'object') {
+            return {
+                isYAML: false,
+                parsed: maybeJSON,
+            };
+        }
+
+        // if `maybeJSON` is object, then we have 100% sure that we operate on JSON, 
+        // but if it's `string` then we have option that it can be YAML but it doesn't have to be
         return {
             isYAML: true,
             parsed: yaml.safeLoad(text)
         };
     } catch (e) {
         try {
+            // try to parse again YAML, because the text itself may not have a JSON representation and cannot be represented as a JSON object/string
             return {
-                isYAML: false,
-                parsed: JSON.parse(text)
+                isYAML: true,
+                parsed: yaml.safeLoad(text)
             };
         } catch (err) {
             throw new Error('AsyncAPI document must be a valid JSON or YAML document.');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@asyncapi/converter",
-	"version": "0.7.0",
+	"version": "0.7.1",
 	"description": "Convert AsyncAPI documents from older to newer versions.",
 	"bin": {
 		"asyncapi-converter": "cli.js"

package/test/index.js

@@ -2,6 +2,7 @@ const assert = require('assert');
 const fs = require('fs');
 const path = require("path");
 const { convert } = require('../lib');
+const { serialize } = require('../lib/helpers');
 
 describe('#convert', () => {
     it('should not convert to lowest version', () => {
@@ -193,6 +194,48 @@ describe('#convert', () => {
         const result = convert(input, '2.3.0');
         assertResults(output, result);
     });
+
+    it('should convert from 2.0.0 to 2.1.0 (JSON case)', () => {
+        const input = fs.readFileSync(path.resolve(__dirname, 'input', '2.0.0', 'streetlights.json'), 'utf8');
+        let output = fs.readFileSync(path.resolve(__dirname, 'output', '2.1.0', 'streetlights.json'), 'utf8');
+        let result = convert(input, '2.1.0');
+
+        output = JSON.stringify(JSON.parse(output));
+        result = JSON.stringify(JSON.parse(JSON.stringify(result)));
+        assert.strictEqual(output, result);
+    });
+});
+
+describe('#serialize', () => {
+    it('should serialize JSON', () => {
+        const input = '{"foo": "bar"}';
+        const output = serialize(input);
+        assert.strictEqual(output.isYAML, false);
+        assert.deepEqual(output.parsed, {foo: "bar"});
+    });
+
+    it('should serialize YAML', () => {
+        const input = 'foo: bar';
+        const output = serialize(input);
+        assert.strictEqual(output.isYAML, true);
+        assert.deepEqual(output.parsed, {foo: "bar"});
+    });
+
+    it('should serialize YAML (with JSON syntax)', () => {
+        const input = '{foo: bar}';
+        const output = serialize(input);
+        assert.strictEqual(output.isYAML, true);
+        assert.deepEqual(output.parsed, {foo: "bar"});
+    });
+
+    it('should throw error', () => {
+        const input = '%{foo: bar}';
+        try {
+            serialize(input);
+        } catch(e) {
+            assert.strictEqual(e.message, 'AsyncAPI document must be a valid JSON or YAML document.');
+        }
+    });
 });
 
 /*
@@ -205,4 +248,4 @@ function removeLineBreaks(str) {
 
 function assertResults(output, result){
     assert.strictEqual(removeLineBreaks(output), removeLineBreaks(result));
-}
+}

package/test/input/2.0.0/streetlights.json

@@ -0,0 +1,172 @@
+{
+  "asyncapi": "2.0.0",
+  "info": {
+    "title": "Streetlights API",
+    "version": "1.0.0",
+    "description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off 🌃\n* Dim a specific streetlight 😎\n* Receive real-time information about environmental lighting conditions 📈\n",
+    "license": {
+      "name": "Apache 2.0",
+      "url": "https://www.apache.org/licenses/LICENSE-2.0"
+    }
+  },
+  "servers": {
+    "default": {
+      "url": "api.streetlights.smartylighting.com:{port}",
+      "description": "Test broker",
+      "variables": {
+        "port": {
+          "description": "Secure connection (TLS) is available through port 8883.",
+          "default": "1883",
+          "enum": [
+            "1883",
+            "8883"
+          ]
+        }
+      },
+      "protocol": "mqtt",
+      "security": [
+        {
+          "apiKey": []
+        }
+      ]
+    }
+  },
+  "components": {
+    "messages": {
+      "lightMeasured": {
+        "summary": "Inform about environmental lighting conditions for a particular streetlight.",
+        "payload": {
+          "$ref": "#/components/schemas/lightMeasuredPayload"
+        }
+      },
+      "turnOnOff": {
+        "summary": "Command a particular streetlight to turn the lights on or off.",
+        "payload": {
+          "$ref": "#/components/schemas/turnOnOffPayload"
+        }
+      },
+      "dimLight": {
+        "summary": "Command a particular streetlight to dim the lights.",
+        "payload": {
+          "$ref": "#/components/schemas/dimLightPayload"
+        }
+      }
+    },
+    "schemas": {
+      "lightMeasuredPayload": {
+        "type": "object",
+        "properties": {
+          "lumens": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Light intensity measured in lumens."
+          },
+          "sentAt": {
+            "$ref": "#/components/schemas/sentAt"
+          }
+        }
+      },
+      "turnOnOffPayload": {
+        "type": "object",
+        "properties": {
+          "command": {
+            "type": "string",
+            "enum": [
+              "on",
+              "off"
+            ],
+            "description": "Whether to turn on or off the light."
+          },
+          "sentAt": {
+            "$ref": "#/components/schemas/sentAt"
+          }
+        }
+      },
+      "dimLightPayload": {
+        "type": "object",
+        "properties": {
+          "percentage": {
+            "type": "integer",
+            "description": "Percentage to which the light should be dimmed to.",
+            "minimum": 0,
+            "maximum": 100
+          },
+          "sentAt": {
+            "$ref": "#/components/schemas/sentAt"
+          }
+        }
+      },
+      "sentAt": {
+        "type": "string",
+        "format": "date-time",
+        "description": "Date and time when the message was sent."
+      }
+    },
+    "securitySchemes": {
+      "apiKey": {
+        "type": "apiKey",
+        "in": "user",
+        "description": "Provide your API key as the user and leave the password empty."
+      }
+    },
+    "parameters": {
+      "streetlightId": {
+        "name": "streetlightId",
+        "description": "The ID of the streetlight.",
+        "schema": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "channels": {
+    "smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "publish": {
+        "message": {
+          "$ref": "#/components/messages/lightMeasured"
+        }
+      }
+    },
+    "smartylighting/streetlights/1/0/action/{streetlightId}/turn/on": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/turnOnOff"
+        }
+      }
+    },
+    "smartylighting/streetlights/1/0/action/{streetlightId}/turn/off": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/turnOnOff"
+        }
+      }
+    },
+    "smartylighting/streetlights/1/0/action/{streetlightId}/dim": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/dimLight"
+        }
+      }
+    }
+  }
+}

package/test/output/2.1.0/streetlights.json

@@ -0,0 +1,172 @@
+{
+  "asyncapi": "2.1.0",
+  "info": {
+    "title": "Streetlights API",
+    "version": "1.0.0",
+    "description": "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off 🌃\n* Dim a specific streetlight 😎\n* Receive real-time information about environmental lighting conditions 📈\n",
+    "license": {
+      "name": "Apache 2.0",
+      "url": "https://www.apache.org/licenses/LICENSE-2.0"
+    }
+  },
+  "servers": {
+    "default": {
+      "url": "api.streetlights.smartylighting.com:{port}",
+      "description": "Test broker",
+      "variables": {
+        "port": {
+          "description": "Secure connection (TLS) is available through port 8883.",
+          "default": "1883",
+          "enum": [
+            "1883",
+            "8883"
+          ]
+        }
+      },
+      "protocol": "mqtt",
+      "security": [
+        {
+          "apiKey": []
+        }
+      ]
+    }
+  },
+  "components": {
+    "messages": {
+      "lightMeasured": {
+        "summary": "Inform about environmental lighting conditions for a particular streetlight.",
+        "payload": {
+          "$ref": "#/components/schemas/lightMeasuredPayload"
+        }
+      },
+      "turnOnOff": {
+        "summary": "Command a particular streetlight to turn the lights on or off.",
+        "payload": {
+          "$ref": "#/components/schemas/turnOnOffPayload"
+        }
+      },
+      "dimLight": {
+        "summary": "Command a particular streetlight to dim the lights.",
+        "payload": {
+          "$ref": "#/components/schemas/dimLightPayload"
+        }
+      }
+    },
+    "schemas": {
+      "lightMeasuredPayload": {
+        "type": "object",
+        "properties": {
+          "lumens": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Light intensity measured in lumens."
+          },
+          "sentAt": {
+            "$ref": "#/components/schemas/sentAt"
+          }
+        }
+      },
+      "turnOnOffPayload": {
+        "type": "object",
+        "properties": {
+          "command": {
+            "type": "string",
+            "enum": [
+              "on",
+              "off"
+            ],
+            "description": "Whether to turn on or off the light."
+          },
+          "sentAt": {
+            "$ref": "#/components/schemas/sentAt"
+          }
+        }
+      },
+      "dimLightPayload": {
+        "type": "object",
+        "properties": {
+          "percentage": {
+            "type": "integer",
+            "description": "Percentage to which the light should be dimmed to.",
+            "minimum": 0,
+            "maximum": 100
+          },
+          "sentAt": {
+            "$ref": "#/components/schemas/sentAt"
+          }
+        }
+      },
+      "sentAt": {
+        "type": "string",
+        "format": "date-time",
+        "description": "Date and time when the message was sent."
+      }
+    },
+    "securitySchemes": {
+      "apiKey": {
+        "type": "apiKey",
+        "in": "user",
+        "description": "Provide your API key as the user and leave the password empty."
+      }
+    },
+    "parameters": {
+      "streetlightId": {
+        "name": "streetlightId",
+        "description": "The ID of the streetlight.",
+        "schema": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "channels": {
+    "smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "publish": {
+        "message": {
+          "$ref": "#/components/messages/lightMeasured"
+        }
+      }
+    },
+    "smartylighting/streetlights/1/0/action/{streetlightId}/turn/on": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/turnOnOff"
+        }
+      }
+    },
+    "smartylighting/streetlights/1/0/action/{streetlightId}/turn/off": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/turnOnOff"
+        }
+      }
+    },
+    "smartylighting/streetlights/1/0/action/{streetlightId}/dim": {
+      "parameters": {
+        "streetlightId": {
+          "$ref": "#/components/parameters/streetlightId"
+        }
+      },
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/dimLight"
+        }
+      }
+    }
+  }
+}