Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Better description of hyper-schema #160

Merged
merged 2 commits into from
Oct 1, 2017
Merged

Better description of hyper-schema #160

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d57ff6
Better description of hyper-schema
handrews Sep 30, 2017
c064daf
Fix typo and wording based on feedback.
handrews Oct 1, 2017
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.sass-cache/
_site/
node_modules/
Gemfile.lock
13 changes: 7 additions & 6 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ Advantages

### JSON Hyper-Schema

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

</div>

Expand Down Expand Up @@ -58,13 +59,13 @@ Interested? Check out:

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

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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/be be/may be/

and maybe:
"using draft-04" or "targeting draft-04" instead of "on draft-04"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch & good idea, thanks.

- this [excellent guide](http://spacetelescope.github.io/understanding-json-schema/) for schema authors, from the [Space Telescope Science Institute](http://www.stsci.edu/)

Questions? Feeling helpful? Get involved on:

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