schema

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

Overview

Name	schema
Type	Resource
Id	vercel.edge_config.schema

Fields

The following fields are returned by SELECT queries:

get

Wrapper for non-JSON response bodies (jsonl, ndjson, streamed json, octet-stream): one row carrying the raw body text.

Name	Datatype	Description
contents	string	Raw response body.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	edge_config_id	team_id, slug	Returns the schema of a Global Config.
update	update	edge_config_id, definition	dry_run, team_id, slug	Update a Global Config's schema.
delete	delete	edge_config_id	team_id, slug	Deletes the schema of existing Global Config.

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
edge_config_id	string
dry_run	string	(wire: dryRun)
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

Returns the schema of a Global Config.

SELECT
contents
FROM vercel.edge_config.schema
WHERE edge_config_id = '{{ edge_config_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

UPDATE examples

update

Update a Global Config's schema.

UPDATE vercel.edge_config.schema
SET 
definition = '{{ definition }}'
WHERE 
edge_config_id = '{{ edge_config_id }}' --required
AND definition = '{{ definition }}' --required
AND dry_run = '{{ dry_run}}'
AND team_id = '{{ team_id}}'
AND slug = '{{ slug}}';

DELETE examples

delete

Deletes the schema of existing Global Config.

DELETE FROM vercel.edge_config.schema
WHERE edge_config_id = '{{ edge_config_id }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;