Trait

endpoints.openapi.model

OpenApiSchemas

Related Doc: package model

Permalink

trait OpenApiSchemas extends algebra.JsonSchemas

Provides an implicit instance of JsonSchema[OpenApi] which can be interpreted by a proper JSON encoder (e.g., endpoints-json-schema-playjson) to produce a JSON document out of an OpenApi value.

Source
OpenApiSchemas.scala
Linear Supertypes
algebra.JsonSchemas, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpenApiSchemas
  2. JsonSchemas
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class DiscriminatorFields(propertyName: String, mapping: Map[String, String]) extends Product with Serializable

    Permalink

  2. abstract type Enum[A] <: JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas

  3. abstract type JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas

  4. implicit final class JsonSchemaOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  5. abstract type Record[A] <: JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas

  6. implicit final class RecordOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  7. case class SchemaFields(type: Option[String] = None, format: Option[String] = None, items: Option[Schema] = None, properties: Option[Map[String, Schema]] = None, additionalProperties: Option[Schema] = None, required: Option[Set[String]] = None, oneOf: Option[List[Schema]] = None, discriminator: Option[DiscriminatorFields] = None, allOf: Option[List[Schema]] = None, enum: Option[List[String]] = None, ref: Option[String] = None, description: Option[String] = None) extends Product with Serializable

    Permalink

  8. abstract type Tagged[A] <: JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas

  9. implicit final class TaggedOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

Abstract Value Members

  1. implicit abstract def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], factory: scala.collection.compat.Factory[A, C[A]]): JsonSchema[C[A]]

    Permalink
    Definition Classes
    JsonSchemas

  2. implicit abstract def bigdecimalJsonSchema: JsonSchema[BigDecimal]

    Permalink
    Definition Classes
    JsonSchemas

  3. implicit abstract def booleanJsonSchema: JsonSchema[Boolean]

    Permalink
    Definition Classes
    JsonSchemas

  4. implicit abstract def byteJsonSchema: JsonSchema[Byte]

    Permalink
    Definition Classes
    JsonSchemas

  5. abstract def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]

    Permalink
    Definition Classes
    JsonSchemas

  6. implicit abstract def doubleJsonSchema: JsonSchema[Double]

    Permalink
    Definition Classes
    JsonSchemas

  7. abstract def emptyRecord: Record[Unit]

    Permalink
    Definition Classes
    JsonSchemas

  8. abstract def enumeration[A](values: Seq[A])(encode: (A) ⇒ String)(implicit tpe: JsonSchema[String]): Enum[A]

    Permalink
    Definition Classes
    JsonSchemas

  9. abstract def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]

    Permalink
    Definition Classes
    JsonSchemas

  10. implicit abstract def floatJsonSchema: JsonSchema[Float]

    Permalink
    Definition Classes
    JsonSchemas

  11. implicit abstract def intJsonSchema: JsonSchema[Int]

    Permalink
    Definition Classes
    JsonSchemas

  12. abstract def lazySchema[A](schema: ⇒ JsonSchema[A], name: String): JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas

  13. implicit abstract def longJsonSchema: JsonSchema[Long]

    Permalink
    Definition Classes
    JsonSchemas

  14. implicit abstract def mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]

    Permalink
    Definition Classes
    JsonSchemas

  15. abstract def named[A, S[T] <: JsonSchema[T]](schema: S[A], name: String): S[A]

    Permalink
    Definition Classes
    JsonSchemas

  16. abstract def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]

    Permalink
    Definition Classes
    JsonSchemas

  17. implicit abstract def stringJsonSchema: JsonSchema[String]

    Permalink
    Definition Classes
    JsonSchemas

  18. abstract def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]

    Permalink
    Definition Classes
    JsonSchemas

  19. implicit abstract def uuidJsonSchema: JsonSchema[UUID]

    Permalink
    Definition Classes
    JsonSchemas

  20. abstract def withDiscriminator[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]

    Permalink
    Definition Classes
    JsonSchemas

  21. abstract def xmapJsonSchema[A, B](jsonSchema: JsonSchema[A], f: (A) ⇒ B, g: (B) ⇒ A): JsonSchema[B]

    Permalink
    Definition Classes
    JsonSchemas

  22. abstract def xmapRecord[A, B](record: Record[A], f: (A) ⇒ B, g: (B) ⇒ A): Record[B]

    Permalink
    Definition Classes
    JsonSchemas

  23. abstract def xmapTagged[A, B](taggedA: Tagged[A], f: (A) ⇒ B, g: (B) ⇒ A): Tagged[B]

    Permalink
    Definition Classes
    JsonSchemas

  24. abstract def zipRecords[A, B](recordA: Record[A], recordB: Record[B]): Record[(A, B)]

    Permalink
    Definition Classes
    JsonSchemas

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. implicit lazy val componentsSchema: JsonSchema[Components]

    Permalink

  7. def defaultDiscriminatorName: String

    Permalink
    Definition Classes
    JsonSchemas

  8. implicit lazy val discriminatorSchema: JsonSchema[DiscriminatorFields]

    Permalink

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. implicit lazy val inSchema: JsonSchema[In]

    Permalink

  15. implicit lazy val infoSchema: JsonSchema[Info]

    Permalink

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. implicit lazy val mediaTypeSchema: JsonSchema[MediaType]

    Permalink

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. implicit lazy val openApiSchema: JsonSchema[OpenApi]

    Permalink

  22. val openapiVersion: String

    Permalink

  23. implicit lazy val operationSchema: JsonSchema[Operation]

    Permalink

  24. implicit lazy val parameterSchema: JsonSchema[Parameter]

    Permalink

  25. implicit lazy val pathItemSchema: JsonSchema[PathItem]

    Permalink

  26. implicit lazy val requestBodySchema: JsonSchema[RequestBody]

    Permalink

  27. implicit lazy val responseSchema: JsonSchema[Response]

    Permalink

  28. implicit lazy val schemaSchema: JsonSchema[Schema]

    Permalink

  29. implicit lazy val securityRequirementSchema: JsonSchema[SecurityRequirement]

    Permalink

  30. implicit lazy val securitySchemeSchema: JsonSchema[SecurityScheme]

    Permalink

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from algebra.JsonSchemas

Inherited from AnyRef

Inherited from Any

Ungrouped