asyncapi-model
API
Generated with
asyncapi-model/sttp.apispec.asyncapi

sttp.apispec.asyncapi

package sttp.apispec.asyncapi

Members list

Type members

Classlikes

case class AnyValue(value: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ChannelBinding

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ChannelItem(description: Option[String], subscribe: Option[Operation], publish: Option[Operation], parameters: ListMap[String, ReferenceOr[Parameter]], bindings: List[ChannelBinding], extensions: ListMap[String, ExtensionValue])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChannelItem

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Components(schemas: ListMap[String, 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])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Contact(name: Option[String], url: Option[String], email: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class CorrelationId(description: Option[String], location: String, extensions: ListMap[String, ExtensionValue])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HttpChannelBinding() extends ChannelBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HttpMessageBinding(headers: Option[Schema], bindingVersion: Option[String]) extends MessageBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HttpOperationBinding(`type`: String, method: Option[String], query: Option[Schema], bindingVersion: Option[String]) extends OperationBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class HttpServerBinding() extends ServerBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Info(title: String, version: String, description: Option[String], termsOfService: Option[String], contact: Option[Contact], license: Option[License], extensions: ListMap[String, ExtensionValue])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class KafkaChannelBinding() extends ChannelBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class KafkaMessageBinding(key: Option[Schema], bindingVersion: Option[String]) extends MessageBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class KafkaOperationBinding(groupId: Option[Schema], clientId: Option[Schema], bindingVersion: Option[String]) extends OperationBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class KafkaServerBinding() extends ServerBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class License(name: String, url: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Message

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class OneOfMessage
object Message

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Message.type
sealed trait MessageBinding

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class MessageTrait(headers: Option[Schema], correlationId: Option[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])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OneOfMessage(oneOf: List[SingleMessage]) extends Message

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Message
class Object
trait Matchable
class Any
Show all
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])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Operation

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Operation.type
sealed trait OperationBinding

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Parameter(description: Option[String], schema: Option[Schema], location: Option[String], extensions: ListMap[String, ExtensionValue])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Reference($ref: String, summary: Option[String], description: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Reference

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Reference.type
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])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ServerBinding

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ServerVariable(enum: List[String], default: Option[String], description: Option[String], examples: List[String], extensions: ListMap[String, ExtensionValue])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SingleMessage(headers: Option[Schema], payload: Option[Either[AnyValue, Schema]], correlationId: Option[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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Message
class Object
trait Matchable
class Any
Show all
case class WebSocketChannelBinding(method: String, query: Option[Schema], headers: Option[Schema], bindingVersion: Option[String]) extends ChannelBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class WebSocketMessageBinding() extends MessageBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class WebSocketOperationBinding() extends OperationBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class WebSocketServerBinding() extends ServerBinding

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type ReferenceOr[T] = Either[Reference, T]
Generated with