project_config

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

Overview

Name	project_config
Type	Resource
Id	vercel.microfrontends.project_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	project_id_or_name	team_id, slug	Get the microfrontends config for a project by ID or name.

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
project_id_or_name	string	The name or ID of the project
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 project by ID or name.

SELECT
$schema,
applications,
options,
version
FROM vercel.microfrontends.project_config
WHERE project_id_or_name = '{{ project_id_or_name }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;