deployment_config
Creates, updates, deletes, gets or lists a deployment_config resource.
Overview
| Name | deployment_config |
| Type | Resource |
| Id | vercel.microfrontends.deployment_config |
Fields
The following fields are returned by SELECT queries:
- get
projectIds are added when the config is uploaded to s3 deployment assets.
| Name | Datatype | Description |
|---|---|---|
$schema | string | See https://openapi.vercel.sh/microfrontends.json. |
applications | object | |
options | object | Optional configuration options for the microfrontend. |
version | string | The version of the microfrontends config schema. (1) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | deployment_id | team_id, slug | Get the microfrontends config for a deployment. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
deployment_id | string | The unique deployment identifier |
slug | string | The Team slug to perform the request on behalf of. |
team_id | string | The Team identifier to perform the request on behalf of. (wire: teamId) |
SELECT examples
- get
Get the microfrontends config for a deployment.
SELECT
$schema,
applications,
options,
version
FROM vercel.microfrontends.deployment_config
WHERE deployment_id = '{{ deployment_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;