endpoints4s.algebra.JsonSchemas.JsonSchemaDocumentationOps
Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.
Attributes
-
Graph
-
-
Supertypes
-
class Object
trait Matchable
class Any
-
Known subtypes
-
Members list
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.
Value parameters
-
description
-
information about the values described by the schema
Attributes
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.
Value parameters
-
example
-
Example value to attach to the schema
Attributes
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.
Value parameters
-
title
-
short title to attach to the schema
Attributes