addonscript-spec/docs/schema/repository.md
2021-11-14 00:37:29 +01:00

26 lines
751 B
Markdown

# Repository Object
```json
{
"id": "asrepo",
"type": "api",
"url": "https://addonscript.net/repo"
}
```
## Required properties
### id
This is the ID of the repository. It has to be unique to the AddonScript file.
### type
This is the type of the repository. Possible values are [`api`](../repository/api/README.md), [`maven`](../repository/maven.md) or [`index`](../repository/index.md).
### url
This is the base URL of the repository. While other URLs in AddonScript can have different schemes,
the base URL has to be a http(s) URL, except for `index` and `maven` repositories, where it can also be `file`.
If it is a maven repository the scheme can also be `file`, where
it points to a directory, which contains the maven repository.