Skip to content

Preserve data when regenerating json files from addon-datastore #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nvdaes wants to merge 1 commit into
base: main
Choose a base branch
from
+152 −117
Draft

Preserve data when regenerating json files from addon-datastore #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
269 changes: 152 additions & 117 deletions src/validate/addon_data.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,122 +1,157 @@
{
"type": "object",
"additionalProperties": true,
"examples": [
{
"addonId": "nvdaocr",
"addonVersionNumber": {
"major": 1,
"minor": 3,
"patch": 2
"type": "object",
"additionalProperties": true,
"examples": [
{
"addonId": "nvdaocr",
"addonVersionNumber": {
"major": 1,
"minor": 3,
"patch": 2
},
"minNVDAVersion": {
"major": 2019,
"minor": 3,
"patch": 0
},
"lastTestedVersion": {
"major": 2020,
"minor": 4,
"patch": 0
},
"channel": "stable"
}
],
"required": [
"addonId",
"addonVersionNumber",
"minNVDAVersion",
"lastTestedVersion",
"channel"
],
"properties": {
"addonId": {
"$id": "#/properties/addonId",
"default": "",
"examples": [
"easyAddonTech.XYZ"
],
"title": "The ID for the addon",
"type": "string"
},
"addonVersionNumber": {
"$ref": "#/$defs/canonicalVersion",
"title": "The addon version number",
"description": "Pure numerical representation of the version being released."
},
"minNVDAVersion": {
"$ref": "#/$defs/canonicalVersion",
"description": "The addon will not work with versions of NVDA prior to this version.",
"title": "The minNVDAVersion required for the addon"
},
"lastTestedVersion": {
"$ref": "#/$defs/canonicalVersion",
"title": "The lastTestedVersion schema",
"description": "The add-on has been tested up to and including this version of NVDA"
},
"channel": {
"$id": "#/properties/channel",
"default": "",
"description": "Used to define pre-release (beta) add-ons. Should be either 'stable', 'beta' or 'dev'",
"examples": [
"beta"
],
"title": "The channel for the addon",
"enum": [
"stable",
"beta",
"dev"
],
"type": "string"
}
,
"reviewUrl": {
"$id": "#/properties/reviewUrl",
"default": "",
"description": "A URL to the discussion comment to review the add-on version.",
"examples": [
"https://github.com/nvaccess/addon-datastore/discussions/1942#discussioncomment-7453248"
],
"title": "Discussion comment URL",
"type": "string"
},
"minNVDAVersion": {
"major": 2019,
"minor": 3,
"patch": 0
"vtScanUrl": {
"$id": "#/properties/vtScanUrl",
"default": "",
"description": "A URL to the Virus Total scan for the add-on version.",
"examples": [
"https://www.virustotal.com/gui/file/3fda88d598e9747b2dfadfdfb8930a737c0049e9782392bffcd59ef668821547"
],
"title": "VirusTotal scan URL",
"type": "string"
},
"lastTestedVersion": {
"major": 2020,
"minor": 4,
"patch": 0
},
"channel": "stable"
}
],
"required": [
"addonId",
"addonVersionNumber",
"minNVDAVersion",
"lastTestedVersion",
"channel"
],
"properties": {
"addonId": {
"$id": "#/properties/addonId",
"default": "",
"examples": [
"easyAddonTech.XYZ"
],
"title": "The ID for the addon",
"type": "string"
},
"addonVersionNumber": {
"$ref": "#/$defs/canonicalVersion",
"title": "The addon version number",
"description": "Pure numerical representation of the version being released."
},
"minNVDAVersion": {
"$ref": "#/$defs/canonicalVersion",
"description": "The addon will not work with versions of NVDA prior to this version.",
"title": "The minNVDAVersion required for the addon"
},
"lastTestedVersion": {
"$ref": "#/$defs/canonicalVersion",
"title": "The lastTestedVersion schema",
"description": "The add-on has been tested up to and including this version of NVDA"
},
"channel": {
"$id": "#/properties/channel",
"default": "",
"description": "Used to define pre-release (beta) add-ons. Should be either 'stable', 'beta' or 'dev'",
"examples": [
"beta"
],
"title": "The channel for the addon",
"enum": [
"stable",
"beta",
"dev"
],
"type": "string"
}
},
"$defs": {
"canonicalVersion": {
"default": {},
"type": "object",
"examples": [
{
"major": 21,
"minor": 6,
"patch": 0
}
],
"required": [
"major",
"minor",
"patch"
],
"properties": {
"major": {
"default": 0,
"description": "'major' in major.minor.patch",
"examples": [
21,
2019,
2021
],
"title": "The 'major' part of the version number.",
"type": "integer"
},
"minor": {
"default": 0,
"description": "The 'minor' part in major.minor.patch",
"examples": [
3
],
"title": "The 'minor' part of the version number.",
"type": "integer"
},
"patch": {
"default": 0,
"description": "The 'patch' part in major.minor.patch",
"examples": [
0
],
"title": "The 'patch' part of the version number.",
"type": "integer"
}
"scanResults": {
"$id": "#/properties/scanResults",
"default": {},
"description": "Results from dynamic and static code scanning.",
"examples": [
{
"virusTotal": {},
"codeQL-warnings": {},
"codeQL-errors": {}
}
],
"title": "Scan results",
"type": "object"
}
}
}
},
"$defs": {
"canonicalVersion": {
"default": {},
"type": "object",
"examples": [
{
"major": 21,
"minor": 6,
"patch": 0
}
],
"required": [
"major",
"minor",
"patch"
],
"properties": {
"major": {
"default": 0,
"description": "'major' in major.minor.patch",
"examples": [
21,
2019,
2021
],
"title": "The 'major' part of the version number.",
"type": "integer"
},
"minor": {
"default": 0,
"description": "The 'minor' part in major.minor.patch",
"examples": [
3
],
"title": "The 'minor' part of the version number.",
"type": "integer"
},
"patch": {
"default": 0,
"description": "The 'patch' part in major.minor.patch",
"examples": [
0
],
"title": "The 'patch' part of the version number.",
"type": "integer"
}
}
}
}
}