Skip to main content

deployment_config

Creates, updates, deletes, gets or lists a deployment_config resource.

Overview

Namedeployment_config
TypeResource
Idvercel.microfrontends.deployment_config

Fields

The following fields are returned by SELECT queries:

projectIds are added when the config is uploaded to s3 deployment assets.

NameDatatypeDescription
$schemastringSee https:​//openapi.vercel.sh/microfrontends.json.
applicationsobject
optionsobjectOptional configuration options for the microfrontend.
versionstringThe version of the microfrontends config schema. (1)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdeployment_idteam_id, slugGet 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.

NameDatatypeDescription
deployment_idstringThe unique deployment identifier
slugstringThe Team slug to perform the request on behalf of.
team_idstringThe Team identifier to perform the request on behalf of. (wire: teamId)

SELECT examples

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 }}'
;