Skip to content

Commit

Permalink
feat: add glossary term for Anchor (#680)
Browse files Browse the repository at this point in the history
* feat: add glossary term for Anchor

* update: redefine anchor term and add URI example

* update: add editorial suggestions to anchor definition.

Co-authored-by: Jason Desrosiers <[email protected]>

---------

Co-authored-by: Jason Desrosiers <[email protected]>
  • Loading branch information
vickywane and jdesrosiers authored Oct 2, 2024
1 parent 9b27076 commit ab4eb1d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions pages/learn/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ 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.


### anchor

An anchor identifies the location of a subschema within a JSON document. By applying an anchor to a subschema using the `$anchor` keyword, the subschema becomes identifiable via a plain-name URI string containing the value of the `$anchor` property starting with a `#` character. An example of a plain-name URI is `https://example.com/schemas/vehicle#owners` identifying the `owners` subschema within the `vehicle` JSON document. An anchor is also a shorter alternative to using a JSON Pointer for identifying a subschema.

<!-- TODO: add reference to JSON pointer term as a see more. -->
### tooling

A JSON Schema tool (or colloquially "tooling") is any software application or library for working with or evaluating schemas in some way.
Expand Down

0 comments on commit ab4eb1d

Please sign in to comment.