tilera
/
addonscript-spec
forked from addonscript/addonscript-spec
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

API improvements

This commit is contained in:
Timo Ley 2022-12-27 23:01:50 +01:00
parent f265e1c858
commit 83c8948f95
1 changed files with 34 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/api/README.md
View File

@ -4,27 +4,48 @@
`GET {base URL}`
The index endpoint can be used to get basic information about an API
instance, including the API versions and features supported by that
instance and the [default namespace](../concepts/namespaces.md#default-namespaces) of the instance.
The response object of this endpoint contains a `versions` property, which is an object with API
version numbers as keys and the configuration objects for the specific API version as values.
For API version `v2` (AddonScript major release 2) the configuration object contains a `features`
property, which is an array containing all [API features](#features) available on this API instance.
The index endpoint can be used to get basic information about which
API versions an API instance implements. The response object of this
endpoint contains a `versions` property, which is an array containing
all API versions available on this instance.
### Example response body:
``` json
{
"versions": {
"v2": {
"features": ["addons", "env", "com.example.customfeature"]
}
}
"versions": ["v2"]
}
```
## Features
`GET {base URL}/{API version}`
Each API version also has an index endpoint with information specifically
about that version. The response of that index MAY differ across different
API versions. If an API version is not implemented on an instance, the
corresponding index endpoint MUST return a `400 Bad Request` or
`404 Not Found` status code.
## API Version v2:
This version of the AddonScript specification only specifies API version `v2`,
which is currently the only existing version.
`GET {base URL}/v2`
The `v2` version index endpoint can be used to retrieve the API features
supported by this API instance on version `v2`. The response object of
this endpint contains a `features` property, which is an array containing
all [API features](#features) supported on this instance.
### Example response body:
``` json
{
"features": ["addons", "env", "com.example.customfeature"]
}
```
### Features
API features can be either part of the specification itself or
are specified by third parties. Third-party API features SHOULD