reference-examples-correlation-id-asyncapi.yml.json

{"asyncapi":"3.1.0","info":{"title":"Correlation ID Example","version":"1.0.0","description":"A cut of the Streetlights API to test Correlation ID","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"servers":{"production":{"host":"test.mosquitto.org:{port}","protocol":"mqtt","description":"Test broker","variables":{"port":{"enum":["1883","8883"],"default":"1883","description":"Secure connection (TLS) is available through port 8883."}},"security":[{"$ref":"#/components/securitySchemes/apiKey"},{"type":"oauth2","description":"Flows to support OAuth 2.0","flows":{"implicit":{"authorizationUrl":"https://authserver.example/auth","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}},"password":{"tokenUrl":"https://authserver.example/token","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}},"clientCredentials":{"tokenUrl":"https://authserver.example/token","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}},"authorizationCode":{"authorizationUrl":"https://authserver.example/auth","tokenUrl":"https://authserver.example/token","refreshUrl":"https://authserver.example/refresh","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}}},"scopes":["streetlights:on","streetlights:off","streetlights:dim"]},{"$ref":"#/components/securitySchemes/openIdConnectWellKnown"}]}},"defaultContentType":"application/json","channels":{"lightingMeasured":{"address":"smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured","messages":{"lightMeasured":{"$ref":"#/components/messages/lightMeasured"}},"parameters":{"streetlightId":{"$ref":"#/components/parameters/streetlightId"}}},"lightsDim":{"address":"smartylighting/streetlights/1/0/action/{streetlightId}/dim","messages":{"dimLight":{"$ref":"#/components/messages/dimLight"}},"parameters":{"streetlightId":{"$ref":"#/components/parameters/streetlightId"}}}},"operations":{"dimLight":{"action":"send","channel":{"$ref":"#/channels/lightsDim"},"messages":[{"$ref":"#/channels/lightsDim/messages/dimLight"}]},"receiveLightMeasurement":{"action":"receive","channel":{"$ref":"#/channels/lightingMeasured"},"summary":"Inform about environmental lighting conditions of a particular streetlight.","messages":[{"$ref":"#/channels/lightingMeasured/messages/lightMeasured"}]}},"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"}},"messages":{"dimLight":{"payload":{"$ref":"#/components/schemas/dimLightPayload"},"correlationId":{"$ref":"#/components/correlationIds/sentAtCorrelator"},"name":"dimLight","title":"Dim light","summary":"Command a particular streetlight to dim the lights."},"lightMeasured":{"payload":{"$ref":"#/components/schemas/lightMeasuredPayload"},"correlationId":{"location":"$message.header#/MQMD/CorrelId"},"contentType":"application/json","name":"lightMeasured","title":"Light measured","summary":"Inform about environmental lighting conditions of a particular streetlight."}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Provide your API key as the user and leave the password empty.","in":"user"},"openIdConnectWellKnown":{"type":"openIdConnect","openIdConnectUrl":"https://authserver.example/.well-known"},"supportedOauthFlows":{"type":"oauth2","description":"Flows to support OAuth 2.0","flows":{"implicit":{"authorizationUrl":"https://authserver.example/auth","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}},"password":{"tokenUrl":"https://authserver.example/token","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}},"clientCredentials":{"tokenUrl":"https://authserver.example/token","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}},"authorizationCode":{"authorizationUrl":"https://authserver.example/auth","tokenUrl":"https://authserver.example/token","refreshUrl":"https://authserver.example/refresh","availableScopes":{"streetlights:dim":"Ability to dim the lights","streetlights:off":"Ability to switch lights off","streetlights:on":"Ability to switch lights on"}}}}},"parameters":{"streetlightId":{"description":"The ID of the streetlight."}},"correlationIds":{"sentAtCorrelator":{"description":"Data from message payload used as correlation ID","location":"$message.payload#/sentAt"}}}}