Primitives

String

String is byte sequence primitive type represent by Go string or []byte.

Supported formats

caution

duration is a Go time.Duration format, but JSON Schema defines it as RFC 3339 duration.

Format	Type	Description
byte	[]byte	Base64-encoded string as defined in RFC4648
date-time	time.Time	Date and time notation as defined by RFC 3339, section 5.6, for example, 2022-02-22T11:22:33Z
date	time.Time	Date only notation as defined by RFC 3339, section 5.6, for example, 2022-02-22
time	time.Time	Time only notation as defined by RFC 3339, section 5.6, for example, 11:22:33
duration	time.Duration	Go duration format
uuid	uuid.UUID	UUID
ip	netip.Addr	Any IP (IPv4, IPv6)
ipv4	netip.Addr	IPv4, for example, 1.1.1.1
ipv6	netip.Addr	IPv6, for example, 2001:db8:85a3::8a2e:370:7334
uri	url.URL	URL as defined by RFC 3986
email	string	Email, for example, foo@example.com
binary	string	Binary string
hostname	string	Hostname as defined by RFC 1034, section 3.1

Non-standard formats

Format	Type	Description
unix/unix-seconds	time.Time	Time.Unix(), encoded as string
unix-nano	time.Time	Time.UnixNano(), encoded as string
unix-micro	time.Time	Time.UnixMicro(), encoded as string
unix-milli	time.Time	Time.UnixMilli(), encoded as string
int32	int32	32-bit signed integer
int64	int64	64-bit signed integer

See issue #307 for more information about these formats.

Validation

note

Note that length validation uses utf8.RuneCountInString to count string length.

Validator	Description
minLength	Minimum length in Unicode code points
maxLength	Maximum length in Unicode code points
pattern	Go regexp pattern

Numbers

OpenAPI/JSON schema has two numeric types, number and integer, where number includes both integer and floating-point numbers.

type	format	Go type	Description
number	–	float64	Any numbers
number	float	float32	Floating-point numbers
number	double	float64	Floating-point numbers with double precision
integer	–	int	Integer numbers
integer	int32	int32	Signed 32-bit integers
integer	int64	int64	Signed 64-bit integers