From 4339ddef1d654888039704949179f51258cce953 Mon Sep 17 00:00:00 2001 From: DaanV2 Date: Sun, 16 May 2021 13:39:02 +0200 Subject: [PATCH] Updated Manifest --- .vscode/schema-validation.json | 2 +- .vscode/settings.json | 2 +- source/general/manifest/manifest.1.json | 27 ++++++++++++++++++------- source/general/manifest/manifest.2.json | 25 +++++++++++++++-------- 4 files changed, 39 insertions(+), 17 deletions(-) diff --git a/.vscode/schema-validation.json b/.vscode/schema-validation.json index 75cb6d32..1e41a313 100644 --- a/.vscode/schema-validation.json +++ b/.vscode/schema-validation.json @@ -4,7 +4,7 @@ "object_check": { "type": "object", "dependencies": { - "type": ["title", "description"] + "type": ["title"] }, "additionalProperties": { "anyOf": [ diff --git a/.vscode/settings.json b/.vscode/settings.json index b0ab0dc5..797809ca 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,5 @@ { - "json.schemas": [{ "fileMatch": ["source/**/*.json", "source/*.json"], "url": ".vscode/schema-validation.json" }], + "json.schemas": [{ "fileMatch": ["source/**/*.json", "source/*.json"], "url": "./.vscode/schema-validation.json" }], "editor.formatOnSave": true, "[json]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, "[jsonc]": { "editor.defaultFormatter": "esbenp.prettier-vscode" }, diff --git a/source/general/manifest/manifest.1.json b/source/general/manifest/manifest.1.json index 9b3b8dc6..3994f84d 100644 --- a/source/general/manifest/manifest.1.json +++ b/source/general/manifest/manifest.1.json @@ -27,7 +27,7 @@ "type": "string", "$ref": "#/definitions/uuidv4", "description": "This is a special type of identifier that uniquely identifies this pack from any other pack. UUIDs are written in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where each x is a hexadecimal value (0-9 or a-f). We recommend using an online service to generate this and guarantee their uniqueness (just bing UUID Generator to find some)", - "title": "Uuid" + "title": "UUID" }, "version": { "$ref": "#/definitions/version", "description": "This is the version of your pack in the format [majorVersion, minorVersion, revision].", "title": "Version" }, "min_engine_version": { @@ -48,6 +48,8 @@ "items": { "additionalProperties": false, "type": "object", + "description": "TODO description: modules", + "title": "Modules", "required": ["type", "uuid", "version"], "properties": { "type": { @@ -64,16 +66,14 @@ "uuid": { "$ref": "#/definitions/uuidv4", "description": "This is a unique identifier for the module in the same format as the pack's UUID in the header. This should be different from the pack's UUID, and different for every module", - "title": "Uuid" + "title": "UUID" }, "version": { "$ref": "#/definitions/version", "description": "This is the version of the module in the same format as the pack's version in the header. This can be used to further identify changes in your pack", "title": "Version" } - }, - "description": "TODO description: modules", - "title": "Modules" + } }, "description": "TODO description: modules" }, @@ -88,7 +88,7 @@ "type": "string", "$ref": "#/definitions/uuidv4", "description": "This is the unique identifier of the pack that this pack depends on. It needs to be the exact same UUID that the pack has defined in the header section of it's manifest file", - "title": "Uuid" + "title": "UUID" }, "version": { "$ref": "#/definitions/version", @@ -115,7 +115,20 @@ "title": "Capabilities" }, "metadata": { - "authors": { "type": "string", "description": "Name of the author(s) of the pack", "title": "Authors" }, + "authors": { + "title": "Authors", + "oneOf": [ + { + "description": "Name of the author(s) of the pack", + "type": "array", + "items": { "type": "string", "title": "Name", "description": "Name of the author of the pack" } + }, + { + "description": "Name of the author of the pack", + "type": "string" + } + ] + }, "license": { "type": "string", "description": "The license of the pack", "title": "License" }, "url": { "type": "string", "description": "The home website of your pack", "title": "Url" }, "description": "TODO description: metadata", diff --git a/source/general/manifest/manifest.2.json b/source/general/manifest/manifest.2.json index d2614b18..a0c6b775 100644 --- a/source/general/manifest/manifest.2.json +++ b/source/general/manifest/manifest.2.json @@ -8,7 +8,7 @@ "definitions": { "uuidv4": { "type": "string", - "title": "A UUID V4", + "title": "An UUID V4", "description": "A valid uuid v4", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$", "format": "uuid" @@ -17,12 +17,13 @@ }, "properties": { "format_version": { + "title": "Format Version", "type": "number", - "description": "This defines the current version of the manifest. Don't change this unless you have a good reason to", - "title": "Format Version" + "description": "This defines the current version of the manifest. Don't change this unless you have a good reason to" }, "capabilities": { "type": "array", + "title": "Capabilities", "description": "These are the different features that the pack makes use of that aren't necessarily enabled by default.", "properties": { "experimental_custom_ui": { @@ -32,8 +33,7 @@ }, "chemistry": { "type": "boolean", "description": "Allows the pack to add, change or replace Chemistry functionality", "title": "Chemistry" }, "raytraced": { "type": "boolean", "description": "TODO", "title": "Raytraced" } - }, - "title": "Capabilities" + } }, "dependencies": { "type": "array", @@ -136,9 +136,18 @@ "title": "Metadata", "properties": { "authors": { - "type": "array", - "description": "Name of the author(s) of the pack", - "items": { "type": "string", "title": "Name", "description": "Name of the author of the pack" } + "title": "Authors", + "oneOf": [ + { + "description": "Name of the author(s) of the pack", + "type": "array", + "items": { "type": "string", "title": "Name", "description": "Name of the author of the pack" } + }, + { + "description": "Name of the author of the pack", + "type": "string" + } + ] }, "license": { "type": "string", "title": "License", "description": "The license of the pack" }, "url": { "type": "string", "format": "uri", "title": "Url", "description": "The home website of your pack" }