package
asyncapi
Type Members
-
case class
AnyValue(value: String) extends Product with Serializable
-
case class
AsyncAPI(asyncapi: String = "2.0.0", id: Option[String], info: Info, servers: ListMap[String, Server], channels: ListMap[String, ReferenceOr[ChannelItem]], components: Option[Components], tags: List[Tag], externalDocs: Option[ExternalDocumentation]) extends Product with Serializable
-
sealed
trait
ChannelBinding extends AnyRef
-
case class
ChannelItem(description: Option[String], subscribe: Option[Operation], publish: Option[Operation], parameters: ListMap[String, ReferenceOr[Parameter]], bindings: List[ChannelBinding]) extends Product with Serializable
-
case class
Components(schemas: ListMap[String, ReferenceOr[Schema]], messages: ListMap[String, ReferenceOr[Message]], securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]], parameters: ListMap[String, ReferenceOr[Parameter]], correlationIds: ListMap[String, ReferenceOr[CorrelationId]], operationTraits: ListMap[String, ReferenceOr[OperationTrait]], messageTraits: ListMap[String, ReferenceOr[MessageTrait]]) extends Product with Serializable
-
case class
Contact(name: Option[String] = None, url: Option[String] = None, email: Option[String] = None) extends Product with Serializable
-
case class
CorrelationId(description: Option[String], location: String) extends Product with Serializable
-
case class
HttpChannelBinding() extends ChannelBinding with Product with Serializable
-
case class
HttpMessageBinding(headers: Option[Schema], bindingVersion: Option[String]) extends MessageBinding with Product with Serializable
-
case class
HttpOperationBinding(type: String, method: Option[String], query: Option[Schema], bindingVersion: Option[String]) extends OperationBinding with Product with Serializable
-
case class
HttpServerBinding() extends ServerBinding with Product with Serializable
-
case class
Info(title: String, version: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[Contact] = None, license: Option[License] = None) extends Product with Serializable
-
case class
KafkaChannelBinding() extends ChannelBinding with Product with Serializable
-
case class
KafkaMessageBinding(key: Option[Schema], bindingVersion: Option[String]) extends MessageBinding with Product with Serializable
-
case class
KafkaOperationBinding(groupId: Option[Schema], clientId: Option[Schema], bindingVersion: Option[String]) extends OperationBinding with Product with Serializable
-
case class
KafkaServerBinding() extends ServerBinding with Product with Serializable
-
case class
License(name: String, url: Option[String] = None) extends Product with Serializable
-
sealed
trait
Message extends AnyRef
-
sealed
trait
MessageBinding extends AnyRef
-
case class
MessageTrait(headers: Option[ReferenceOr[Schema]], correlationId: Option[ReferenceOr[Schema]], schemaFormat: Option[String], contentType: Option[String], name: Option[String], title: Option[String], summary: Option[String], description: Option[String], tags: List[Tag], externalDocs: Option[ExternalDocumentation], bindings: List[MessageBinding], examples: ListMap[String, ExampleValue]) extends Product with Serializable
-
case class
OneOfMessage(oneOf: List[SingleMessage]) extends Message with Product with Serializable
-
case class
Operation(operationId: Option[String], summary: Option[String], description: Option[String], tags: List[Tag], externalDocs: Option[ExternalDocumentation], bindings: List[OperationBinding], traits: List[OperationTrait], message: Option[ReferenceOr[Message]]) extends Product with Serializable
-
sealed
trait
OperationBinding extends AnyRef
-
case class
OperationTrait(operationId: Option[String], summary: Option[String], description: Option[String], tags: List[Tag], externalDocs: Option[ExternalDocumentation], bindings: List[OperationBinding]) extends Product with Serializable
-
case class
Parameter(description: Option[String], schema: Option[Schema], location: Option[String]) extends Product with Serializable
-
case class
Server(url: String, protocol: String, protocolVersion: Option[String] = None, description: Option[String] = None, variables: ListMap[String, ServerVariable] = ListMap.empty, security: List[SecurityRequirement] = Nil, bindings: List[ServerBinding] = Nil) extends Product with Serializable
-
sealed
trait
ServerBinding extends AnyRef
-
case class
ServerVariable(enum: List[String], default: Option[String], description: Option[String], examples: List[String]) extends Product with Serializable
-
case class
SingleMessage(headers: Option[ReferenceOr[Schema]], payload: Option[Either[AnyValue, ReferenceOr[Schema]]], correlationId: Option[ReferenceOr[Schema]], schemaFormat: Option[String], contentType: Option[String], name: Option[String], title: Option[String], summary: Option[String], description: Option[String], tags: List[Tag], externalDocs: Option[ExternalDocumentation], bindings: List[MessageBinding], examples: List[ExampleValue], traits: List[ReferenceOr[MessageTrait]]) extends Message with Product with Serializable
-
case class
WebSocketChannelBinding(method: String, query: Option[Schema], headers: Option[Schema], bindingVersion: Option[String]) extends ChannelBinding with Product with Serializable
-
case class
WebSocketMessageBinding() extends MessageBinding with Product with Serializable
-
case class
WebSocketOperationBinding() extends OperationBinding with Product with Serializable
-
case class
WebSocketServerBinding() extends ServerBinding with Product with Serializable