package openapi
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- openapi
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- case class Components(schemas: ListMap[String, ReferenceOr[Schema]], securitySchemes: ListMap[String, ReferenceOr[SecurityScheme]]) extends Product with Serializable
- case class Contact(name: Option[String], email: Option[String], url: Option[String]) extends Product with Serializable
- case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]]) extends Product with Serializable
- case class Encoding(contentType: Option[String], headers: ListMap[String, ReferenceOr[Header]], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean]) extends Product with Serializable
- case class Example(summary: Option[String], description: Option[String], value: Option[ExampleValue], externalValue: Option[String]) extends Product with Serializable
- case class ExampleMultipleValue(values: List[String]) extends ExampleValue with Product with Serializable
- case class ExampleSingleValue(value: String) extends ExampleValue with Product with Serializable
- sealed trait ExampleValue extends AnyRef
- case class ExternalDocumentation(url: String, description: Option[String] = None) extends Product with Serializable
- 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]) extends Product with Serializable
- case class Info(title: String, version: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[Contact] = None, license: Option[License] = None) extends Product with Serializable
- implicit class IterableToListMap[A] extends AnyRef
- case class License(name: String, url: Option[String]) extends Product with Serializable
- case class MediaType(schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], encoding: ListMap[String, Encoding]) extends Product with Serializable
- case class OAuthFlow(authorizationUrl: String, tokenUrl: String, refreshUrl: Option[String], scopes: ListMap[String, String]) extends Product with Serializable
- case class OAuthFlows(implicit: Option[OAuthFlow] = None, password: Option[OAuthFlow] = None, clientCredentials: Option[OAuthFlow] = None, authorizationCode: Option[OAuthFlow] = None) extends Product with Serializable
- case class OpenAPI(openapi: String = "3.0.1", info: Info, tags: List[Tag], servers: List[Server], paths: ListMap[String, PathItem], components: Option[Components], security: List[SecurityRequirement]) extends Product with Serializable
- case class Operation(tags: List[String], summary: Option[String], description: Option[String], operationId: String, parameters: List[ReferenceOr[Parameter]], requestBody: Option[ReferenceOr[RequestBody]], responses: ListMap[ResponsesKey, ReferenceOr[Response]], deprecated: Option[Boolean], security: List[SecurityRequirement], servers: List[Server]) extends Product with Serializable
- 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: ReferenceOr[Schema], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType]) extends Product with Serializable
- case class PathItem(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]]) extends Product with Serializable
- case class Reference extends Product with Serializable
- case class RequestBody(description: Option[String], content: ListMap[String, MediaType], required: Option[Boolean]) extends Product with Serializable
- case class Response(description: String, headers: ListMap[String, ReferenceOr[Header]], content: ListMap[String, MediaType]) extends Product with Serializable
- case class ResponsesCodeKey(code: Int) extends ResponsesKey with Product with Serializable
- sealed trait ResponsesKey extends AnyRef
- case class Schema(allOf: List[ReferenceOr[Schema]] = List.empty, title: Option[String] = None, required: List[String] = List.empty, type: Option[SchemaType] = None, items: Option[ReferenceOr[Schema]] = None, properties: ListMap[String, ReferenceOr[Schema]] = ListMap.empty, description: Option[String] = None, format: Option[String] = None, default: Option[ExampleValue] = None, nullable: Option[Boolean] = None, readOnly: Option[Boolean] = None, writeOnly: Option[Boolean] = None, example: Option[ExampleValue] = None, deprecated: Option[Boolean] = None, oneOf: List[ReferenceOr[Schema]] = List.empty, discriminator: Option[Discriminator] = None, additionalProperties: Option[ReferenceOr[Schema]] = None, pattern: Option[String] = None, minLength: Option[Int] = None, maxLength: Option[Int] = None, minimum: Option[BigDecimal] = None, exclusiveMinimum: Option[BigDecimal] = None, maximum: Option[BigDecimal] = None, exclusiveMaximum: Option[BigDecimal] = None, minItems: Option[Int] = None, maxItems: Option[Int] = None, enum: Option[List[String]] = None) extends Product with Serializable
- 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]) extends Product with Serializable
- case class Server(url: String, description: Option[String]) extends Product with Serializable
- case class Tag(name: String, description: Option[String] = None, externalDocs: Option[ExternalDocumentation] = None) extends Product with Serializable
Value Members
- object OpenAPI extends Serializable
- object ParameterIn extends Enumeration
- object ParameterStyle extends Enumeration
- object Reference extends Serializable
- object ResponsesDefaultKey extends ResponsesKey with Product with Serializable
- object Schema extends Serializable
- object SchemaFormat
- object SchemaType extends Enumeration