EnumOps
endpoints4s.algebra.JsonSchemas.EnumOps
final implicit class EnumOps[A](enumA: Enum[A]) extends JsonSchemaDocumentationOps[A]
Attributes
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Give a name to the schema
Give a name to the schema
- Encoder and decoder interpreters ignore the name,
- Documentation interpreters use that name to refer to this schema.
Attributes
- Note
-
Names are used by documentation interpreters to construct references and the JSON schema specification requires these to be valid URI's. Consider using
withTitle
if you just want to override the heading displayed in documentation.
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
In this article