diff --git a/docs/concepts/flags.md b/docs/concepts/flags.md index 16b9c51..38a5726 100644 --- a/docs/concepts/flags.md +++ b/docs/concepts/flags.md @@ -3,7 +3,8 @@ ## Side flags These are flags, which specify, for which side a [version](../schema/addon.md), a [file](../schema/file.md) or -a [relation](../schema/relation.md) was made. +a [relation](../schema/relation.md) was made. If a file has no side flags set, it will inherit them from the +[version object](../schema/addon.md), while a version is required to have side flags set. - `client` This flag specifies, that the version, relation or file can be installed on the client side - `server` This flag specifies, that the version, relation or file can be installed on the server side diff --git a/docs/schema/addon.md b/docs/schema/addon.md index e36d1d6..0ac57eb 100644 --- a/docs/schema/addon.md +++ b/docs/schema/addon.md @@ -33,6 +33,10 @@ This is the [version number](../concepts/versioning.md) of this version. Version [Maven version order rules](../concepts/versioning.md#version-order-specification). If this version number is valid semver, the `semver` property is implicitly equal to `version` if `semver` was not explicitly set. +### flags + +This is an array of [flags](../concepts/flags.md) for this version. + ## Optional properties ### semver @@ -52,10 +56,6 @@ This is an array of [file objects](file.md) including the files belonging to thi This is an array of [relation objects](relation.md) which represent addons in relation to this one. -### flags - -This is an array of [flags](../concepts/flags.md) for this version. - ### repositories This is an array of [repository objects](repository.md). Each repository object defines one repository from which files or diff --git a/docs/schema/file.md b/docs/schema/file.md index 27ae820..a697ff4 100644 --- a/docs/schema/file.md +++ b/docs/schema/file.md @@ -39,7 +39,8 @@ The order in the array corresponds to the order in which the installation steps ### flags -This is an array of [flags](../concepts/flags.md) for this file. If this property is not present in a file object, the file will use the default flags. +This is an array of [flags](../concepts/flags.md) for this file. If this property is not present in a file object, the file will +inherit the [side flags](../concepts/flags.md#side-flags) from the [version](addon.md) and have the `required` flag set by default. ### sha1 diff --git a/docs/schema/relation.md b/docs/schema/relation.md index b49d6f5..1825e63 100644 --- a/docs/schema/relation.md +++ b/docs/schema/relation.md @@ -42,7 +42,8 @@ the namespace from all defined repositories. ### flags -This is an array of [flags](../concepts/flags.md) for this relation. If this property is not present in a relation object, the relation will use the default flags. +This is an array of [flags](../concepts/flags.md) for this relation. If this property is not present in a relation object, the relation will +inherit the [side flags](../concepts/flags.md#side-flags) from the [version](addon.md) and have the `required` flag set by default. ### conditions