From 8c1a6b156a8295dcda9b7c3e1c2f5c907decf0bf Mon Sep 17 00:00:00 2001 From: Timo Ley Date: Sun, 27 Feb 2022 19:21:21 +0100 Subject: [PATCH] Update repository.md --- docs/SUMMARY.md | 2 +- docs/schema/repository.md | 16 ++++++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 6cde58a..c18f2da 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -4,7 +4,7 @@ # API -- [API](api/README.md) +- [AddonScript API](api/README.md) # Schema diff --git a/docs/schema/repository.md b/docs/schema/repository.md index a775474..f76384a 100644 --- a/docs/schema/repository.md +++ b/docs/schema/repository.md @@ -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`.