-
-
Save Amzani/7df1d67d7eb665bdc7a2a5dd7e794e0c to your computer and use it in GitHub Desktop.
Invalid-asyncapi.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
asyncapi: '2.6.0' | |
info: | |
title: Streetlights Kafka 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: | |
test: | |
url: test.mykafkacluster.org:8092 | |
protocol: kafka-secure | |
description: Test broker | |
security: | |
- saslScram: [] | |
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' | |
publish: | |
summary: Inform 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' | |
subscribe: | |
operationId: turnOn | |
traits: | |
- $ref: '#/components/operationTraits/kafka' | |
message: | |
$ref: '#/components/messages/turn On Off' | |
smartylighting.streetlights.1.0.action.{streetlightId}.turn.off: | |
parameters: | |
streetlightId: | |
$ref: '#/components/parameters/streetlightId' | |
subscribe: | |
operationId: turnOff | |
traits: | |
- $ref: '#/components/operationTraits/kafka' | |
message: | |
$ref: '#/components/messages/turn On Off' | |
smartylighting.streetlights.1.0.action.{streetlightId}.dim: | |
parameters: | |
streetlightId: | |
$ref: '#/components/parameters/streetlightId' | |
subscribe: | |
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 of a particular streetlight. | |
contentType: application/json | |
traits: | |
- $ref: '#/components/messageTraits/commonHeaders' | |
payload: | |
$ref: "#/components/schemas/lightMeasuredPayload" | |
turn On Off: | |
name: turnO nOff | |
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/turn On OffPayload" | |
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" | |
turn On OffPayload: | |
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: | |
saslScram: | |
type: scramSha256 | |
description: Provide your username and password for SASL/SCRAM authentication | |
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment