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 all commits
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](https://datatracker.ietf.org/doc/html/rfc6901) is a string syntax for identifying a value at a specified location within a JSON document. It serves to precisely reference specific parts of the document for retrieval or manipulation. A subschema is often identified using a JSON Pointer, specifying its location within the containing resource.

### 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](../blog/posts/get-started-with-json-schema-in-node-js.md#creating-a-schema-and-validating-data) in the context of JSON Schema refers to the outcome of applying the entire JSON Schema to the entire instance document. This outcome can encompass more than just a boolean assertion and may include various output formats, such as error messages, error codes, or detailed validation reports. It signifies whether the instance document adheres 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).

### vocabulary

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