implicit final class JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
Implicit methods for values of type JsonSchema
- Source
- JsonSchemas.scala
- Alphabetic
- By Inheritance
- JsonSchemaOps
- JsonSchemaDocumentationOps
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new JsonSchemaOps(schemaA: JsonSchema[A])
Type Members
- type Self = JsonSchema[A]
- Definition Classes
- JsonSchemaOps → JsonSchemaDocumentationOps
Value Members
- def orFallbackTo[B](schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]
A schema that can be either
schemaA
orschemaB
.A schema that can be either
schemaA
orschemaB
.- Encoder interpreters forward to
schemaA
to encode aLeft
value orschemaB
to encode aRight
value, - Decoder interpreters first try to decode with
schemaA
, and fallback toschemaB
in case of failure, - Documentation interpreter produce a
oneOf
JSON schema.
The difference between this operation and the operation
orElse
on “tagged” schemas is that this operation does not rely on a discriminator field between the alternative schemas. As a consequence, decoding is slower than with “tagged” schemas and provides less precise error messages.- schemaB
fallback schema
- Note
Be careful to use disjoint schemas for
A
andB
(none must be a subtype of the other), otherwise, a value of typeB
might also be successfully decoded as a value of typeA
, and this could have surprising consequences.
- Encoder interpreters forward to
- def withDescription(description: String): JsonSchema[A]
Include a description of what this schema represents
Include a description of what this schema represents
- Encoder and decoder interpreters ignore this description,
- Documentation interpreters can show this description.
- description
information about the values described by the schema
- Definition Classes
- JsonSchemaOps → JsonSchemaDocumentationOps
- def withExample(example: A): JsonSchema[A]
Include an example of value in this schema
Include an example of value in this schema
- Encoder and decoder interpreters ignore this value,
- Documentation interpreters can show this example value.
- example
Example value to attach to the schema
- Definition Classes
- JsonSchemaOps → JsonSchemaDocumentationOps
- def withTitle(title: String): JsonSchema[A]
Include a title for the schema
Include a title for the schema
- Encoder and decoder interpreters ignore the title,
- Documentation interpreters can show this title.
- title
short title to attach to the schema
- Definition Classes
- JsonSchemaOps → JsonSchemaDocumentationOps