Skip to content

Update links to json hyper schema to match new paths #53

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update links to json hyper schema to match new paths #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions workspaces/json-hyper-schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# JSON Hyper-Schema

This package is the beginning of an implemenation of [JSON Hyper-Schema](http://json-schema.org/latest/json-schema-hypermedia.html). It currently only provides utilities to look up a link by `rel`, `method`, and/or `title`, and for resolving [URI Templates](https://tools.ietf.org/html/rfc6570) from instance data.
This package is the beginning of an implemenation of [JSON Hyper-Schema](https://json-schema.org/specification/json-hyper-schema). It currently only provides utilities to look up a link by `rel`, `method`, and/or `title`, and for resolving [URI Templates](https://tools.ietf.org/html/rfc6570) from instance data.

## URI Template resolution

Resolving URI Templates in JSON Hyper-Schema involves some additional steps beyond what is covered in the URI Template RFC.

Currently, with draft-04 hyper-schemas, URI Templates can use dot-separated names to index into the instance object. This is not part of draft-04, and the function does not implement draft-04's preprocessing options.

In the future, URI Template resolution will support the [full draft-07 resolution process](http://json-schema.org/draft-07/json-schema-hypermedia.html#rfc.section.7.2), including user input.
In the future, URI Template resolution will support the [full draft-07 resolution process](https://json-schema.org/draft-07/json-schema-hypermedia#rfc.section.7.2), including user input.