Enums

String constants

Register the containing schema with WithEnum for each enum field. Values are discovered from typed constants in the same package.

type Status string

const (
    StatusPending Status = "pending"
    StatusDone    Status = "done"
)

type Task struct {
    Status Status `json:"status"`
}

var _ = jsonschema.NewJSONSchemaMethod(
    Task.Schema,
    jsonschema.WithEnum(Task{}.Status),
)

Integer and iota constants

Choose the wire representation for an integer-backed enum:

• WithEnum emits raw numeric constant values.
• WithStringerEnum emits constant names such as LogDebug and LogInfo as strings. It does not emit the return values of String().

type LogLevel int

const (
    LogDebug LogLevel = iota
    LogInfo
    LogError
)

type Config struct {
    LogLevel LogLevel `json:"logLevel"`
}

var _ = jsonschema.NewJSONSchemaMethod(
    Config.Schema,
    jsonschema.WithStringerEnum(Config{}.LogLevel),
)

Use jsonschema.WithEnum(Config{}.LogLevel) instead when the JSON contract should contain numeric values.

The older package-level NewEnumType[T]() registration remains supported for string enums, but field-level options make the containing schema’s behavior explicit and are preferred for new code.

See the compiling examples/stringer_enums package for a complete example.