alex/yomichan
1
Fork 0
Code Releases Activity

Update schema descriptions to be less redundant (#1721)

Browse Source
This commit is contained in:
toasted-nutbread 2021-05-30 16:22:25 -04:00 committed by GitHub
parent 5bf82a5b81
commit 6da81d59c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ext/data/schemas/dictionary-index-schema.json
View File

@ -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",

10
ext/data/schemas/dictionary-term-bank-v1-schema.json
View File

@ -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."
}
}
}

22
ext/data/schemas/dictionary-term-bank-v3-schema.json
View File

@ -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."
}
]
}

18
ext/data/schemas/dictionary-term-meta-bank-v3-schema.json
View File

@ -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",