Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
sttp.apispec.asyncapi.AsyncAPI.scala Maven / Gradle / Ivy
package sttp.apispec.asyncapi
import sttp.apispec.{
ExampleValue,
ExtensionValue,
ExternalDocumentation,
Schema,
SecurityRequirement,
SecurityScheme,
Tag
}
import scala.collection.immutable.ListMap
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
) {
def id(id: String): AsyncAPI = copy(id = Some(id))
def servers(s: ListMap[String, Server]): AsyncAPI = copy(servers = s)
def tags(t: List[Tag]): AsyncAPI = copy(tags = t)
}
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
)
case class Contact(
name: Option[String] = None,
url: Option[String] = None,
email: Option[String] = None,
extensions: ListMap[String, ExtensionValue] = ListMap.empty
)
case class License(
name: String,
url: Option[String] = None,
extensions: ListMap[String, ExtensionValue] = ListMap.empty
)
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
)
case class ServerVariable(
`enum`: List[String],
default: Option[String],
description: Option[String],
examples: List[String],
extensions: ListMap[String, ExtensionValue] = ListMap.empty
)
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
)
object ChannelItem {
def empty: ChannelItem =
ChannelItem()
def subscribe(op: Operation): ChannelItem = ChannelItem(subscribe = Some(op))
def publish(op: Operation): ChannelItem = ChannelItem(publish = Some(op))
}
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
)
object Operation {
def empty: Operation = Operation()
def inlineMessage(payload: Message): Operation =
Operation(message = Some(Right(payload)))
}
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
)
case class Parameter(
description: Option[String],
schema: Option[Schema],
location: Option[String],
extensions: ListMap[String, ExtensionValue] = ListMap.empty
)
sealed trait ServerBinding
case class HttpServerBinding() extends ServerBinding
case class WebSocketServerBinding() extends ServerBinding
case class KafkaServerBinding() extends ServerBinding
sealed trait ChannelBinding
case class HttpChannelBinding() extends ChannelBinding
case class WebSocketChannelBinding(
method: String,
query: Option[Schema],
headers: Option[Schema],
bindingVersion: Option[String]
) extends ChannelBinding
case class KafkaChannelBinding() extends ChannelBinding
sealed trait OperationBinding
case class HttpOperationBinding(
`type`: String,
method: Option[String],
query: Option[Schema],
bindingVersion: Option[String]
) extends OperationBinding
case class WebSocketOperationBinding() extends OperationBinding
case class KafkaOperationBinding(groupId: Option[Schema], clientId: Option[Schema], bindingVersion: Option[String])
extends OperationBinding
sealed trait MessageBinding
case class HttpMessageBinding(headers: Option[Schema], bindingVersion: Option[String]) extends MessageBinding
case class WebSocketMessageBinding() extends MessageBinding
case class KafkaMessageBinding(key: Option[Schema], bindingVersion: Option[String]) extends MessageBinding
sealed trait Message
object Message {
def singleInline(payload: String, schemaFormat: Option[String] = None): SingleMessage =
SingleMessage(
payload = Some(Left(AnyValue(payload))),
schemaFormat = schemaFormat
)
}
case class OneOfMessage(oneOf: List[SingleMessage]) extends Message
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
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
)
case class MessageExample(headers: Option[ExampleValue],
payload: Option[ExampleValue],
name: Option[String],
summary: Option[String],
extensions: ListMap[String, ExtensionValue] = ListMap.empty)
// TODO: serverBindings, channelBindings, operationBindings, messageBindings
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
)
case class CorrelationId(
description: Option[String],
location: String,
extensions: ListMap[String, ExtensionValue] = ListMap.empty
)
case class AnyValue(value: String)
case class Reference($ref: String, summary: Option[String] = None, description: Option[String] = None)
object Reference {
def to(prefix: String, $ref: String): Reference = new Reference(s"$prefix${$ref}")
}
