addonscript-spec/docs/schema/api_env_request.md
Timo Ley 9d5b4d945e
All checks were successful
continuous-integration/drone/pr Build is passing
Environment builder spec
2022-09-10 16:56:51 +02:00

1.5 KiB

Environment Builder Request Object

{
    "addonscript": {},
    "addon": {},
    "client": {},
    "server": {}
}

Required properties

addonscript

This is an AddonScript object containing information about the version of AddonScript used in this request. It SHOULD be equal to the addonscript Property of the manifest from which the request was send.

addon

This is an addon descriptor object, which contains the addon ID, canonical namespace and version of the addon, for which the launch environment will be build.

Optional properties

client

This is an environment object containing information about the client environment.

server

This is an environment object containing information about the server environment.

Environment Object

{
    "requested": [],
    "provided": []
}

Optional properties

requested

This is an array of addon descriptor objects which contains all addons, that will be part of the launch environment, including their version.

provided

This is an array of addon descriptor objects which contains all addons from the relations of the addon, from which the request was send, that will be installed in the instance, including their version