Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gregsdennis/format registry #1574

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Gregsdennis/format registry #1574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0843b8a
add format registry file
gregsdennis Jan 15, 2025
344b6f8
add section for format registry; add requirements to support those fo…
gregsdennis Jan 15, 2025
985f432
permalink oas urls
gregsdennis Jan 15, 2025
52b0b90
move registry into dedicated folder to potentially support multiple r…
gregsdennis Jan 31, 2025
5a63d51
import all formats from openapi's registry
gregsdennis Jan 31, 2025
3488625
fix validation spec link to format registry file
gregsdennis Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions specs/jsonschema-validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,10 +328,10 @@ an annotation.

Implementations:

- SHOULD provide validation for each format attribute defined in this
document;
- MAY support format values not defined in this document, but such support MUST
be configurable and disabled by default;
- SHOULD provide validation for each format attribute defined in this document
and listed in the {{format-registry}};
- MAY support format values not defined in this document or listed in the
registry, but such support MUST be configurable and disabled by default;
- SHOULD use a common parsing library or a well-known regular expression for
each format;
- SHOULD clearly document how and to what degree each format attribute is
Expand All @@ -342,7 +342,13 @@ syntactic checking; implementations SHOULD NOT attempt to send an email, connect
to a URL, or otherwise check the existence of an entity identified by a format
instance.

#### Custom format values
#### Format Registry {#format-registry}

In addition to the formats defined by this document, JSON Schema also maintains a registry of formats defined by other specifications and organizations. As of the publication of this document, the format registry can be found at <https://github.com/json-schema-org/json-schema-spec/blob/main/specs/registries/format.json>.

Implementations SHOULD support the formats listed in this registry as if they were defined by this document.

#### Custom `format` Values

Implementations MAY support custom format values. Save for agreement between
parties, schema authors SHALL NOT expect a peer implementation to support such
Expand Down
Loading