tilera/addonscript-spec
1
0
Fork 0
forked from addonscript/addonscript-spec
Code Issues Pull requests Projects Releases Wiki Activity
addonscript-spec/docs/api/features/addons.md

1.7 KiB
Raw Blame History

Addon repository

Endpoints

Get addon

GET {base URL}/v2/addons/:namespace/:addon

This endpoint can be used to retrieve information about a specific addon, including metadata, all available versions and the canonical namespace of the addon.

Path variales:

  • namespace: The namespace of a repository which contains the addon
  • addon: The ID of the addon

Responses:

  • 200 OK: The addon is available in this addon repository. The response body MUST be an API Addon Object.
  • 404 Not Found: The addon is not available in this addon repository.

Get addon manifest

GET {base URL}/v2/addons/:namespace/:addon/:version

This endpoint can be used to retrieve the manifest of a specific version of an addon.

Path variables:

  • namespace: The namespace of a repository which contains the addon
  • addon: The ID of the addon
  • version: The version number of the requested version

Responses:

  • 200 OK: This version of the addon is available in this addon repository. The response body MUST be an Addon Manifest.
  • 404 Not Found: This version of the addon is not available in this addon repository.

Get namespaces

GET {base URL}/v2/namespaces

This endpoint can be used to get a list of repository namespaces, which can be found on this API instance. It MAY be incomplete or empty at all.

Responses:

  • 200 OK: The response body MUST be a JSON array of namespace strings.