Skip to content

Commit 9e237b9

Browse files
committed
Better description of hyper-schema
Include some forthcoming features, and note that the guide from STSI is out-of-date (I have also bumped the issue at their repo to see how we can get it updated).
1 parent 3bdac9a commit 9e237b9

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
.sass-cache/
33
_site/
44
node_modules/
5+
Gemfile.lock

index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ Advantages
2424

2525
### JSON Hyper-Schema
2626

27-
- describes your existing API - no new structures required
28-
- links (including [URI Templates](http://tools.ietf.org/html/rfc6570) for target URIs)
29-
- forms - specify a JSON Schema for the desired data
27+
- make any JSON format a hypermedia format - no constraints on document structure
28+
- use [URI Templates](https://tools.ietf.org/html/rfc6570) with instance data
29+
- describe client data for use with links using JSON Schema
30+
- recognize collections and collection items _coming soon!_
3031

3132
</div>
3233

@@ -58,13 +59,13 @@ Interested? Check out:
5859

5960
- the [specification](documentation.md)
6061
- some [examples](examples.md)
61-
- this [excellent guide](http://spacetelescope.github.io/understanding-json-schema/) for schema authors, from the [Space Telescope Science Institute](http://www.stsci.edu/)
6262
- the growing list of [JSON (Hyper-)Schema software](implementations.md)
6363

64+
We encourage updating to the latest specification, as described by the draft-06 meta-schemas. However, if you are still on draft-04, you be be interested in:
65+
- this [excellent guide](http://spacetelescope.github.io/understanding-json-schema/) for schema authors, from the [Space Telescope Science Institute](http://www.stsci.edu/)
66+
6467
Questions? Feeling helpful? Get involved on:
6568

6669
- the [GitHub repo](http://github.com/json-schema-org/json-schema-spec)
6770
- the [Google Group](https://groups.google.com/forum/#!forum/json-schema)
6871
- the [IRC channel](irc://chat.freenode.net/json-schema) ([Freenode Webchat](https://webchat.freenode.net/?channels=json-schema))
69-
70-

0 commit comments

Comments
 (0)