addonscript-spec/docs/schema/relation.md

40 lines
1.1 KiB
Markdown
Raw Normal View History

2021-06-23 22:06:21 +02:00
# Relation Object
```json
{
"id": "namespace:othermod",
2021-11-14 00:17:32 +01:00
"version": "1.0",
2021-11-13 20:47:21 +01:00
"repositories": ["repo1"],
"flags": [],
"conditions": {}
2021-06-23 22:06:21 +02:00
}
```
## Required properties
### id
2021-11-14 00:37:29 +01:00
This is the ID or namespaced ID of the addon this relation refers to.
2021-06-23 22:06:21 +02:00
### version
2021-11-14 00:17:32 +01:00
<!--TODO: update link one PR is merged-->
2021-11-14 00:37:29 +01:00
2021-11-13 20:47:21 +01:00
This is a [semver version range](https://github.com/semver/semver/pull/584) of supported versions of this relation.
2021-06-23 22:06:21 +02:00
## Optional properties
2021-11-13 20:47:21 +01:00
### repositories
2021-11-14 00:17:32 +01:00
This is an array of [repository](repository.md) IDs. These are the repositories, from which AddonScript should try to get this relation from,
in the order as they are specified in the array. If this property is not set or the array is empty, AddonScript will try to resolve the relation by
2021-11-13 20:47:21 +01:00
the namespace from all defined repositories.
2021-06-23 22:06:21 +02:00
### flags
2021-11-14 00:17:32 +01:00
This is an array of [flags](../flags.md) for this relation. If this property is not present in a relation object, the relation will use the default flags.
### conditions
This is a [conditions object](conditions.md). It can only be used, if the [optional flag](../flags.md) was set.