Skip to content
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

Jump to bottom

Add validation result and JSON pointer in the glossary #677

Merged
merged 7 commits into from
May 2, 2024
Merged

Add validation result and JSON pointer in the glossary #677

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4943726
validation result and JSON pointer
starlightknown Apr 25, 2024
101f77d
add related article
starlightknown Apr 25, 2024
d7cb923
fix
starlightknown Apr 25, 2024
9096111
fix JSON pointer definition
starlightknown Apr 29, 2024
61bdea7
Update glossary.md
starlightknown Apr 29, 2024
4f3aaba
Update glossary.md
starlightknown Apr 30, 2024
41aa43b
Update glossary.md
starlightknown Apr 30, 2024
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
8 changes: 8 additions & 0 deletions pages/learn/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ The essence of JSON Hyper-Schema lies in its ability to define links and actions

In other words, JSON Hyper-Schema extends JSON Schema by introducing features for creating hypermedia controls. This facilitates the creation of interactive APIs and ensures compatibility with existing JSON HTTP APIs, maintaining a seamless integration. It adds a layer of interactivity to JSON documents, making it easier to interact with remote JSON resources.

### JSON pointer

JSON Pointer is a format for data exchange between systems, defining a string for accessing and modifying values within a JSON document. By using JSON Pointer, we can precisely reference and retrieve specific values within a JSON document. The [subschema](#subschema) is typically identified via a JSON Pointer, or equivalent syntax, allowing for targeted validation and manipulation of data within the JSON document.
Copy link
Member

Choose a reason for hiding this comment

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

It'd be good to link to the JSON Pointer spec (RFC 6901).

Also, JSON Pointer merely identifies a location within a document. It doesn't (itself) access or modify values, though it is used by other standards to accomplish those tasks.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for adding the link, but the rest has not been addressed. JSON Pointer does not modify documents. It only serves to indicate a location within a document.


### keyword

A property appearing within a [schema](#schema) object.
Expand Down Expand Up @@ -137,6 +141,10 @@ The following are considered tools:

Applications which use JSON Schema internally without exposing that functionality in some way, for example, validating configuration files or web requests, are not considered tooling.

### validation result

The validation result in the context of JSON Schema refers to the outcome of applying the entire JSON Schema to the entire instance document. This application should yield a boolean assertion, indicating whether the instance document conforms to the rules and constraints specified in the schema. The validation result signifies whether the instance document passes or fails validation against the [schema](#schema).
gregsdennis marked this conversation as resolved.
Show resolved Hide resolved

### vocabulary

A tightly related collection of [keywords](#keyword), grouped to facilitate re-use.
Expand Down