yomichan/ext/data/schemas/dictionary-index-schema.json
2021-05-30 16:22:25 -04:00

85 lines
2.9 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Index file containing information about the data contained in the dictionary.",
"required": [
"title",
"revision"
],
"properties": {
"title": {
"type": "string",
"description": "Title of the dictionary."
},
"revision": {
"type": "string",
"description": "Revision of the dictionary. This value is only used for displaying information."
},
"sequenced": {
"type": "boolean",
"default": false,
"description": "Whether or not this dictionary contains sequencing information for related terms."
},
"format": {
"type": "integer",
"description": "Format of data found in the JSON data files.",
"enum": [1, 2, 3]
},
"version": {
"type": "integer",
"description": "Alias for format.",
"enum": [1, 2, 3]
},
"author": {
"type": "string",
"description": "Creator of the dictionary."
},
"url": {
"type": "string",
"description": "URL for the source of the dictionary."
},
"description": {
"type": "string",
"description": "Description of the dictionary data."
},
"attribution": {
"type": "string",
"description": "Attribution information for the dictionary data."
},
"tagMeta": {
"type": "object",
"description": "Tag information for terms and kanji. This object is obsolete and individual tag files should be used instead.",
"additionalProperties": {
"type": "object",
"description": "Information about a single tag. The object key is the name of the tag.",
"properties": {
"category": {
"type": "string",
"description": "Category for the tag."
},
"order": {
"type": "number",
"description": "Sorting order for the tag."
},
"notes": {
"type": "string",
"description": "Notes for the tag."
},
"score": {
"type": "number",
"description": "Score used to determine popularity. Negative values are more rare and positive values are more frequent. This score is also used to sort search results."
}
},
"additionalProperties": false
}
}
},
"anyOf": [
{
"required": ["format"]
},
{
"required": ["version"]
}
]
}