Skip to content

Self-host past drafts #54

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.

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

Merged
merged 2 commits into from
Sep 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 13 additions & 14 deletions pages/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,36 @@

2021-02-01: Draft 2020-12 has been published!

The IETF document IDs are of the form `draft-bhutton-*-00`.
The document IDs are of the form `draft-bhutton-*-00`.

We are using dates for meta-schemas, which are what implementations should use to determine behavior,
so we will usually refer to `2020-12` (without the word "draft") on this web site.

See the [Specification page](/specification) for details about naming and numbering.
See the [Specification Links](/specification-links) page for details about naming and numbering.

### The Path to Standardization

The JSON Schema project intends to shepherd all three draft series to either: RFC status, the equivalent within another standards body, and/or join a foundation and establish self publication rules.
The JSON Schema project intends to self-publish the two JSON Schema specifications with the OpenJS Foundation. For the Relative JSON Pointer specification, we will likely pursue an RFC with IETF.

<details markdown="1">
<summary>Read more</summary>

Currently, we are continuing to improve our self-published Internet-Drafts. We are not actively pursuing joining a standards organisation.
We are currently working toward moving away from self-published Internet-Drafts.

We have a few contacts related to each potential path, but if you have experience with such things and would like to help, please still contact us!
In the meantime, you can find the latest release of specification as Internet-Drafts on the [Specification](/specification) page.

In the meantime, publication of Internet-Draft documents can be tracked through the IETF:
* [JSON Schema (core)](https://datatracker.ietf.org/doc/draft-bhutton-json-schema/)
* [JSON Schema Validation](https://datatracker.ietf.org/doc/draft-bhutton-json-schema-validation/)
* [Relative JSON Pointers](https://datatracker.ietf.org/doc/draft-bhutton-relative-json-pointer/)
Note that normal Internet-Drafts expire after six months and are replaced by
subsequent drafts. Neither of those properties apply to JSON Schema. JSON Schema
uses Internet-Drafts as production release documents, not as drafts, and each
release is a distinct version of JSON Schema. That means that our releases
remain relevant as long as they continue to be used in production despite what
the document declares as its expiration.

Internet-Drafts expire after six months, so our goal is to publish often enough to always have a set of unexpired drafts available. There may be brief gaps as we wrap up each draft and finalize the text.
</details>

### Use of the _draft_ designation
Releases of the JSON schema specification and meta schemas use the _draft_ designation primarily for historical reasons stemming from the relationship of this specification to IETF ([explained here](https://json-schema.org/specification-links#understanding-draft-names-and-numbers)).
The use of this designation is under review but will continue until this review process completes to avoid changing the designation style multiple times.
The use of this designation will not continue in future releases.

<details markdown="1">
<summary>Read more</summary>
Expand All @@ -40,8 +41,6 @@ The JSON schema project recognizes, condones, and advocates for the use of the J
Each release of the JSON schema specification is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care, thorough review and careful consideration of how the changes will impact existing users and implementations of the JSON schema specification.

Similarly to most specifications, the JSON schema specification will continue to evolve, and not all releases will be backwards compatible. The intention, particularly for vocabularies such as validation which have been widely implemented, is to remain as compatible as possible from release to release. However, major changes can still occur given a clear enough need validated with the user community.

When the _draft_ designation is dropped this may indicate that the frequency of releases and amount of changes in each release will decrease, but it won't indicate that no new releases will be made, or that all future releases will be backwards compatible.
</details>

## Quickstart
Expand Down Expand Up @@ -85,4 +84,4 @@ Interested? Check out:
## Latest version of JSON Schema
<Infobox>
We encourage updating to the latest specification where possible, which is `2020-12`.
</Infobox>
</Infobox>
2 changes: 1 addition & 1 deletion pages/draft-06/json-hyper-schema-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ keyword | change | consequence
`"rel"` | "root" relation removed | use a fragment in your `"href"` URI Template
`"fragmentResolution"` | *removed* | media type determines how fragments are interpreted
`"pathStart"` | *removed* | *[no replacement]*
`"method"` | [changed back to HTML form semantics](https://tools.ietf.org/html/draft-zyp-json-schema-03#section-6.1.1.4.1) of "get" and "post" rather than all HTTP methods | *[changed again in draft-06 due to feedback that this was confusing]*
`"method"` | [changed back to HTML form semantics](/draft-03/draft-zyp-json-schema-03.html#section-6.1.1.4.1) of "get" and "post" rather than all HTTP methods | *[changed again in draft-06 due to feedback that this was confusing]*

#### Changes from draft-05 to draft-06

Expand Down
4 changes: 2 additions & 2 deletions pages/learn/getting-started-step-by-step.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Each product in the catalog has:
* `price`: the cost to the consumer
* `tags`: an optional array of identifying tags

The JSON object is human-readable, but it doesn’t include any context or metadata. There’s no way to tell from looking at the object what the keys mean or what the possible inputs are. JSON Schema is a proposed IETF standard for providing answers to these questions. In this guide, you will create a JSON Schema document that describes the structure, constraints, and data types for a set of JSON data.
The JSON object is human-readable, but it doesn’t include any context or metadata. There’s no way to tell from looking at the object what the keys mean or what the possible inputs are. JSON Schema is a standard for providing answers to these questions. In this guide, you will create a JSON Schema document that describes the structure, constraints, and data types for a set of JSON data.

<span id="intro"></span>

Expand Down Expand Up @@ -592,4 +592,4 @@ This example JSON data matches the product catalog schema:

To validate this JSON data against the product catalog JSON Schema, you can use any validator of your choice. In addition to command-line and browser tools, validation tools are available in a wide range of languages, including Java, Python, .NET, and many others. To find a validator that’s right for your project, see [Implementations](https://json-schema.org/implementations).

Use the example JSON data as the input data and the product catalog JSON Schema as the schema. Your validation tool compares the data against the schema, and if the data meets all the requirements defined in the schema, validation is successful.
Use the example JSON data as the input data and the product catalog JSON Schema as the schema. Your validation tool compares the data against the schema, and if the data meets all the requirements defined in the schema, validation is successful.
Loading