algebra-json-schema/endpoints4s.algebra/JsonSchemas/EnumOps

EnumOps

final implicit class EnumOps[A](enumA: Enum[A]) extends JsonSchemaDocumentationOps[A]
class Object
trait Matchable
class Any

Type members

Types

type Self = Enum[A]

Value members

Concrete methods

def named(name: String): Enum[A]

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.
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.

def withDescription(description: String): Enum[A]
def withExample(example: A): Enum[A]
def withTitle(title: String): Enum[A]