forked from addonscript/addonscript-spec
Merge pull request 'Rename addon.md to manifest.md' (#22) from tilera/addonscript-spec:master into master
Reviewed-on: addonscript/addonscript-spec#22
This commit is contained in:
commit
ea975232e5
7 changed files with 10 additions and 10 deletions
|
@ -10,7 +10,7 @@
|
|||
|
||||
# Schema
|
||||
|
||||
- [Addon Object](schema/addon.md)
|
||||
- [Addon Manifest Object](schema/manifest.md)
|
||||
- [AddonScript Object](schema/addonscript.md)
|
||||
- [File Object](schema/file.md)
|
||||
- [Install Object](schema/install.md)
|
||||
|
|
|
@ -36,5 +36,5 @@ This endpoint can be used to retrieve the manifest of a specific version of an a
|
|||
#### Responses:
|
||||
|
||||
- `200 OK`: This version of the addon is available in this addon repository.
|
||||
The response body must be an [Addon Manifest](../../schema/addon.md).
|
||||
The response body must be an [Addon Manifest](../../schema/manifest.md).
|
||||
- `404 Not Found`: This version of the addon is not available in this addon repository.
|
|
@ -2,16 +2,16 @@
|
|||
|
||||
## Side flags
|
||||
|
||||
These are flags, which specify, for which side a [version](../schema/addon.md), a [file](../schema/file.md) or
|
||||
These are flags, which specify, for which side a [version](../schema/manifest.md), a [file](../schema/file.md) or
|
||||
a [relation](../schema/relation.md) was made. If a file has no side flags set, it will inherit them from the
|
||||
[version object](../schema/addon.md), while a version is required to have side flags set.
|
||||
[version object](../schema/manifest.md), while a version is required to have side flags set.
|
||||
|
||||
- `client` This flag specifies, that the version, relation or file can be installed on the client side
|
||||
- `server` This flag specifies, that the version, relation or file can be installed on the server side
|
||||
|
||||
## Version flags
|
||||
|
||||
These are flags, which can be set for [versions](../schema/addon.md).
|
||||
These are flags, which can be set for [versions](../schema/manifest.md).
|
||||
|
||||
- `instance` This flag specifies, that this is a version of an instance addon. Instance addons represent instances of
|
||||
Minecraft itself, while non-instance addons have to be installed into an existing instance of Minecraft.
|
||||
|
|
|
@ -12,7 +12,7 @@ optionally also the addon type (i.e. `com.example.repository.mods`, `com.author.
|
|||
## Canonical Namespaces
|
||||
|
||||
While an addon can have multiple namespaces, it must have exactly one canonical
|
||||
namespace, which is defined in the [addon object](../schema/addon.md#namespace).
|
||||
namespace, which is defined in the [addon manifest](../schema/manifest.md#namespace).
|
||||
An [API instance](../api/) must also return the canonical namespace of
|
||||
the addon on the [addon endpoint](../api/features/addons.md#get-addon)
|
||||
even if the addon was requested from another namespace. To check, if two addons
|
||||
|
|
|
@ -41,7 +41,7 @@ The order in the array corresponds to the order in which the installation steps
|
|||
### flags
|
||||
|
||||
This is an array of [flags](../concepts/flags.md) for this file. If this property is not present in a file object, the file will
|
||||
inherit the [side flags](../concepts/flags.md#side-flags) from the [version](addon.md) and have the `required` flag set by default.
|
||||
inherit the [side flags](../concepts/flags.md#side-flags) from the [version](manifest.md) and have the `required` flag set by default.
|
||||
|
||||
### hashes
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Addon Object
|
||||
# Addon Manifest Object
|
||||
|
||||
```json
|
||||
{
|
|
@ -21,7 +21,7 @@ This is the ID of the addon this relation refers to.
|
|||
### namespace
|
||||
|
||||
This is the [namespace](../concepts/namespaces.md) of the related addon. This property will be implicitly equal to the
|
||||
[namespace of the addon](addon.md#namespace), if it was not set explicitly.
|
||||
[namespace of the addon](manifest.md#namespace), if it was not set explicitly.
|
||||
|
||||
### version
|
||||
|
||||
|
@ -42,4 +42,4 @@ the namespace from all defined repositories.
|
|||
### flags
|
||||
|
||||
This is an array of [flags](../concepts/flags.md) for this relation. If this property is not present in a relation object, the relation will
|
||||
inherit the [side flags](../concepts/flags.md#side-flags) from the [version](addon.md) and have the `required` flag set by default.
|
||||
inherit the [side flags](../concepts/flags.md#side-flags) from the [version](manifest.md) and have the `required` flag set by default.
|
||||
|
|
Loading…
Reference in a new issue