addonscript-spec/docs/schema/api_builder_response.md

32 lines
1,003 B
Markdown
Raw Normal View History

2022-09-10 16:56:51 +02:00
# Environment Builder Response Object
```json
{
"addonscript": {},
2023-02-03 16:20:43 +01:00
"files": [],
2023-04-21 19:56:33 +02:00
"launch_client": {},
"launch_server": {},
2022-09-10 16:56:51 +02:00
}
```
## Required properties
### addonscript
This is an [AddonScript object](addonscript.md) containing information about the version of AddonScript used in this response.
2023-04-10 16:10:08 +02:00
It MUST be equal to the [addonscript Property](api_builder_request.md#addonscript) of the [request](api_builder_request.md).
2022-09-10 16:56:51 +02:00
### files
This is an array of [File objects](file.md). These files will be concidered to be files of the addon, for which the launch
2023-02-03 16:20:43 +01:00
environment was build, and MUST be treated equal to the [files in the manifest](manifest.md#files).
## Optional properties
2023-04-21 19:56:33 +02:00
### launch_client
2023-02-03 16:20:43 +01:00
2023-04-21 19:56:33 +02:00
This is a [Launch Config object](./launch.md) for the client, which can be used, to modify the launch configuration of the instance.
### launch_server
This is a [Launch Config object](./launch.md) for the server, which can be used, to modify the launch configuration of the instance.