package.manifest
Umbraco package configuration file
package.manifest
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
package.manifest and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
id | string | The (NuGet) package ID, shown in the backoffice and included in package telemetry as unique identifier (supported in v12+). Also used to retrieve the assembly informational version if no explicit `version` and `versionAssemlbyName` is set. |
name | string | The (friendly) package name, shown in the backoffice and included in package telemetry. If not specified, uses the directory name instead. |
version | string | The package version, shown in the backoffice and included in package telemetry. If not specified, uses the `versionAssemblyName` or `id` to retrieve the assembly informational version. |
versionAssemblyName | string | The assembly name to retrieve the informational version, if no explicit `version` is set. If not specified, uses the `id` instead (supported in v12+). |
allowPackageTelemetry | boolean | Allows you to opt-out of including your package in telemetry reports if set to false, defaults to true. default: true |
packageView | string | The full path to an HTML view for your package to help users maintain configuration data when viewing installed packages in the backoffice. |
bundleOptions | string | Default: The assets will be bundled with the typical packages bundle. None: The assets in the package will not be processed at all and will all be requested as individual assets in debug and production. Independent: The packages assets one of: "Default", "None", "Independent" |
javascript | array<string> | A list of JavaScript files with full path to load in the backoffice. |
css | array<string> | A list of CSS files with full path to load in the backoffice. |
propertyEditors | array | Returns an array of editor objects, each object specifies an editor to make available to data types as an editor component. These editors are primarily property editors for content, media and members, but can also be made available as a |
parameterEditors | array | Returns an array of editor objects, each object specifies an editor to make available to macro parameters as an editor component. These editors work solely as parameter editors, and will not show up on the property editors list. |
gridEditors | array | Returns an array of grid editor objects, each object specifies a grid editor to make available in the Grid Layout property editor. |
dashboards | array | Returns an array of dashboards, each object specified a dashboard to make available in the backoffice. |
sections | array | Returns an array of sections/applications to add to the backoffice. |
contentApps | array | Returns an array of Content Apps to add to the backoffice. |
Audit
What we found in this schema
- Declared draft: draft-04
- Validates cleanly against its own meta-schema.
- 62 properties, 94% carrying a description, max nesting depth 9.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
minItems | JSON Schema Validation, draft 2020-12 | §6.4.2 — "minItems" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
minProperties | JSON Schema Validation, draft 2020-12 | §6.5.2 — "minProperties" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
uniqueItems | JSON Schema Validation, draft 2020-12 | §6.4.3 — "uniqueItems" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.