package openapi
Ordering
- Alphabetic
Visibility
- Public
- All
Type Members
- 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
- 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
- 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
- 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
- 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
- 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
- final case class License(name: String, url: Option[String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- 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
- 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
- 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
- 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
- sealed abstract class ParameterIn extends AnyRef
- sealed abstract class ParameterStyle extends AnyRef
- 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
- final case class Paths(pathItems: ListMap[String, PathItem] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- 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
- 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
- final case class Responses(responses: ListMap[ResponsesKey, ReferenceOr[Response]] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- final case class ResponsesCodeKey(code: Int) extends ResponsesKey with Product with Serializable
- sealed trait ResponsesKey extends AnyRef
- 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
- 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
- object Components extends Serializable
- object Contact extends Serializable
- object Encoding extends Serializable
- object Example extends Serializable
- object Header extends Serializable
- object MediaType extends Serializable
- object Operation extends Serializable
- object ParameterIn
- object ParameterStyle extends Enumeration
- object Paths extends Serializable
- object RequestBody extends Serializable
- object Response extends Serializable
- object Responses extends Serializable
- object ResponsesDefaultKey extends ResponsesKey with Product with Serializable