reference-examples-gitter-streaming-asyncapi.yml.json

{"asyncapi":"3.1.0","id":"tag:stream.gitter.im,2022:api","info":{"title":"Gitter Streaming API","version":"1.0.0"},"servers":{"production":{"host":"stream.gitter.im","protocol":"https","protocolVersion":"1.1","pathname":"/v1","security":[{"$ref":"#/components/securitySchemes/httpBearerToken"}]}},"channels":{"rooms":{"address":"/rooms/{roomId}/{resource}","messages":{"chatMessage":{"$ref":"#/components/messages/chatMessage"},"heartbeat":{"$ref":"#/components/messages/heartbeat"}},"parameters":{"resource":{"enum":["chatMessages","events"],"description":"The resource to consume."},"roomId":{"description":"Id of the Gitter room.","examples":["53307860c3599d1de448e19d"]}}}},"operations":{"sendRoomInfo":{"action":"send","channel":{"$ref":"#/channels/rooms"},"bindings":{"http":{"method":"POST"}},"messages":[{"$ref":"#/channels/rooms/messages/chatMessage"},{"$ref":"#/channels/rooms/messages/heartbeat"}]}},"components":{"messages":{"chatMessage":{"payload":{"schemaFormat":"application/schema+yaml;version=draft-07","schema":{"properties":{"fromUser":{"description":"User that sent the message.","properties":{"avatarUrl":{"description":"User avatar URI.","format":"uri","type":"string"},"avatarUrlMedium":{"description":"User avatar URI (medium).","format":"uri","type":"string"},"avatarUrlSmall":{"description":"User avatar URI (small).","format":"uri","type":"string"},"displayName":{"description":"Gitter/GitHub user real name.","type":"string"},"gv":{"description":"Stands for \"Gravatar version\" and is used for cache busting.","type":"string"},"id":{"description":"Gitter User ID.","type":"string"},"url":{"description":"Path to the user on Gitter.","type":"string"},"username":{"description":"Gitter/GitHub username.","type":"string"},"v":{"description":"Version.","type":"number"}},"type":"object"},"gv":{"description":"Stands for \"Gravatar version\" and is used for cache busting.","type":"string"},"html":{"description":"HTML formatted message.","type":"string"},"id":{"description":"ID of the message.","type":"string"},"issues":{"description":"List of #Issues referenced in the message.","items":{"properties":{"number":{"type":"string"}},"type":"object"},"type":"array"},"mentions":{"description":"List of @Mentions in the message.","items":{"properties":{"screenName":{"type":"string"},"userId":{"type":"string"},"userIds":{"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"},"meta":{"description":"Metadata. This is currently not used for anything.","items":{},"type":"array"},"readBy":{"description":"Number of users that have read the message.","type":"number"},"sent":{"description":"ISO formatted date of the message.","format":"date-time","type":"string"},"text":{"description":"Original message in plain-text/markdown.","type":"string"},"unread":{"description":"Boolean that indicates if the current user has read the message.","type":"boolean"},"urls":{"description":"List of URLs present in the message.","items":{"format":"uri","type":"string"},"type":"array"},"v":{"description":"Version.","type":"number"}},"type":"object"}},"summary":"A message represents an individual chat message sent to a room. They are a sub-resource of a room.","bindings":{"http":{"headers":{"properties":{"Trailer":{"const":"\\r\\n","type":"string"},"Transfer-Encoding":{"const":"chunked","type":"string"}},"type":"object"}}}},"heartbeat":{"payload":{"schemaFormat":"application/schema+yaml;version=draft-07","schema":{"enum":["\r\n"],"type":"string"}},"summary":"Its purpose is to keep the connection alive.","bindings":{"http":{"headers":{"properties":{"Trailer":{"const":"\\r\\n","type":"string"},"Transfer-Encoding":{"const":"chunked","type":"string"}},"type":"object"}}}}},"securitySchemes":{"httpBearerToken":{"type":"http","scheme":"bearer"}}}}