You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 2, 2023. It is now read-only.
* Make any JSON format a hypermedia format with no constraints on document structure
30
-
* Allows use of [URI Templates](https://tools.ietf.org/html/rfc6570) with instance data
31
-
* Describe client data for use with links using JSON Schema.
32
-
* Recognizes collections and collection items.
27
+
Luckily, we created this [getting started guide](/learn/getting-started-step-by-step)!
33
28
34
-
</div>
29
+
After that, you could check out all our [learning resources](/learn).
30
+
31
+
### Got questions?
32
+
33
+
We're here to help!
34
+
35
+
At any point, feel free to join our Slack server using the link in the menu.
36
+
37
+
We also monitor the `jsonschema` tag on StackOverflow.
35
38
36
39
## Project Status
37
40
38
-
16 September 2019: Draft 2019-09 (formerly known as draft-08) has been published!
41
+
2021-02-01: Draft 2020-12 has been published!
39
42
40
-
The IETF document IDs are of the form `draft-handrews-*-02`. We are now using dates
41
-
for meta-schemas, which are what implementations should use to determine behavior,
42
-
so we will usually refer to `2019-09` (without the word "draft") on this web site.
43
+
The IETF document IDs are of the form `draft-bhutton-*-00`.
44
+
45
+
We are using dates for meta-schemas, which are what implementations should use to determine behavior,
46
+
so we will usually refer to `2020-12` (without the word "draft") on this web site.
43
47
44
48
See the [Specification page](specification.html) for details about naming and numbering.
45
49
50
+
46
51
### The Path to Standardization
47
52
48
-
The JSON Schema project intends to shepherd all four draft series to RFC status. Currently, we are continuing to improve our self-published Internet-Drafts. The next step will be to get the drafts adopted by an IETF Working Group. We are actively investigating how to accomplish this.
53
+
The JSON Schema project intends to shepherd all three draft series to either: RFC status, the equivilent within another standards body, or join a foundation and establish self publication rules.
49
54
50
-
If you have experience with such things and would like to help, please contact us!
55
+
<detailsmarkdown="1">
56
+
<summary>Read more</summary>
57
+
58
+
Currently, we are continuing to improve our self-published Internet-Drafts. We are not activly pursuing joining a standards organisation.
59
+
60
+
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!
51
61
52
62
In the meantime, publication of Internet-Draft documents can be tracked through the IETF:
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.
59
68
60
69
The intention, particularly for vocabularies such as validation which have been widely implemented, is to remain as compatible as possible from draft to draft. However, these are still drafts, and given a clear enough need validated with the user community, major changes can occur.
61
70
71
+
</details>
72
+
62
73
## Quickstart
63
74
64
75
The JSON document being validated or described we call the *instance*, and the document containing the description is called the *schema*.
@@ -77,6 +88,14 @@ You can apply constraints on an instance by adding validation keywords to the sc
77
88
78
89
JSON Schema is hypermedia ready, and ideal for annotating your existing JSON-based HTTP API. JSON Schema documents are identified by URIs, which can be used in HTTP Link headers, and inside JSON Schema documents to allow recursive definitions.
79
90
91
+
## JSON Hyper-Schema
92
+
93
+
JSON Hyper-Schema is on hiatus / not currently maintained as of 2021.
94
+
95
+
This allows the team to focus the little time they do donate on JSON Schema core and validation.
96
+
97
+
We may revisit JSON Hyper-Schema at a later date.
98
+
80
99
## More
81
100
82
101
Interested? Check out:
@@ -86,7 +105,7 @@ Interested? Check out:
86
105
*[Learning resources](./learn/index.md)
87
106
* the growing list of [JSON (Hyper-)Schema software](./implementations.md)
88
107
89
-
We encourage updating to the latest specification, as described by the draft-07 meta-schemas.
108
+
We encourage updating to the latest specification where possible, which is 2020-12.
_**NOTE:** All meta-schema URIs now use `https://`. While currently also available over plain HTTP due to the limitations of GitHub pages and the need to keep prior drafts available over HTTP, only the HTTPS URIs should be used._
0 commit comments