sttp.apispec.Schema.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of apispec-model_native0.4_2.13 Show documentation
apispec-model
There is a newer version: 0.11.3
Show newest version
package sttp.apispec

import scala.collection.immutable.ListMap

/** Algebraic data type for all possible schemas
  */
sealed trait SchemaLike

sealed trait AnySchema extends SchemaLike

object AnySchema {
  sealed trait Encoding extends Product with Serializable
  object Encoding {
    case object Object extends Encoding
    case object Boolean extends Encoding
  }

  /** Json schema can be represented by the values `true` or `{}` (empty object). This represents any json value. */
  case object Anything extends AnySchema

  /** Json schema can be represented by the values `false` or `{"not": {}}` (object with a single property "not" which
    * has a single value with must be the empty object". This represents no json value.
    */
  case object Nothing extends AnySchema
}

// todo: xml
case class Schema(
    $ref: Option[String] = None,
    $schema: Option[String] = None,
    allOf: List[SchemaLike] = List.empty,
    title: Option[String] = None,
    required: List[String] = List.empty,
    `type`: Option[SchemaType] = None,
    prefixItems: Option[List[SchemaLike]] = None,
    items: Option[SchemaLike] = None,
    uniqueItems: Option[Boolean] = None,
    contains: Option[SchemaLike] = None,
    properties: ListMap[String, SchemaLike] = ListMap.empty,
    patternProperties: ListMap[Pattern, 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[SchemaLike] = List.empty,
    discriminator: Option[Discriminator] = None,
    additionalProperties: Option[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[SchemaLike] = None,
    `if`: Option[SchemaLike] = None,
    `then`: Option[SchemaLike] = None,
    `else`: Option[SchemaLike] = None,
    $defs: Option[ListMap[String, SchemaLike]] = None,
    extensions: ListMap[String, ExtensionValue] = ListMap.empty,
    $id: Option[String] = None,
    const: Option[ExampleValue] = None,
    anyOf: List[SchemaLike] = List.empty,
    unevaluatedProperties: Option[SchemaLike] = None,
    dependentRequired: ListMap[String, List[String]] = ListMap.empty,
    dependentSchemas: ListMap[String, SchemaLike] = ListMap.empty
) extends SchemaLike

case class Discriminator(propertyName: String, mapping: Option[ListMap[String, String]])

object Schema {
  def apply(schemaType: SchemaType): Schema = new Schema(`type` = Some(schemaType))

  def oneOf(references: List[SchemaLike], discriminator: Option[Discriminator]): Schema =
    Schema(oneOf = references, discriminator = discriminator)

  def referenceTo(prefix: String, $ref: String): Schema = Schema($ref = Some(s"$prefix${$ref}"))
}

sealed trait SchemaType
case class ArraySchemaType(value: List[BasicSchemaType]) extends SchemaType
sealed abstract class BasicSchemaType(val value: String) extends SchemaType

object SchemaType {
  case object Boolean extends BasicSchemaType("boolean")
  case object Object extends BasicSchemaType("object")
  case object Array extends BasicSchemaType("array")
  case object Number extends BasicSchemaType("number")
  case object String extends BasicSchemaType("string")
  case object Integer extends BasicSchemaType("integer")
  case object Null extends BasicSchemaType("null")
}

object SchemaFormat {
  val Int32: Option[String] = Some("int32")
  val Int64: Option[String] = Some("int64")
  val Float: Option[String] = Some("float")
  val Double: Option[String] = Some("double")
  val Byte: Option[String] = Some("byte")
  val Binary: Option[String] = Some("binary")
  val Date: Option[String] = Some("date")
  val DateTime: Option[String] = Some("date-time")
  val Password: Option[String] = Some("password")
}