Metadata

Metadata options document attributes for API exports and client generation. These options affect generated OpenAPI, TypeScript, and Zod output but have no effect on runtime behavior.

description

Human-readable description for API documentation:

attribute :status, description: "Current publication status"

example

Example value shown in generated exports:

attribute :email, example: "user@example.com"
attribute :created_at, example: "2024-01-15T10:30:00Z"

deprecated

Mark an attribute as deprecated:

attribute :legacy_id, deprecated: true

format

Type-specific format hints for validation and client generation:

attribute :email, format: :email
attribute :website, format: :url
attribute :uuid, format: :uuid
attribute :ip_address, format: :ipv4

String formats:

Format	OpenAPI	Zod
:email	format: email	z.email()
:uuid	format: uuid	z.uuid()
:url	format: url	z.url()
:date	format: date	z.iso.date()
:datetime	format: date-time	z.iso.datetime()
:ipv4	format: ipv4	z.ipv4()
:ipv6	format: ipv6	z.ipv6()
:password	format: password	z.string()
:hostname	format: hostname	z.string()

Numeric formats:

Format	Type	OpenAPI	Zod
:int32	integer	format: int32	z.number().int()
:int64	integer	format: int64	z.number().int()
:float	decimal / number	format: float	z.number()
:double	decimal / number	format: double	z.number()