Object

zio.http.endpoint.openapi.JsonSchema.Object
See theObject companion object
final case class Object(properties: Map[String, JsonSchema], additionalProperties: Either[Boolean, JsonSchema], required: Chunk[String]) extends JsonSchema

Attributes

Companion
object
Source
JsonSchema.scala
Graph
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAll(value: Chunk[(String, JsonSchema)]): Object

Attributes

Source
JsonSchema.scala
def isClosedDictionary: Boolean

This Object represents a "closed dictionary", aka a case class

This Object represents a "closed dictionary", aka a case class

See: https://github.com/zio/zio-http/issues/3048#issuecomment-2306291192

Attributes

Source
JsonSchema.scala
def isInvalid: Boolean

Can't represent a case class and a Map at the same time

Can't represent a case class and a Map at the same time

Attributes

Source
JsonSchema.scala
def isOpenDictionary: Boolean

This Object represents an "open dictionary", aka a Map

This Object represents an "open dictionary", aka a Map

See: https://github.com/zio/zio-http/issues/3048#issuecomment-2306291192

Attributes

Source
JsonSchema.scala
def required(required: Chunk[String]): Object

Attributes

Source
JsonSchema.scala

Inherited methods

def annotate(annotation: MetaData): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def annotate(annotations: Chunk[MetaData]): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def annotations: Chunk[MetaData]

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def contentEncoding(encoding: ContentEncoding): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def contentMediaType(mediaType: String): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def default(default: Json): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def default(default: Option[Json]): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def deprecated(deprecated: Boolean): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def description: Option[String]

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def description(description: Option[String]): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def description(description: String): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def discriminator(discriminator: Option[Discriminator]): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def discriminator(discriminator: Discriminator): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def examples(examples: Chunk[Json]): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def isCollection: Boolean

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
final def isNullable: Boolean

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def isPrimitive: Boolean

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def nullable(nullable: Boolean): JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def toJson: String

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def toJsonBytes: Chunk[Byte]

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def withoutAnnotations: JsonSchema

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala