From 6da81d59c34e58454ad12afe34d363b0c1e33bc7 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sun, 30 May 2021 16:22:25 -0400 Subject: [PATCH] Update schema descriptions to be less redundant (#1721) --- ext/data/schemas/dictionary-index-schema.json | 2 +- .../dictionary-term-bank-v1-schema.json | 10 ++++----- .../dictionary-term-bank-v3-schema.json | 22 +++++++++---------- .../dictionary-term-meta-bank-v3-schema.json | 18 +++++++-------- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/ext/data/schemas/dictionary-index-schema.json b/ext/data/schemas/dictionary-index-schema.json index 09cff711..c2f095c7 100644 --- a/ext/data/schemas/dictionary-index-schema.json +++ b/ext/data/schemas/dictionary-index-schema.json @@ -18,7 +18,7 @@ "sequenced": { "type": "boolean", "default": false, - "description": "Whether or not this dictionary can be used as the primary dictionary. Primary dictionaries typically contain term/expression definitions." + "description": "Whether or not this dictionary contains sequencing information for related terms." }, "format": { "type": "integer", diff --git a/ext/data/schemas/dictionary-term-bank-v1-schema.json b/ext/data/schemas/dictionary-term-bank-v1-schema.json index 6ffb26e6..4ab15f5d 100644 --- a/ext/data/schemas/dictionary-term-bank-v1-schema.json +++ b/ext/data/schemas/dictionary-term-bank-v1-schema.json @@ -1,19 +1,19 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "type": "array", - "description": "Data file containing term and expression information.", + "description": "Data file containing term information.", "additionalItems": { "type": "array", - "description": "Information about a single term/expression.", + "description": "Information about a single term.", "minItems": 5, "items": [ { "type": "string", - "description": "Term or expression." + "description": "The text for the term." }, { "type": "string", - "description": "Reading of the term/expression, or an empty string if the reading is the same as the term/expression." + "description": "Reading of the term, or an empty string if the reading is the same as the term." }, { "type": ["string", "null"], @@ -30,7 +30,7 @@ ], "additionalItems": { "type": "string", - "description": "Single definition for the term/expression." + "description": "Single definition for the term." } } } \ No newline at end of file diff --git a/ext/data/schemas/dictionary-term-bank-v3-schema.json b/ext/data/schemas/dictionary-term-bank-v3-schema.json index b1141154..9003cbf3 100644 --- a/ext/data/schemas/dictionary-term-bank-v3-schema.json +++ b/ext/data/schemas/dictionary-term-bank-v3-schema.json @@ -98,19 +98,19 @@ } }, "type": "array", - "description": "Data file containing term and expression information.", + "description": "Data file containing term information.", "additionalItems": { "type": "array", - "description": "Information about a single term/expression.", + "description": "Information about a single term.", "minItems": 8, "items": [ { "type": "string", - "description": "Term or expression." + "description": "The text for the term." }, { "type": "string", - "description": "Reading of the term/expression, or an empty string if the reading is the same as the term/expression." + "description": "Reading of the term, or an empty string if the reading is the same as the term." }, { "type": ["string", "null"], @@ -126,16 +126,16 @@ }, { "type": "array", - "description": "Array of definitions for the term/expression.", + "description": "Array of definitions for the term.", "items": { "oneOf": [ { "type": "string", - "description": "Single definition for the term/expression." + "description": "Single definition for the term." }, { "type": "object", - "description": "Single detailed definition for the term/expression.", + "description": "Single detailed definition for the term.", "required": [ "type" ], @@ -160,7 +160,7 @@ }, "text": { "type": "string", - "description": "Single definition for the term/expression." + "description": "Single definition for the term." } } }, @@ -177,7 +177,7 @@ }, "content": { "$ref": "#/definitions/structuredContent", - "description": "Single definition for the term/expression using a structured content object." + "description": "Single definition for the term using a structured content object." } } }, @@ -238,11 +238,11 @@ }, { "type": "integer", - "description": "Sequence number for the term/expression. Terms/expressions with the same sequence number can be shown together when the \"resultOutputMode\" option is set to \"merge\"." + "description": "Sequence number for the term. Terms with the same sequence number can be shown together when the \"resultOutputMode\" option is set to \"merge\"." }, { "type": "string", - "description": "String of space-separated tags for the term/expression. An empty string is treated as no tags." + "description": "String of space-separated tags for the term. An empty string is treated as no tags." } ] } diff --git a/ext/data/schemas/dictionary-term-meta-bank-v3-schema.json b/ext/data/schemas/dictionary-term-meta-bank-v3-schema.json index ffffb546..6483ce01 100644 --- a/ext/data/schemas/dictionary-term-meta-bank-v3-schema.json +++ b/ext/data/schemas/dictionary-term-meta-bank-v3-schema.json @@ -1,15 +1,15 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "type": "array", - "description": "Custom metadata for terms/expressions.", + "description": "Custom metadata for terms.", "additionalItems": { "type": "array", - "description": "Metadata about a single term/expression.", + "description": "Metadata about a single term.", "minItems": 3, "items": [ { "type": "string", - "description": "Term or expression." + "description": "The text for the term." }, { "type": "string", @@ -17,7 +17,7 @@ "description": "Type of data. \"freq\" corresponds to frequency information; \"pitch\" corresponds to pitch information." }, { - "description": "Data for the term/expression." + "description": "Data for the term." } ], "oneOf": [ @@ -29,7 +29,7 @@ "oneOf": [ { "type": ["string", "number"], - "description": "Frequency information for the term or expression." + "description": "Frequency information for the term." }, { "type": ["object"], @@ -41,11 +41,11 @@ "properties": { "reading": { "type": "string", - "description": "Reading for the term or expression." + "description": "Reading for the term." }, "frequency": { "type": ["string", "number"], - "description": "Frequency information for the term or expression." + "description": "Frequency information for the term." } } } @@ -59,7 +59,7 @@ {"enum": ["pitch"]}, { "type": ["object"], - "description": "Pitch accent information for the term or expression.", + "description": "Pitch accent information for the term.", "required": [ "reading", "pitches" @@ -68,7 +68,7 @@ "properties": { "reading": { "type": "string", - "description": "Reading for the term or expression." + "description": "Reading for the term." }, "pitches": { "type": "array",