package

Property description

The package property is the highest-level property in a Dawiso package as it defines the package name, key, assets etc.

Minimal JSON

{
   "package": {
      "key": "",
      "assets": { }
   }
}

Nested properties

Property	Description	Values	Mandatory
key	Unique key of the package used for referencing the package in all operations (add/remove, install, uninstall). If a value for this parameter is specified, it will override the value that was set during the package creation process through the UI. The key can be changed only before the initial package installation. If you change the key of an installed application package, the application will be removed from your spaces along with all stored objects.	string	Yes
assets*	Wrapper for all nested properties in a package. For patch packages, each defined asset should include an action property which specifies what should be modified. For more informaton, see Patch Packages. Allowed actions are: add: All required properties of the added asset have to be included., delete: Package has to include identification properties (e.g., key or component)., update: Package has to include identification properties (e.g., key or component) + properties to be updated.	nested property	Yes
autoInstall	Information for the Marketplace whether it should automatically install all packages specified by the dependsOn property. Property not allowed for patch packages.	boolean	No
basePackageKey	Unique key of the base package the patch is modifying. Mandatory for patch packages.	json	No
changeLog	A simple array of short comments for individual package versions, which has no influence on package validation.	array	No
dependsOn	Specifies which packages must be installed prior to the current package. If version is null then any version of the package can be installed. Mandatory for patch packages in case of multiple dependencies.	array	No
name	Name of the package. If a value for this parameter is specified, it will override the value that was set during the package creation process through the UI.	string	No
provider	Author of the package.	string	No
settings*	Specifies default translations namespace, search templates, notifications, etc. Property not allowed for patch packages.	nested property	No
runAfter	Specifies which packages need to be executed before the patch package. Mandatory for patch packages.	json	No
type	Package type. Options are: Null: No type, a normal installation package., base: Reserved for core Dawiso packages., patch: Allows minor modifications to core packages. For more informaton, see Patch Packages.	string	No

* settings and assets are further explained in their specific articles.