sttp.tapir.apispec

Type members

Classlikes

case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]])
case class ExampleMultipleValue(values: List[Any]) extends ExampleValue
case class ExampleSingleValue(value: Any) extends ExampleValue
sealed trait ExampleValue
case class ExtensionValue(value: String)
case class ExternalDocumentation(url: String, description: Option[String], extensions: ListMap[String, ExtensionValue])
case class OAuthFlow(authorizationUrl: Option[String], tokenUrl: Option[String], refreshUrl: Option[String], scopes: ListMap[String, String], extensions: ListMap[String, ExtensionValue])
case class OAuthFlows(`implicit`: Option[OAuthFlow], password: Option[OAuthFlow], clientCredentials: Option[OAuthFlow], authorizationCode: Option[OAuthFlow], extensions: ListMap[String, ExtensionValue])
case class Reference($ref: String)
Companion:
object
object Reference
Companion:
class
case class Schema(allOf: List[ReferenceOr[Schema]], title: Option[String], required: List[String], `type`: Option[SchemaType], items: Option[ReferenceOr[Schema]], properties: ListMap[String, ReferenceOr[Schema]], description: Option[String], format: Option[String], default: Option[ExampleValue], nullable: Option[Boolean], readOnly: Option[Boolean], writeOnly: Option[Boolean], example: Option[ExampleValue], deprecated: Option[Boolean], oneOf: List[ReferenceOr[Schema]], discriminator: Option[Discriminator], additionalProperties: Option[ReferenceOr[Schema]], pattern: Option[String], minLength: Option[Int], maxLength: Option[Int], minimum: Option[BigDecimal], exclusiveMinimum: Option[Boolean], maximum: Option[BigDecimal], exclusiveMaximum: Option[Boolean], minItems: Option[Int], maxItems: Option[Int], enum: Option[List[ExampleSingleValue]], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Schema
Companion:
class
sealed abstract class SchemaType(val value: String)
Companion:
object
object SchemaType
Companion:
class
case class SecurityScheme(`type`: String, description: Option[String], name: Option[String], in: Option[String], scheme: Option[String], bearerFormat: Option[String], flows: Option[OAuthFlows], openIdConnectUrl: Option[String], extensions: ListMap[String, ExtensionValue])
case class Tag(name: String, description: Option[String], externalDocs: Option[ExternalDocumentation], extensions: ListMap[String, ExtensionValue])

Types

type ReferenceOr[T] = Either[Reference, T]
type SecurityRequirement = ListMap[String, Vector[String]]