chore: updating project metadata (#669)

* chore: updating project metadata

Signed-off-by: Pawel Psztyc <[email protected]>

* test: add tests for APIC-571 and APIC-559

* test: add test for APIC-570

* test: add test for APIC-562

* chore(models): add anyOf async api

* test: add test for APIC-561

* chore(models): add streetlights.yaml

* test: add test for APIC-560

* chore(deps): regenerate package-lock.json

Co-authored-by: Francisco Di Giandomenico <[email protected]>

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "cSpell.words": [
+    "Apic",
+    "RAML's",
+    "Tyit",
+    "apiserverchanged",
+    "tryit"
+  ]
+}

demo/apis.json

@@ -16,5 +16,8 @@
   "models/async-api/async-api.yaml": "ASYNC 2.0",
   "models/APIC-553/APIC-553.raml": "RAML 1.0",
   "models/APIC-554/APIC-554.raml": "RAML 1.0",
-  "models/APIC-557/APIC-557.yaml": "OAS 3.0"
+  "models/APIC-557/APIC-557.yaml": "OAS 3.0",
+  "models/APIC-538/APIC-538.raml": "RAML 1.0",
+  "models/anyOf/anyOf.yaml": "ASYNC 2.0",
+  "models/streetlights/streetlights.yaml": "ASYNC 2.0"
 }

demo/element/app.js

@@ -25,6 +25,8 @@ class ApicApplication extends DemoBase {
       ['APIC-553', 'APIC-553'],
       ['APIC-557', 'APIC-557'],
       ['APIC-558', 'APIC-558'],
+      ['anyOf', 'AnyOf'],
+      ['streetlights', 'Streetlights'],
     ];
 
     this.toggleConsoleMenu = this.toggleConsoleMenu.bind(this);

demo/models/APIC-538/APIC-538.raml

@@ -0,0 +1,20 @@
+#%RAML 1.0
+title: APIC-538
+version: v1
+baseUri: http://domain.com/
+
+securitySchemes:
+  oauth_2_0:
+     type: OAuth 2.0
+     settings:
+       accessTokenUri: http://api.domain.com/oauth2/token
+       authorizationUri: http://api.domain.com/oauth2/auth
+       authorizationGrants: ["authorization_code"]
+
+/test:
+  securedBy: [oauth_2_0]
+  get:
+    responses:
+      200:
+        body:
+          application/json: 

demo/models/anyOf/anyOf.yaml

@@ -0,0 +1,37 @@
+asyncapi: '2.0.0'
+info:
+  title: AnyOf example
+  version: '1.0.0'
+
+channels:
+  test:
+    publish:
+      message:
+        $ref: '#/components/messages/testMessages'
+
+components:
+  messages:
+    testMessages:
+      payload:
+        anyOf: # anyOf in payload schema
+          - $ref: "#/components/schemas/objectWithKey"
+          - $ref: "#/components/schemas/objectWithKey2"
+    testMessage1:
+      payload: 
+        $ref: "#/components/schemas/objectWithKey2"
+
+  schemas:
+    objectWithKey:
+      type: object
+      properties:
+        key:
+          type: string
+          additionalProperties: false
+    objectWithKey2:
+      type: object
+      properties:
+        key2:
+          type: number
+        prop: 
+          type: boolean
+

demo/models/async-api/async-api.yaml

@@ -17,7 +17,7 @@ channels:
       message:
         $ref: '#/components/messages/hello-msg'
   goodbye:
-    publish:
+    subscribe:
       message:
         $ref: '#/components/messages/goodbye-msg'
 components:

demo/models/streetlights/streetlights.yaml

