package apispec
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- apispec
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Package Members
- package validation
Type Members
- sealed trait AnySchema extends SchemaLike
- case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]]) extends Product with Serializable
- case class ExampleMultipleValue(values: List[Any]) extends ExampleValue with Product with Serializable
- case class ExampleSingleValue(value: Any) extends ExampleValue with Product with Serializable
- sealed trait ExampleValue extends AnyRef
- case class ExtensionValue(value: String) extends Product with Serializable
- case class ExternalDocumentation(url: String, description: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- case class OAuthFlow(authorizationUrl: Option[String] = None, tokenUrl: Option[String] = None, refreshUrl: Option[String] = None, scopes: ListMap[String, String] = ListMap.empty, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- case class OAuthFlows(implicit: Option[OAuthFlow] = None, password: Option[OAuthFlow] = None, clientCredentials: Option[OAuthFlow] = None, authorizationCode: Option[OAuthFlow] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- final case class Pattern(value: String) extends Product with Serializable
- See also
https://json-schema.org/understanding-json-schema/reference/regular_expressions.html
- case class Schema($schema: Option[String] = None, $vocabulary: Option[ListMap[String, Boolean]] = None, $id: Option[String] = None, $anchor: Option[String] = None, $dynamicAnchor: Option[String] = None, $ref: Option[String] = None, $dynamicRef: Option[String] = None, $comment: Option[String] = None, $defs: Option[ListMap[String, SchemaLike]] = None, title: Option[String] = None, description: Option[String] = None, default: Option[ExampleValue] = None, deprecated: Option[Boolean] = None, readOnly: Option[Boolean] = None, writeOnly: Option[Boolean] = None, examples: Option[List[ExampleValue]] = None, type: Option[List[SchemaType]] = None, enum: Option[List[ExampleValue]] = None, const: Option[ExampleValue] = None, format: Option[String] = None, allOf: List[SchemaLike] = List.empty, anyOf: List[SchemaLike] = List.empty, oneOf: List[SchemaLike] = List.empty, not: Option[SchemaLike] = None, if: Option[SchemaLike] = None, then: Option[SchemaLike] = None, else: Option[SchemaLike] = None, dependentSchemas: ListMap[String, SchemaLike] = ListMap.empty, multipleOf: Option[BigDecimal] = None, minimum: Option[BigDecimal] = None, exclusiveMinimum: Option[BigDecimal] = None, maximum: Option[BigDecimal] = None, exclusiveMaximum: Option[BigDecimal] = None, maxLength: Option[Int] = None, minLength: Option[Int] = None, pattern: Option[Pattern] = None, maxItems: Option[Int] = None, minItems: Option[Int] = None, uniqueItems: Option[Boolean] = None, maxContains: Option[Int] = None, minContains: Option[Int] = None, prefixItems: Option[List[SchemaLike]] = None, items: Option[SchemaLike] = None, contains: Option[SchemaLike] = None, unevaluatedItems: Option[SchemaLike] = None, maxProperties: Option[Int] = None, minProperties: Option[Int] = None, required: List[String] = List.empty, dependentRequired: ListMap[String, List[String]] = ListMap.empty, discriminator: Option[Discriminator] = None, properties: ListMap[String, SchemaLike] = ListMap.empty, patternProperties: ListMap[Pattern, SchemaLike] = ListMap.empty, additionalProperties: Option[SchemaLike] = None, propertyNames: Option[SchemaLike] = None, unevaluatedProperties: Option[SchemaLike] = None, externalDocs: Option[ExternalDocumentation] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends SchemaLike with Product with Serializable
- sealed trait SchemaLike extends AnyRef
Algebraic data type for all possible schemas
- sealed abstract class SchemaType extends AnyRef
- type SecurityRequirement = ListMap[String, Vector[String]]
- case class SecurityScheme(type: String, description: Option[String] = None, name: Option[String] = None, in: Option[String] = None, scheme: Option[String] = None, bearerFormat: Option[String] = None, flows: Option[OAuthFlows] = None, openIdConnectUrl: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
- case class Tag(name: String, description: Option[String] = None, externalDocs: Option[ExternalDocumentation] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
Value Members
- object AnySchema
- object Schema extends Serializable
- object SchemaFormat
- object SchemaType