sttp.tapir.asyncapi
package sttp.tapir.asyncapi
Type members
Classlikes
case
class AsyncAPI(asyncapi: String, id: Option[String], info: Info, servers: ListMap[String, Server], channels: ListMap[String, ReferenceOr[ChannelItem]], components: Option[Components], tags: List[Tag], externalDocs: Option[ExternalDocumentation], extensions: ListMap[String, ExtensionValue])
case
class ChannelItem(description: Option[String], subscribe: Option[Operation], publish: Option[Operation], parameters: ListMap[String, ReferenceOr[Parameter]], bindings: List[ChannelBinding], extensions: ListMap[String, ExtensionValue])
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]], extensions: ListMap[String, ExtensionValue])
case
class Contact(name: Option[String], url: Option[String], email: Option[String], extensions: ListMap[String, ExtensionValue])
case
class CorrelationId(description: Option[String], location: String, extensions: ListMap[String, ExtensionValue])
case
class HttpMessageBinding(headers: Option[Schema], bindingVersion: Option[String]) extends MessageBinding
case
class HttpOperationBinding(`type`: String, method: Option[String], query: Option[Schema], bindingVersion: Option[String]) extends OperationBinding
case
class KafkaMessageBinding(key: Option[Schema], bindingVersion: Option[String]) extends MessageBinding
case
class KafkaOperationBinding(groupId: Option[Schema], clientId: Option[Schema], bindingVersion: Option[String]) extends OperationBinding
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], extensions: ListMap[String, ExtensionValue])
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]], extensions: ListMap[String, ExtensionValue])
case
class OperationTrait(operationId: Option[String], summary: Option[String], description: Option[String], tags: List[Tag], externalDocs: Option[ExternalDocumentation], bindings: List[OperationBinding], extensions: ListMap[String, ExtensionValue])
case
class Parameter(description: Option[String], schema: Option[Schema], location: Option[String], extensions: ListMap[String, ExtensionValue])
case
class Server(url: String, protocol: String, protocolVersion: Option[String], description: Option[String], variables: ListMap[String, ServerVariable], security: List[SecurityRequirement], bindings: List[ServerBinding], extensions: ListMap[String, ExtensionValue])
case
class ServerVariable(enum: List[String], default: Option[String], description: Option[String], examples: List[String], extensions: ListMap[String, ExtensionValue])
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[Map[String, List[ExampleValue]]], traits: List[ReferenceOr[MessageTrait]], extensions: ListMap[String, ExtensionValue]) extends Message
case
class WebSocketChannelBinding(method: String, query: Option[Schema], headers: Option[Schema], bindingVersion: Option[String]) extends ChannelBinding