reference-examples-streetlights-operation-security-asyncapi.yml.json

{"asyncapi":"3.1.0","info":{"title":"Streetlights Kafka 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":{"test":{"host":"test.mykafkacluster.org:8092","protocol":"kafka-secure","description":"Test broker","security":[{"$ref":"#/components/securitySchemes/saslScram"}]},"test_oauth":{"host":"test.mykafkacluster.org:8093","protocol":"kafka-secure","description":"Test port for oauth","security":[{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"streetlights:read":"Scope required for subscribing to channel","streetlights:write":"Scope required for publishing to channel"}}},"scopes":["streetlights:write","streetlights:read"]}]}},"defaultContentType":"application/json","channels":{"lightTurnOff":{"address":"smartylighting.streetlights.1.0.action.{streetlightId}.turn.off","messages":{"turnOff":{"$ref":"#/components/messages/turnOnOff"}},"servers":[{"$ref":"#/servers/test_oauth"}],"parameters":{"streetlightId":{"$ref":"#/components/parameters/streetlightId"}}},"lightTurnOn":{"address":"smartylighting.streetlights.1.0.action.{streetlightId}.turn.on","messages":{"turnOn":{"$ref":"#/components/messages/turnOnOff"}},"servers":[{"$ref":"#/servers/test_oauth"}],"parameters":{"streetlightId":{"$ref":"#/components/parameters/streetlightId"}}},"lightingMeasured":{"address":"smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured","messages":{"lightMeasured":{"$ref":"#/components/messages/lightMeasured"}},"description":"The topic on which measured values may be produced and consumed.","servers":[{"$ref":"#/servers/test"}],"parameters":{"streetlightId":{"$ref":"#/components/parameters/streetlightId"}}},"lightsDim":{"address":"smartylighting.streetlights.1.0.action.{streetlightId}.dim","messages":{"dimLight":{"$ref":"#/components/messages/dimLight"}},"servers":[{"$ref":"#/servers/test_oauth"}],"parameters":{"streetlightId":{"$ref":"#/components/parameters/streetlightId"}}}},"operations":{"dimLight":{"action":"send","channel":{"$ref":"#/channels/lightsDim"},"security":[{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"streetlights:read":"Scope required for subscribing to channel","streetlights:write":"Scope required for publishing to channel"}}},"scopes":["streetlights:read"]}],"traits":[{"$ref":"#/components/operationTraits/kafka"}],"messages":[{"$ref":"#/channels/lightsDim/messages/dimLight"}]},"receiveLightMeasurement":{"action":"receive","channel":{"$ref":"#/channels/lightingMeasured"},"summary":"Inform about environmental lighting conditions of a particular streetlight.","traits":[{"$ref":"#/components/operationTraits/kafka"}],"messages":[{"$ref":"#/channels/lightingMeasured/messages/lightMeasured"}]},"turnOff":{"action":"send","channel":{"$ref":"#/channels/lightTurnOff"},"security":[{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"streetlights:read":"Scope required for subscribing to channel","streetlights:write":"Scope required for publishing to channel"}}},"scopes":["streetlights:read"]}],"traits":[{"$ref":"#/components/operationTraits/kafka"}],"messages":[{"$ref":"#/channels/lightTurnOff/messages/turnOff"}]},"turnOn":{"action":"send","channel":{"$ref":"#/channels/lightTurnOn"},"security":[{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"streetlights:read":"Scope required for subscribing to channel","streetlights:write":"Scope required for publishing to channel"}}},"scopes":["streetlights:read"]}],"traits":[{"$ref":"#/components/operationTraits/kafka"}],"messages":[{"$ref":"#/channels/lightTurnOn/messages/turnOn"}]}},"components":{"schemas":{"dimLightPayload":{"type":"object","properties":{"percentage":{"type":"integer","maximum":100,"minimum":0,"description":"Percentage to which the light should be dimmed to."},"sentAt":{"$ref":"#/components/schemas/sentAt"}}},"lightMeasuredPayload":{"type":"object","properties":{"lumens":{"type":"integer","minimum":0,"description":"Light intensity measured in lumens."},"sentAt":{"$ref":"#/components/schemas/sentAt"}}},"sentAt":{"type":"string","description":"Date and time when the message was sent.","format":"date-time"},"turnOnOffPayload":{"type":"object","properties":{"command":{"type":"string","enum":["on","off"],"description":"Whether to turn on or off the light."},"sentAt":{"$ref":"#/components/schemas/sentAt"}}}},"messages":{"dimLight":{"payload":{"$ref":"#/components/schemas/dimLightPayload"},"name":"dimLight","title":"Dim light","summary":"Command a particular streetlight to dim the lights.","traits":[{"$ref":"#/components/messageTraits/commonHeaders"}]},"lightMeasured":{"payload":{"$ref":"#/components/schemas/lightMeasuredPayload"},"contentType":"application/json","name":"lightMeasured","title":"Light measured","summary":"Inform about environmental lighting conditions of a particular streetlight.","traits":[{"$ref":"#/components/messageTraits/commonHeaders"}]},"turnOnOff":{"payload":{"$ref":"#/components/schemas/turnOnOffPayload"},"name":"turnOnOff","title":"Turn on/off","summary":"Command a particular streetlight to turn the lights on or off.","traits":[{"$ref":"#/components/messageTraits/commonHeaders"}]}},"securitySchemes":{"saslScram":{"type":"scramSha256","description":"Provide your username and password for SASL/SCRAM authentication"},"streetlights_auth":{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"streetlights:read":"Scope required for subscribing to channel","streetlights:write":"Scope required for publishing to channel"}}}}},"parameters":{"streetlightId":{"description":"The ID of the streetlight."}},"operationTraits":{"kafka":{"bindings":{"kafka":{"clientId":{"enum":["my-app-id"],"type":"string"}}}}},"messageTraits":{"commonHeaders":{"headers":{"type":"object","properties":{"my-app-header":{"type":"integer","maximum":100,"minimum":0}}}}}}}