Edit this page on GitHub

JSON Schema for OpenAPI course

Looking to master JSON Schema for OpenAPI?

A 9+ hour course taught by a member of the JSON Schema Technical Steering Committee

Take the Video Course Also check out our O'Reilly book

format : String

format

String

Define semantic information about a string instance.

Value	This keyword must be set to a string, preferably one that is standardized by JSON Schema to ensure interoperability Hint: Use the `jsonschema metaschema` and `jsonschema lint` commands to catch keywords set to invalid values
Kind	Annotation
Applies To	String
Base Dialect	Draft 3
Changed In	Draft 4 Draft 6 Draft 7 2019-09
Introduced In	Draft 1
Vocabulary	Core
Specification	https://json-schema.org/draft-03/draft-zyp-json-schema-03.pdf#5.23
Metaschema	http://json-schema.org/draft-03/schema#
Official Tests	draft3/format.json draft3/optional/format/color.json draft3/optional/format/date-time.json draft3/optional/format/date.json draft3/optional/format/ecmascript-regex.json draft3/optional/format/email.json draft3/optional/format/host-name.json draft3/optional/format/ip-address.json draft3/optional/format/ipv6.json draft3/optional/format/regex.json draft3/optional/format/time.json draft3/optional/format/uri.json
Default	None
Annotation	None
Affected By	None
Affects	None

We are looking for contributors to help us fully expand the documentation to cover this dialect. If that sounds like you, send a pull request on GitHub!

Feeling stuck? Need expert help?

Sourcemeta, the company behind this site, offers world-class consultancy services in the JSON Schema ecosystem. We have extensive experience designing large-scale JSON Schema ontologies and data models, and OpenAPI Governance initiatives across industries. Reach out to discuss more!

Hint: You can also get free community help in the JSON Schema Slack and JSON Schema GitHub Discussions forum.