SchemaCompanionMacros
Value members
Concrete methods
Creates a schema for an enumeration, where the validator is derived using sttp.tapir.Validator.derivedEnumeration. This requires
that all subtypes of the sealed hierarchy T must be objects.
Creates a schema for an enumeration, where the validator is derived using sttp.tapir.Validator.derivedEnumeration. This requires
that all subtypes of the sealed hierarchy T must be objects.
- Value parameters:
- encode
Specify how values of this type can be encoded to a raw value (typically a String; the raw form should correspond with
schemaType). This encoding will be used when generating documentation.- schemaType
The low-level representation of the enumeration. Defaults to a string.
Create a schema for a map with arbitrary keys. The schema for the keys (Schema[K]) should be a string (that is, the schema type
should be sttp.tapir.SchemaType.SString), however this cannot be verified at compile-time and is not verified at run-time.
Create a schema for a map with arbitrary keys. The schema for the keys (Schema[K]) should be a string (that is, the schema type
should be sttp.tapir.SchemaType.SString), however this cannot be verified at compile-time and is not verified at run-time.
The given keyToString conversion function is used during validation.
If you'd like this schema to be available as an implicit for a given type of keys, create an custom implicit, e.g.:
case class MyKey(value: String) extends AnyVal
implicit val schemaForMyMap = Schema.schemaForMap[MyKey, MyValue](_.value)