p

sttp.tapir

openapi

package openapi

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final case class Components(schemas: ListMap[String, ReferenceOr[Schema]] = ListMap.empty, securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  2. final case class Contact(name: Option[String] = None, email: Option[String] = None, url: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  3. final case class Encoding(contentType: Option[String] = None, headers: ListMap[String, ReferenceOr[Header]] = ListMap.empty, style: Option[ParameterStyle] = None, explode: Option[Boolean] = None, allowReserved: Option[Boolean] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  4. final case class Example(summary: Option[String] = None, description: Option[String] = None, value: Option[ExampleValue] = None, externalValue: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  5. final case class Header(description: Option[String] = None, required: Option[Boolean] = None, deprecated: Option[Boolean] = None, allowEmptyValue: Option[Boolean] = None, style: Option[ParameterStyle] = None, explode: Option[Boolean] = None, allowReserved: Option[Boolean] = None, schema: Option[ReferenceOr[Schema]] = None, example: Option[ExampleValue] = None, examples: ListMap[String, ReferenceOr[Example]] = ListMap.empty, content: ListMap[String, MediaType] = ListMap.empty) extends Product with Serializable
  6. final 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
  7. final case class License(name: String, url: Option[String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  8. final case class MediaType(schema: Option[ReferenceOr[Schema]] = None, example: Option[ExampleValue] = None, examples: ListMap[String, ReferenceOr[Example]] = ListMap.empty, encoding: ListMap[String, Encoding] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  9. final case class OpenAPI(openapi: String = "3.0.3", info: Info, tags: List[Tag] = Nil, servers: List[Server] = Nil, paths: Paths = Paths.Empty, components: Option[Components] = None, security: List[SecurityRequirement] = Nil, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  10. final case class Operation(tags: List[String] = List.empty, summary: Option[String] = None, description: Option[String] = None, operationId: Option[String] = None, parameters: List[ReferenceOr[Parameter]] = List.empty, requestBody: Option[ReferenceOr[RequestBody]] = None, responses: Responses = Responses.Empty, deprecated: Option[Boolean] = None, security: List[SecurityRequirement] = List.empty, servers: List[Server] = List.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  11. final case class Parameter(name: String, in: ParameterIn, description: Option[String] = None, required: Option[Boolean] = None, deprecated: Option[Boolean] = None, allowEmptyValue: Option[Boolean] = None, style: Option[ParameterStyle] = None, explode: Option[Boolean] = None, allowReserved: Option[Boolean] = None, schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue] = None, examples: ListMap[String, ReferenceOr[Example]] = ListMap.empty, content: ListMap[String, MediaType] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  12. sealed abstract class ParameterIn extends AnyRef
  13. sealed abstract class ParameterStyle extends AnyRef
  14. final case class PathItem(summary: Option[String] = None, description: Option[String] = None, get: Option[Operation] = None, put: Option[Operation] = None, post: Option[Operation] = None, delete: Option[Operation] = None, options: Option[Operation] = None, head: Option[Operation] = None, patch: Option[Operation] = None, trace: Option[Operation] = None, servers: List[Server] = List.empty, parameters: List[ReferenceOr[Parameter]] = List.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  15. final case class Paths(pathItems: ListMap[String, PathItem] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  16. final case class RequestBody(description: Option[String] = None, content: ListMap[String, MediaType] = ListMap.empty, required: Option[Boolean] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  17. final case class Response(description: String = "", headers: ListMap[String, ReferenceOr[Header]] = ListMap.empty, content: ListMap[String, MediaType] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  18. final case class Responses(responses: ListMap[ResponsesKey, ReferenceOr[Response]] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  19. final case class ResponsesCodeKey(code: Int) extends ResponsesKey with Product with Serializable
  20. sealed trait ResponsesKey extends AnyRef
  21. final case class Server(url: String, description: Option[String] = None, variables: Option[ListMap[String, ServerVariable]] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  22. final case class ServerVariable(enum: Option[List[String]], default: String, description: Option[String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable

Value Members

  1. object Components extends Serializable
  2. object Contact extends Serializable
  3. object Encoding extends Serializable
  4. object Example extends Serializable
  5. object Header extends Serializable
  6. object MediaType extends Serializable
  7. object Operation extends Serializable
  8. object ParameterIn
  9. object ParameterStyle extends Enumeration
  10. object Paths extends Serializable
  11. object RequestBody extends Serializable
  12. object Response extends Serializable
  13. object Responses extends Serializable
  14. object ResponsesDefaultKey extends ResponsesKey with Product with Serializable

Ungrouped