tapir-openapi-model/sttp.tapir.openapi

sttp.tapir.openapi

package sttp.tapir.openapi

Type members

Classlikes

final case class Callback(pathItems: ListMap[String, PathItem], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Callback
Companion:
class
final case class Components(schemas: ListMap[String, ReferenceOr[Schema]], responses: ListMap[String, ReferenceOr[Response]], parameters: ListMap[String, ReferenceOr[Parameter]], examples: ListMap[String, ReferenceOr[Example]], requestBodies: ListMap[String, ReferenceOr[RequestBody]], headers: ListMap[String, ReferenceOr[Header]], securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]], links: ListMap[String, ReferenceOr[Link]], callbacks: ListMap[String, ReferenceOr[Callback]], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Components
Companion:
class
final case class Contact(name: Option[String], email: Option[String], url: Option[String], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Contact
Companion:
class
final case class Encoding(contentType: Option[String], headers: ListMap[String, ReferenceOr[Header]], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Encoding
Companion:
class
final case class Example(summary: Option[String], description: Option[String], value: Option[ExampleValue], externalValue: Option[String], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Example
Companion:
class
final case class Header(description: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType])
Companion:
object
object Header
Companion:
class
final case class Info(title: String, version: String, description: Option[String], termsOfService: Option[String], contact: Option[Contact], license: Option[License], extensions: ListMap[String, ExtensionValue])
final case class License(name: String, url: Option[String], extensions: ListMap[String, ExtensionValue])
final case class Link(operationRef: Option[String], operationId: Option[String], parameters: ListMap[String, String], requestBody: Option[String], description: Option[String], server: Option[Server], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Link
Companion:
class
final case class MediaType(schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], encoding: ListMap[String, Encoding], extensions: ListMap[String, ExtensionValue])
Companion:
object
object MediaType
Companion:
class
final case class OpenAPI(openapi: String, info: Info, tags: List[Tag], servers: List[Server], paths: Paths, components: Option[Components], security: List[SecurityRequirement], extensions: ListMap[String, ExtensionValue])
final case class Operation(tags: List[String], summary: Option[String], description: Option[String], externalDocs: Option[ExternalDocumentation], operationId: Option[String], parameters: List[ReferenceOr[Parameter]], requestBody: Option[ReferenceOr[RequestBody]], responses: Responses, callbacks: ListMap[String, ReferenceOr[Callback]], deprecated: Option[Boolean], security: List[SecurityRequirement], servers: List[Server], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Operation
Companion:
class
final case class Parameter(name: String, in: ParameterIn, description: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType], extensions: ListMap[String, ExtensionValue])
sealed abstract class ParameterIn(val value: String)
Companion:
object
object ParameterIn
Companion:
class
sealed abstract class ParameterStyle(val value: String)
Companion:
object
object ParameterStyle extends Enumeration
Companion:
class
final case class PathItem(ref: Option[Reference], summary: Option[String], description: Option[String], get: Option[Operation], put: Option[Operation], post: Option[Operation], delete: Option[Operation], options: Option[Operation], head: Option[Operation], patch: Option[Operation], trace: Option[Operation], servers: List[Server], parameters: List[ReferenceOr[Parameter]], extensions: ListMap[String, ExtensionValue])
final case class Paths(pathItems: ListMap[String, PathItem], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Paths
Companion:
class
final case class RequestBody(description: Option[String], content: ListMap[String, MediaType], required: Option[Boolean], extensions: ListMap[String, ExtensionValue])
Companion:
object
object RequestBody
Companion:
class
final case class Response(description: String, headers: ListMap[String, ReferenceOr[Header]], content: ListMap[String, MediaType], links: ListMap[String, ReferenceOr[Link]], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Response
Companion:
class
final case class Responses(responses: ListMap[ResponsesKey, ReferenceOr[Response]], extensions: ListMap[String, ExtensionValue])
Companion:
object
object Responses
Companion:
class
final case class ResponsesCodeKey(code: Int) extends ResponsesKey
case object ResponsesDefaultKey extends ResponsesKey
sealed trait ResponsesKey
final case class ResponsesRangeKey(range: Int) extends ResponsesKey
final case class Server(url: String, description: Option[String], variables: Option[ListMap[String, ServerVariable]], extensions: ListMap[String, ExtensionValue])
final case class ServerVariable(enum: Option[List[String]], default: String, description: Option[String], extensions: ListMap[String, ExtensionValue])