@@ -0,0 +1,209 @@
+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.
+
+    ### Check out its awesome features:
+
+    * Turn a specific streetlight on/off 🌃
+    * Dim a specific streetlight 😎
+    * Receive real-time information about environmental lighting conditions 📈
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0
+
+servers:
+  production:
+    url: api.streetlights.smartylighting.com:{port}
+    protocol: mqtt
+    description: Test broker
+    variables:
+      port:
+        description: Secure connection (TLS) is available through port 8883.
+        default: '1883'
+        enum:
+          - '1883'
+          - '8883'
+    security:
+      - apiKey: []
+      - supportedOauthFlows:
+        - streetlights:on
+        - streetlights:off
+        - streetlights:dim
+      - openIdConnectWellKnown: []
+
+defaultContentType: application/json
+
+channels:
+  smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured:
+    description: The topic on which measured values may be produced and consumed.
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    subscribe:
+      summary: Receive information about environmental lighting conditions of a particular streetlight.
+      operationId: receiveLightMeasurement
+      traits:
+        - $ref: '#/components/operationTraits/kafka'
+      message:
+        $ref: '#/components/messages/lightMeasured'
+
+  smartylighting/streetlights/1/0/action/{streetlightId}/turn/on:
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      operationId: turnOn
+      traits:
+        - $ref: '#/components/operationTraits/kafka'
+      message:
+        $ref: '#/components/messages/turnOnOff'
+
+  smartylighting/streetlights/1/0/action/{streetlightId}/turn/off:
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      operationId: turnOff
+      traits:
+        - $ref: '#/components/operationTraits/kafka'
+      message:
+        $ref: '#/components/messages/turnOnOff'
+
+  smartylighting/streetlights/1/0/action/{streetlightId}/dim:
+    parameters:
+      streetlightId:
+        $ref: '#/components/parameters/streetlightId'
+    publish:
+      operationId: dimLight
+      traits:
+        - $ref: '#/components/operationTraits/kafka'
+      message:
+        $ref: '#/components/messages/dimLight'
+
+components:
+  messages:
+    lightMeasured:
+      name: lightMeasured
+      title: Light measured
+      summary: Inform about environmental lighting conditions for a particular streetlight.
+      contentType: application/json
+      traits:
+        - $ref: '#/components/messageTraits/commonHeaders'
+      payload:
+        $ref: "#/components/schemas/lightMeasuredPayload"
+    turnOnOff:
+      name: turnOnOff
+      title: Turn on/off
+      summary: Command a particular streetlight to turn the lights on or off.
+      traits:
+        - $ref: '#/components/messageTraits/commonHeaders'
+      payload:
+        $ref: "#/components/schemas/turnOnOffPayload"
+    dimLight:
+      name: dimLight
+      title: Dim light
+      summary: Command a particular streetlight to dim the lights.
+      traits:
+        - $ref: '#/components/messageTraits/commonHeaders'
+      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.
+    supportedOauthFlows:
+      type: oauth2
+      description: Flows to support OAuth 2.0
+      flows:
+        implicit:
+          authorizationUrl: 'https://authserver.example/auth'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+        password:
+          tokenUrl: 'https://authserver.example/token'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+        clientCredentials:
+          tokenUrl: 'https://authserver.example/token'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+        authorizationCode:
+          authorizationUrl: 'https://authserver.example/auth'
+          tokenUrl: 'https://authserver.example/token'
+          refreshUrl: 'https://authserver.example/refresh'
+          scopes:
+            'streetlights:on': Ability to switch lights on
+            'streetlights:off': Ability to switch lights off
+            'streetlights:dim': Ability to dim the lights
+    openIdConnectWellKnown:
+      type: openIdConnect
+      openIdConnectUrl: 'https://authserver.example/.well-known'
+
+  parameters:
+    streetlightId:
+      description: The ID of the streetlight.
+      schema:
+        type: string
+
+  messageTraits:
+    commonHeaders:
+      headers:
+        type: object
+        properties:
+          my-app-header:
+            type: integer
+            minimum: 0
+            maximum: 100
+
+  operationTraits:
+    kafka:
+      bindings:
+        kafka:
+          clientId: my-app-id

demo/themed/anypoint.js

@@ -16,15 +16,15 @@ class ApicApplication extends DemoBase {
       ['google-drive-api', 'Google Drive API'],
       ['httpbin', 'HTTPbin API'],
       ['data-type-fragment', 'RAML data type fragment'],
-      ['demo-api', 'Demo API']
+      ['demo-api', 'Demo API'],
+      ['APIC-538', 'APIC-538'],
     ];
   }
 
   demoTemplate() {
     return html`<api-console-app
-      app
-      redirecturi="https://auth.advancedrestclient.com/oauth-popup.html"
-      oauth2clientid="821776164331-rserncqpdsq32lmbf5cfeolgcoujb6fm.apps.googleusercontent.com"
+      redirectUri="https://auth.advancedrestclient.com/oauth-popup.html"
+      oauth2ClientId="821776164331-rserncqpdsq32lmbf5cfeolgcoujb6fm.apps.googleusercontent.com"
       compatibility>
       <anypoint-icon-button
         slot="toolbar"