From 556cecb5c66f5b01f1eac70d76ae9da9118bc80c Mon Sep 17 00:00:00 2001 From: Victory Nwani Date: Fri, 26 Apr 2024 12:23:21 +0100 Subject: [PATCH 1/3] feat: add glossary term for Anchor --- pages/learn/glossary.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pages/learn/glossary.md b/pages/learn/glossary.md index 2c92e4b57..310c5aaa2 100644 --- a/pages/learn/glossary.md +++ b/pages/learn/glossary.md @@ -124,6 +124,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 + +The `$anchor` keyword is one of the ways to identify the location of a subschema within a document. By applying an anchor, the subschema becomes identifiable via a plain-name URI string. An anchor is also a shorter alternative to using a JSON Pointer for identifying a subschema. + + ### tooling A JSON Schema tool (or colloquially "tooling") is any software application or library for working with or evaluating schemas in some way. From bcd59424daa13a1bdbe3f3eee0084146963548f2 Mon Sep 17 00:00:00 2001 From: Victory Nwani Date: Wed, 1 May 2024 00:45:04 +0100 Subject: [PATCH 2/3] update: redefine anchor term and add URI example --- pages/learn/glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/learn/glossary.md b/pages/learn/glossary.md index 310c5aaa2..1ff5fdcc9 100644 --- a/pages/learn/glossary.md +++ b/pages/learn/glossary.md @@ -127,9 +127,9 @@ Subschemas may themselves contain sub-subschemas, though colloquially one genera ### anchor -The `$anchor` keyword is one of the ways to identify the location of a subschema within a document. By applying an anchor, the subschema becomes identifiable via a plain-name URI string. An anchor is also a shorter alternative to using a JSON Pointer for identifying a subschema. - +An anchor helps you to identify the location of a subschema within your JSON document. By applying an anchor to a subschema using the `$anchor` property, 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. + ### tooling A JSON Schema tool (or colloquially "tooling") is any software application or library for working with or evaluating schemas in some way. From 441e2ec5d99ae58aa61a6ef8c6620bd6739b4977 Mon Sep 17 00:00:00 2001 From: Nwani Victory Date: Wed, 1 May 2024 15:27:34 +0100 Subject: [PATCH 3/3] update: add editorial suggestions to anchor definition. Co-authored-by: Jason Desrosiers --- pages/learn/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/learn/glossary.md b/pages/learn/glossary.md index 1ff5fdcc9..7b718d438 100644 --- a/pages/learn/glossary.md +++ b/pages/learn/glossary.md @@ -127,7 +127,7 @@ Subschemas may themselves contain sub-subschemas, though colloquially one genera ### anchor -An anchor helps you to identify the location of a subschema within your JSON document. By applying an anchor to a subschema using the `$anchor` property, 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. +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. ### tooling