p

sttp

apispec

package apispec

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. apispec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait AnySchema extends SchemaLike
  2. case class ArraySchemaType(value: List[BasicSchemaType]) extends SchemaType with Product with Serializable
  3. sealed abstract class BasicSchemaType extends SchemaType
  4. case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]]) extends Product with Serializable
  5. case class ExampleMultipleValue(values: List[Any]) extends ExampleValue with Product with Serializable
  6. case class ExampleSingleValue(value: Any) extends ExampleValue with Product with Serializable
  7. sealed trait ExampleValue extends AnyRef
  8. case class ExtensionValue(value: String) extends Product with Serializable
  9. case class ExternalDocumentation(url: String, description: Option[String] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  10. case class OAuthFlow(authorizationUrl: Option[String], tokenUrl: Option[String], refreshUrl: Option[String], scopes: ListMap[String, String], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  11. 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
  12. final case class Pattern(value: String) extends Product with Serializable

    See also

    https://json-schema.org/understanding-json-schema/reference/regular_expressions.html

  13. case class Reference($ref: String, summary: Option[String] = None, description: Option[String] = None) extends Product with Serializable
  14. type ReferenceOr[T] = Either[Reference, T]
  15. case class Schema($schema: Option[String] = None, allOf: List[ReferenceOr[SchemaLike]] = List.empty, title: Option[String] = None, required: List[String] = List.empty, type: Option[SchemaType] = None, prefixItems: Option[List[ReferenceOr[SchemaLike]]] = None, items: Option[ReferenceOr[SchemaLike]] = None, contains: Option[ReferenceOr[SchemaLike]] = None, properties: ListMap[String, ReferenceOr[SchemaLike]] = ListMap.empty, patternProperties: ListMap[Pattern, ReferenceOr[SchemaLike]] = 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[SchemaLike]] = List.empty, discriminator: Option[Discriminator] = None, additionalProperties: Option[ReferenceOr[SchemaLike]] = None, pattern: Option[Pattern] = None, minLength: Option[Int] = None, maxLength: Option[Int] = None, minimum: Option[BigDecimal] = None, exclusiveMinimum: Option[Boolean] = None, maximum: Option[BigDecimal] = None, exclusiveMaximum: Option[Boolean] = None, minItems: Option[Int] = None, maxItems: Option[Int] = None, enum: Option[List[ExampleSingleValue]] = None, not: Option[ReferenceOr[SchemaLike]] = None, if: Option[ReferenceOr[SchemaLike]] = None, then: Option[ReferenceOr[SchemaLike]] = None, else: Option[ReferenceOr[SchemaLike]] = None, $defs: Option[ListMap[String, SchemaLike]] = None, extensions: ListMap[String, ExtensionValue] = ListMap.empty, $id: Option[String] = None, const: Option[ExampleValue] = None, anyOf: List[ReferenceOr[SchemaLike]] = List.empty, unevaluatedProperties: Option[ReferenceOr[SchemaLike]] = None, dependentRequired: ListMap[String, List[String]] = ListMap.empty, dependentSchemas: ListMap[String, ReferenceOr[SchemaLike]] = ListMap.empty) extends SchemaLike with Product with Serializable
  16. sealed trait SchemaLike extends AnyRef

    Algebraic data type for all possible schemas

  17. sealed trait SchemaType extends AnyRef
  18. type SecurityRequirement = ListMap[String, Vector[String]]
  19. 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], extensions: ListMap[String, ExtensionValue] = ListMap.empty) extends Product with Serializable
  20. 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

  1. object AnySchema
  2. object Reference extends Serializable
  3. object Schema extends Serializable
  4. object SchemaFormat
  5. object SchemaType

Inherited from AnyRef

Inherited from Any

Ungrouped