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
- make any JSON format a hypermedia format - no constraints on document structure
32
-
-use [URI Templates](https://tools.ietf.org/html/rfc6570) with instance data
33
-
- describe client data for use with links using JSON Schema
34
-
- recognize collections and collection items
30
+
* Make any JSON format a hypermedia format with no constraints on document structure
31
+
* Allows use of[URI Templates](https://tools.ietf.org/html/rfc6570) with instance data
32
+
* Describe client data for use with links using JSON Schema.
33
+
* Recognizes collections and collection items.
35
34
36
35
</div>
37
36
38
-
Project Status
39
-
--------------
37
+
## Project Status
40
38
41
-
The JSON Schema project intends to shepherd the Core, Validation, and Hyper-Schema specifications
42
-
to RFC status. Currently, we are continuing to improve our self-published Internet-Drafts.
43
-
The next step will be to get the drafts adopted by an IETF Working Group.
39
+
The JSON Schema project intends to shepherd the Core, Validation, and Hyper-Schema specifications 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.
44
40
45
41
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
52
-
a set of unexpired drafts available. There may be brief gaps as we wrap up each draft and finalize
53
-
the text.
47
+
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.
54
48
55
-
The intention, particularly for vocabularies such as validation which have been widely
56
-
implemented, is to remain as compatible as possible from draft to draft. However, these are still
57
-
drafts, and given a clear enough need validated with the user community, major changes can occur.
49
+
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.
58
50
59
-
Progress on the next set of Internet-Drafts can be tracked on GitHub.
60
-
The [draft-08](https://github.com/json-schema-org/json-schema-spec/milestone/6) milestone
61
-
will track the evolving scope of the draft
51
+
Progress on the next set of Internet-Drafts can be tracked on GitHub. The [draft-08](https://github.com/json-schema-org/json-schema-spec/milestone/6) milestone will track the evolving scope of the draft
62
52
63
-
<divstyle="clear:both"></div>
64
-
65
-
Quickstart
66
-
----------
53
+
## Quickstart
67
54
68
55
The JSON document being validated or described we call the *instance*, and the document containing the description is called the *schema*.
69
56
@@ -76,25 +63,23 @@ The most basic schema is a blank JSON object, which constrains nothing, allows a
76
63
You can apply constraints on an instance by adding validation keywords to the schema. For example, the "type" keyword can be used to restrict an instance to an object, array, string, number, boolean, or null:
77
64
78
65
```json
79
-
{"type": "string"}
66
+
{"type": "string"}
80
67
```
81
68
82
69
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.
83
70
84
-
More
85
-
----
71
+
## More
86
72
87
73
Interested? Check out:
88
74
89
-
- the [specification](specification.html)
90
-
- some [examples](examples.md)
91
-
-the growing list of [JSON (Hyper-)Schema software](implementations.html)
75
+
* The [specification](./specification.md)
76
+
*[Learning resources](./learn/index.md)
77
+
*the growing list of [JSON (Hyper-)Schema software](./implementations.md)
92
78
93
-
We encourage updating to the latest specification, as described by the draft-07 meta-schemas. However, if you are still using draft-04, you may be interested in:
94
-
- this [excellent guide](https://spacetelescope.github.io/understanding-json-schema/) for schema authors, from the [Space Telescope Science Institute](http://www.stsci.edu/)
79
+
We encourage updating to the latest specification, as described by the draft-07 meta-schemas.
95
80
96
81
Questions? Feeling helpful? Get involved on:
97
82
98
-
- the [GitHub repo](http://github.com/json-schema-org/json-schema-spec)
99
-
- the [Google Group](https://groups.google.com/forum/#!forum/json-schema)
100
-
- the [Slack channel](https://join.slack.com/t/json-schema/shared_invite/enQtMjk1NDcyNDI2NTAwLTcyYmYwMjdmMmUxNzZjYzIxNGU2YjdkNzdlOGZiNjIwNDI2M2Y3NmRkYjA4YmMwODMwYjgyOTFlNWZjZjAyNjg)
0 commit comments