addonscript-spec/docs/schema/version.md

38 lines
848 B
Markdown
Raw Normal View History

2021-06-23 22:06:21 +02:00
# Version Object
```json
{
"version": "1.0",
"files": [],
"relations": [],
"flags": ["server", "client"],
"meta": {}
}
```
## Required properties
### version
2021-06-29 13:26:58 +02:00
This is the version number of this version. It should follow [maven version naming conventions](https://docs.oracle.com/middleware/1212/core/MAVEN/maven_version.htm),
2021-06-23 22:06:21 +02:00
as they are used to comparing versions.
## Optional properties
### files
2021-07-18 12:32:57 +02:00
This is an array of [file objects](file.md) including the files belonging to this version.
2021-06-23 22:06:21 +02:00
### relations
2021-07-18 12:32:57 +02:00
This is an array of [relation objects](relation.md) which represents related addons.
2021-06-23 22:06:21 +02:00
### flags
This is an array of [flags](../flags.md) for this version. If this property is not present in a version object, the version
2021-07-18 12:32:57 +02:00
will have the flags which are set as default for versions.
2021-06-23 22:06:21 +02:00
### meta
This is a [meta object](meta.md).