SchemaStyle

zio.http.endpoint.openapi.JsonSchema.SchemaStyle
See theSchemaStyle companion trait
object SchemaStyle

Attributes

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

Members list

Type members

Classlikes

case object Compact extends SchemaStyle

Generates references to json schemas under #/components/schemas/{schema} and uses the type name to help to generate schema names.

Generates references to json schemas under #/components/schemas/{schema} and uses the type name to help to generate schema names.

Attributes

See also

SchemaStyle.Reference for full package path schema names to avoid name collisions.

Supertypes
trait Singleton
trait Product
trait Mirror
trait SchemaStyle
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Compact.type
case object Inline extends SchemaStyle

Generates inline json schema

Generates inline json schema

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait SchemaStyle
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Inline.type
case object Reference extends SchemaStyle

Generates references to json schemas under #/components/schemas/{schema} and uses the full package path to help to generate unique schema names.

Generates references to json schemas under #/components/schemas/{schema} and uses the full package path to help to generate unique schema names.

Attributes

See also

SchemaStyle.Compact for compact schema names.

Supertypes
trait Singleton
trait Product
trait Mirror
trait SchemaStyle
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Reference.type

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