Skip to content

add glossary entry for 'implementation' #277

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

Merged
merged 5 commits into from
Feb 8, 2024
Merged

add glossary entry for 'implementation' #277

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
268d985
add glossary entry for 'implementation'
gregsdennis Jan 24, 2024
8e8f4b5
update implementation defn
gregsdennis Feb 1, 2024
34738ce
update 'implementation' to prefer 'tooling'; move defn to 'tooling'
gregsdennis Feb 5, 2024
a2bfdc4
Update pages/learn/glossary.md
gregsdennis Feb 7, 2024
944e6ce
reword clarification about validators and the spec
gregsdennis Feb 7, 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
17 changes: 17 additions & 0 deletions pages/learn/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ A property appearing within a [schema](#schema) object.

The [JSON Schema specification](../specification) defines behavior for a large library of keywords which can be used to describe [instances](#instance).

### implementation

Historically, the word "implementation" has been used to describe both specifically validators/annotators (interpreted as strictly operating as the spec describes) and also various other kinds of JSON Schema tooling. However, due to this ambiguity, we have decided that the preferred conversational term should be ["tooling"](#tooling).

### instance

A piece of JSON data which is to be described by a [schema](#schema).
Expand Down Expand Up @@ -112,6 +116,19 @@ Said more plainly, whether a particular value is a subschema or not depends on i

Subschemas may themselves contain sub-subschemas, though colloquially one generally uses the term "subschema" regardless of the level of nesting, further clarifying which larger schema is the parent schema whenever needed.

### tooling

A JSON Schema tool (or colloquially "tooling") is any software application or library for working with or evaluating schemas in some way that does not contradict the JSON Schema specification.

The following are considered tools:

- a validator library
- a CLI validator
- a schema or code generator
- a UI form generator

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.

### vocabulary

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