@ui5/project/lib/validation/schema/ui5-workspace.json

UI5 CLI - Project

{
	"$schema": "http://json-schema.org/draft-07/schema",
	"$id": "http://ui5.sap/schema/ui5-workspace.json",
	"title": "ui5-workspace.yaml",
	"description": "Schema for UI5 CLI Workspace Configuration File (ui5-workspace.yaml)",
	"$comment": "See https://ui5.github.io/cli/",
	"type": "object",
	"required": ["specVersion", "metadata", "dependencyManagement"],
	"properties": {
		"additionalProperties": false,
		"specVersion": {
			"enum": ["workspace/1.0"],
			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"workspace/1.0\"\nFor details, see: https://ui5.github.io/cli/stable/pages/Workspace/#workspace-specification-versions"
		},
		"metadata": {
			"$ref": "#/definitions/metadata"
		},
		"dependencyManagement": {
			"$ref": "#/definitions/dependencyManagement"
		}
	},
	"definitions": {
		"metadata": {
			"type": "object",
			"required": ["name"],
			"properties": {
				"additionalProperties": false,
				"name": {
					"type": "string",
					"minLength": 3,
					"maxLength": 80,
					"pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$",
					"title": "Workspace Name",
					"description": "Identifier for the workspace configuration. Workspaces named 'default' will be used automatically by UI5 CLI",
					"errorMessage": "Not a valid workspace name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://ui5.github.io/cli/stable/pages/Workspace/#name"
				}
			}
		},
		"dependencyManagement": {
			"type": "object",
			"properties": {
				"additionalProperties": false,
				"resolutions": {
					"type": "array",
					"additionalProperties": false,
					"items": {
						"type": "object",
						"additionalProperties": false,
						"properties": {
							"path": {
								"type": "string"
							}
						}
					}
				}
			}
		}
	}
}