docs
API
Generated with
docs/zio.http/zio.http.endpoint/zio.http.endpoint.openapi/OpenAPI/Schema

Schema

zio.http.endpoint.openapi.OpenAPI$.Schema$
See theSchema companion trait
object Schema

Attributes

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

Members list

Type members

Classlikes

final case class RequestSchema(nullable: Boolean, discriminator: Option[Discriminator], xml: Option[XML], externalDocs: URI, example: String, deprecated: Boolean) extends Schema, Definition

The Schema Object allows the definition of input and output data types.

The Schema Object allows the definition of input and output data types.

Marked as writeOnly. This means that it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is in the required list, the required will take effect on the request only.

Value parameters

deprecated

Specifies that a schema is deprecated and SHOULD be transitioned out of usage.

discriminator

Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.

example

A free-form property to include an example of an instance for this schema.

externalDocs

Additional external documentation for this schema.

nullable

A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified.

xml

This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait Schema
class Object
trait Matchable
class Any
Show all
final case class ResponseSchema(nullable: Boolean, discriminator: Option[Discriminator], xml: Option[XML], externalDocs: URI, example: String, deprecated: Boolean) extends Schema, Definition

The Schema Object allows the definition of input and output data types.

The Schema Object allows the definition of input and output data types.

Marked as readOnly. This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is in the required list, the required will take effect on the response only.

Value parameters

deprecated

Specifies that a schema is deprecated and SHOULD be transitioned out of usage.

discriminator

Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.

example

A free-form property to include an example of an instance for this schema.

externalDocs

Additional external documentation for this schema.

nullable

A true value adds "null" to the allowed type specified by the type keyword, only if type is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of null as a value. A false value leaves the specified or default type unmodified.

xml

This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait Schema
class Object
trait Matchable
class Any
Show all

Inherited 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
Generated with