zio-http
API
Generated with
zio-http/zio.http/zio.http.endpoint/zio.http.endpoint.openapi/JsonSchema

JsonSchema

zio.http.endpoint.openapi.JsonSchema
See theJsonSchema companion trait
object JsonSchema

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
JsonSchema.type

Members list

Type members

Classlikes

final case class AllOfSchema(allOf: Chunk[JsonSchema]) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class AnnotatedSchema(schema: JsonSchema, annotation: MetaData) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object AnyJson extends JsonSchema

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
AnyJson.type
final case class AnyOfSchema(anyOf: Chunk[JsonSchema]) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ArrayType(items: Option[JsonSchema], minItems: Option[Int], uniqueItems: Boolean) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object Boolean extends JsonSchema

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Boolean.type
object ContentEncoding

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ContentEncoding extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object Base16
object Base32
object Base64
object Binary
object EightBit
object SevenBit
Show all
final case class Enum(values: Chunk[EnumValue]) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EnumValue

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EnumValue.type
sealed trait EnumValue

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Bool
object Null
class Num
class SchemaValue
class Str
Self type
final case class Integer(format: IntegerFormat, minimum: Option[Long] = ..., exclusiveMinimum: Option[Either[Boolean, Long]] = ..., maximum: Option[Long] = ..., exclusiveMaximum: Option[Either[Boolean, Long]] = ..., multipleOf: Option[Long] = ...) extends JsonSchema

Attributes

Companion
object
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Integer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Integer.type
object IntegerFormat

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait IntegerFormat extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object Int32
object Int64
object Timestamp
case class JsonSchemaRoot(root: JsonSchema, children: Map[String, JsonSchema])

Represents a complete JSON Schema document, consisting of:

Represents a complete JSON Schema document, consisting of:

Value parameters

children

A map of definition names to their corresponding JsonSchema instances.

root

The top-level JsonSchema for the document.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JsonSchemaRoot

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object MetaData

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
MetaData.type
sealed trait MetaData extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Default
object Deprecated
class Description
class Examples
class KeySchema
class Nullable
Show all
case object Null extends JsonSchema

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Null.type
final case class Number(format: NumberFormat, minimum: Option[Double] = ..., exclusiveMinimum: Option[Either[Boolean, Double]] = ..., maximum: Option[Double] = ..., exclusiveMaximum: Option[Either[Boolean, Double]] = ..., multipleOf: Option[Double] = ...) extends JsonSchema

Attributes

Companion
object
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Number

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Number.type
object NumberFormat

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait NumberFormat extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object Double
object Float
final case class Object(properties: Map[String, JsonSchema], additionalProperties: Either[Boolean, JsonSchema], required: Chunk[String]) extends JsonSchema

Attributes

Companion
object
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Object

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Object.type
final case class OneOfSchema(oneOf: Chunk[JsonSchema]) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Pattern(value: String) extends Product, Serializable

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RefSchema(ref: String) extends JsonSchema

Attributes

Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class SchemaRef(spec: SchemaSpec, style: SchemaStyle)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SchemaSpec

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
SchemaSpec.type
sealed trait SchemaSpec extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object JsonSchema
object OpenAPI
object SchemaStyle

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait SchemaStyle extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object Compact
object Inline
object Reference
final case class String(format: Option[StringFormat], pattern: Option[Pattern], maxLength: Option[Int] = ..., minLength: Option[Int] = ...) extends JsonSchema

Attributes

Companion
object
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object String

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
String.type
object StringFormat

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait StringFormat extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Custom
object Date
object DateTime
object Duration
object Email
object Hostname
object IPv4
object IPv6
object IRI
object IRIReference
object IdnEmail
object IdnHostname
object JSONPointer
object Password
object Regex
object Time
object URI
object URIRef
object URITemplate
object UUID
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def flatten(value: Bool[Predicate[_]], not: Boolean = ...): Chunk[Predicate[_]]
def fromZSchema(schema: Schema[_], refType: SchemaRef): JsonSchema
def fromZSchemaMultiple(schema: Schema[_], refType: SchemaRef, seen: Set[String] = ...): JsonSchemas
def jsonSchema(schema: Schema[_]): JsonSchemaRoot

Builds a JSON Schema document from the given ZIO Schema

Builds a JSON Schema document from the given ZIO Schema

Value parameters

schema

The schema to convert into a JSON Schema document.

Attributes

Returns

A JsonSchemaRoot representing a valid JSON Schema document.

def obj(properties: (String, JsonSchema)*): JsonSchema

Deprecated methods

def fromZSchema(schema: Schema[_], refType: SchemaStyle = ...): JsonSchema

Attributes

Deprecated
[Since version 3.8] use SchemaRef instead of SchemaStyle
def fromZSchemaMulti(schema: Schema[_], refType: SchemaStyle = ..., seen: Set[String] = ...): JsonSchemas

Attributes

Deprecated
[Since version 3.8] use fromZSchemaMultiple

Implicits

Implicits

implicit val schema: Schema[JsonSchema]
Generated with