package openapi
Ordering
- Alphabetic
Visibility
- Public
- Protected
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 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 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
- 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 OpenAPI(openapi: String = "3.0.3", 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 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 Server(url: String, description: Option[String] = None, variables: Option[ListMap[String, ServerVariable]] = None) extends Product with Serializable
- case class ServerVariable(enum: Option[List[String]], default: String, description: Option[String]) extends Product with Serializable
Value Members
- object ParameterIn extends Enumeration
- object ParameterStyle extends Enumeration
- case object ResponsesDefaultKey extends ResponsesKey with Product with Serializable