vulcan.generic
Type members
Classlikes
Annotation which can be used to include documentation in derived schemas.
Annotation which can be used to include documentation in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum documentation when using
deriveEnum.
- Annotate a type for fixed documentation when using
deriveFixed.
- Annotate a
case class
for record documentation when usingCodec.derive
from the generic module. - Annotate a
case class
parameter for record field documentation when usingCodec.derive
from the generic module.
Annotation which can be used to alter the record name in derived schemas.
Annotation which can be used to alter the record name in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum name when using
deriveEnum.
- Annotate a type for fixed name when using
deriveFixed.
- Annotate a
case class
for record name when usingCodec.derive
from the generic module. - Annotate a
case class
parameter for record field name when usingCodec.derive
from the generic module.
Annotation which can be used to set the namespace in derived schemas.
Annotation which can be used to set the namespace in derived schemas.
The annotation can be used in the following situations.
- Annotate a type for enum namespace when using
deriveEnum.
- Annotate a type for fixed namespace when using
deriveFixed.
- Annotate a
case class
for record namespace when usingCodec.derive
from the generic module.
Annotation which can be used to enable/disable explicit default null values for nullable fields in derived schemas.
Annotation which can be used to enable/disable explicit default null values for nullable fields in derived schemas.
The annotation can be used in the following situations.
- Annotate a
case class
to enable/disable explicit default null values in the schema for all nullable fields when usingCodec.derive
from the generic module. - Annotate a
case class
parameter to enable/disable explicit default null value in the schema for this specific nullable field when usingCodec.derive
from the generic module.
Parameter
annotation takes precedence over case class
one when both are used.
- Companion:
- object