addonscript/addonscript-spec
addonscript/addonscript-spec
1
1
Fork 2
Code Issues 3 Pull requests 1 Projects Releases 3 Wiki Activity

Update repository.md

Browse source
This commit is contained in:
Timo Ley 2022-02-27 19:21:21 +01:00
parent c1df85f368
commit 8c1a6b156a
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/SUMMARY.md
View file

@ -4,7 +4,7 @@
# API
- [API](api/README.md)
- [AddonScript API](api/README.md)
# Schema

16
docs/schema/repository.md
View file

@ -4,7 +4,7 @@
{
"id": "asrepo",
"type": "api",
"url": "https://addonscript.net/repo"
"url": "https://api.addonscript.net"
}
```
@ -16,11 +16,15 @@ 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).
This is the type of the repository. Possible values are `addonscript` or `maven`.
A repository of the type `addonscript` is an instance of the [AddonScript API](../api).
AddonScript will use the basic endpoints of that instance to retrieve available versions
of a specific addon, as well as the [addon JSON](./addon.md) for a specific version of an
addon.
### 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.
This is the base URL of an [AddonScript API](../api) instance, if the repository
type is `addonscript`, or the base URL of a Maven Repository, if the repository
type is `maven`.