p

sttp.apispec

asyncapi

package asyncapi

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. asyncapi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class AnyValue(value: String) extends Product with Serializable
  2. case class AsyncAPI(asyncapi: String = "2.6.0", id: Option[String] = None, info: Info, servers: ListMap[String, Server] = ListMap.empty, channels: ListMap[String, ReferenceOr[ChannelItem]] = ListMap.empty, components: Option[Components] = None, tags: List[Tag] = Nil, externalDocs: Option[ExternalDocumentation] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  3. sealed trait ChannelBinding extends AnyRef
  4. case class ChannelItem(description: Option[String] = None, subscribe: Option[Operation] = None, publish: Option[Operation] = None, parameters: ListMap[String, ReferenceOr[Parameter]] = ListMap.empty, bindings: List[ChannelBinding] = Nil, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  5. case class Components(schemas: ListMap[String, Schema] = ListMap.empty, messages: ListMap[String, ReferenceOr[Message]] = ListMap.empty, securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]] = ListMap.empty, parameters: ListMap[String, ReferenceOr[Parameter]] = ListMap.empty, correlationIds: ListMap[String, ReferenceOr[CorrelationId]] = ListMap.empty, operationTraits: ListMap[String, ReferenceOr[OperationTrait]] = ListMap.empty, messageTraits: ListMap[String, ReferenceOr[MessageTrait]] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  6. case class Contact(name: Option[String] = None, url: Option[String] = None, email: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  7. case class CorrelationId(description: Option[String], location: String, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  8. case class HttpChannelBinding() extends ChannelBinding with Product with Serializable
  9. case class HttpMessageBinding(headers: Option[Schema], bindingVersion: Option[String]) extends MessageBinding with Product with Serializable
  10. case class HttpOperationBinding(type: String, method: Option[String], query: Option[Schema], bindingVersion: Option[String]) extends OperationBinding with Product with Serializable
  11. case class HttpServerBinding() extends ServerBinding with Product with Serializable
  12. case class Info(title: String, version: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[Contact] = None, license: Option[License] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  13. case class KafkaChannelBinding() extends ChannelBinding with Product with Serializable
  14. case class KafkaMessageBinding(key: Option[Schema], bindingVersion: Option[String]) extends MessageBinding with Product with Serializable
  15. case class KafkaOperationBinding(groupId: Option[Schema], clientId: Option[Schema], bindingVersion: Option[String]) extends OperationBinding with Product with Serializable
  16. case class KafkaServerBinding() extends ServerBinding with Product with Serializable
  17. case class License(name: String, url: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  18. sealed trait Message extends AnyRef
  19. sealed trait MessageBinding extends AnyRef
  20. case class MessageExample(headers: Option[ExampleValue], payload: Option[ExampleValue], name: Option[String], summary: Option[String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  21. case class MessageTrait(headers: Option[Schema] = None, correlationId: Option[Schema] = None, schemaFormat: Option[String] = None, contentType: Option[String] = None, name: Option[String] = None, title: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: List[Tag] = Nil, externalDocs: Option[ExternalDocumentation] = None, bindings: List[MessageBinding] = Nil, examples: List[MessageExample] = Nil, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  22. case class OneOfMessage(oneOf: List[SingleMessage]) extends Message with Product with Serializable
  23. case class Operation(operationId: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: List[Tag] = Nil, externalDocs: Option[ExternalDocumentation] = None, bindings: List[OperationBinding] = Nil, traits: List[OperationTrait] = Nil, message: Option[ReferenceOr[Message]] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  24. sealed trait OperationBinding extends AnyRef
  25. 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] = ListMap.empty) extends Product with Serializable
  26. case class Parameter(description: Option[String], schema: Option[Schema], location: Option[String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  27. case class Reference($ref: String, summary: Option[String] = None, description: Option[String] = None) extends Product with Serializable
  28. type ReferenceOr[T] = Either[Reference, T]
  29. 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, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  30. sealed trait ServerBinding extends AnyRef
  31. case class ServerVariable(enum: List[String], default: Option[String], description: Option[String], examples: List[String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  32. case class SingleMessage(headers: Option[Schema] = None, payload: Option[Either[AnyValue, Schema]] = None, correlationId: Option[Schema] = None, schemaFormat: Option[String] = None, contentType: Option[String] = None, name: Option[String] = None, title: Option[String] = None, summary: Option[String] = None, description: Option[String] = None, tags: List[Tag] = Nil, externalDocs: Option[ExternalDocumentation] = None, bindings: List[MessageBinding] = Nil, examples: List[MessageExample] = Nil, traits: List[ReferenceOr[MessageTrait]] = Nil, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Message with Product with Serializable
  33. case class WebSocketChannelBinding(method: String, query: Option[Schema], headers: Option[Schema], bindingVersion: Option[String]) extends ChannelBinding with Product with Serializable
  34. case class WebSocketMessageBinding() extends MessageBinding with Product with Serializable
  35. case class WebSocketOperationBinding() extends OperationBinding with Product with Serializable
  36. case class WebSocketServerBinding() extends ServerBinding with Product with Serializable

Value Members

  1. object ChannelItem extends Serializable
  2. object Message
  3. object Operation extends Serializable
  4. object Reference extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped