@spec enum_schema(keyword()) :: OpenApiSpex.Schema.t()

Creates an enum schema with x-enum-varnames extension for TypeScript codegen.

Options

• :values - (required) List of enum values
• :varnames - List of variable names for code generation (e.g., ["PENDING", "ACTIVE"])
• :description - Overall description for the enum field
• :type - Schema type, defaults to :string

Example

Helpers.enum_schema(
  values: ["pending", "active", "suspended"],
  varnames: ["PENDING", "ACTIVE", "SUSPENDED"],
  description: "Account status"
)

Generated TypeScript

export enum Status {
  PENDING = "pending",
  ACTIVE = "active",
  SUSPENDED = "suspended"
}