Skip to content

Commit cd283f8

Browse files
jeffreyavenjeffreyaven
committed
added vercel
1 parent 140a82f commit cd283f8

File tree

72 files changed

+2937
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+2937
-6
lines changed

‎.github/workflows/build-docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878
if [ $PROVIDER == "root" ]; then
7979
echo "adding vanity url redirects to _redirects file.."
8080
touch ./build/_redirects
81-
array=( aws azure digitalocean firebase github google googleadmin k8s linode netlify okta sumologic )
81+
array=( aws azure digitalocean firebase github google googleadmin k8s linode netlify okta sumologic vercel )
8282
for i in "${array[@]}"
8383
do
8484
echo "adding redirects for $i"

‎README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,16 @@ This repository contains documentation for StackQL providers, which is published
2020
| Netlify Deploy Sumologic | [![Netlify Status](https://api.netlify.com/api/v1/badges/6c864774-8494-41be-8e2c-441b6d1e368c/deploy-status)](https://app.netlify.com/sites/stackql-sumologic-docs/deploys) | [sumologic-docs.stackql.io](https://sumologic-docs.stackql.io)<br/>[sumologic.stackql.io](https://sumologic.stackql.io) |
2121
| Netlify Deploy Digital Ocean | [![Netlify Status](https://api.netlify.com/api/v1/badges/ebcab4ef-d610-4888-a42f-314942d68c32/deploy-status)](https://app.netlify.com/sites/stackql-digitalocean-docs/deploys) | [digitalocean-docs.stackql.io](https://digitalocean-docs.stackql.io)<br/>[digitalocean.stackql.io](https://digitalocean.stackql.io) |
2222
| Netlify Deploy Linode | [![Netlify Status](https://api.netlify.com/api/v1/badges/d0b573be-3dfb-495c-a0ce-478ec7acecd8/deploy-status)](https://app.netlify.com/sites/stackql-linode-docs/deploys) | [linode-docs.stackql.io](https://linode-docs.stackql.io)<br/>[linode.stackql.io](https://linode.stackql.io) |
23+
| Netlify Vercel Linode | [![Netlify Status](https://api.netlify.com/api/v1/badges/91cc31b7-0c25-443f-bb2f-71921ef7084e/deploy-status)](https://app.netlify.com/sites/stackql-vercel-docs/deploys) | [vercel-docs.stackql.io](https://vercel-docs.stackql.io)<br/>[vercel.stackql.io](https://vercel.stackql.io) |
24+
2325

2426
## Adding Docs for a New Provider
2527

2628
Adding docs for a new provider requires creating a new web property (subdomain) and will force an update to the root/base site and all other providers. The steps are:
2729

2830
- [ ] update `scripts/docgen/provider_data.py` with metadata for new provider
29-
- [ ] generate docs for provider using `sh scripts/docgen.sh {provider}`
30-
- [ ] publish docs for provider using `sh scripts/publish.sh {provider}`
31+
- [ ] generate docs for provider using `cd scripts; sh docgen.sh {provider}`
32+
- [ ] publish docs for provider using `cd scripts; sh publish.sh {provider}`
3133
- [x] add the new provider docs to `docs/{provider}-docs` (following directory structure of existing providers) (done automatically by `scripts/publish.sh`)
3234
- [x] update frontmatter in the `index.md` at the root of the new providers docs, set `slug` to `/providers/{provider}` and `id` to `{provider}-doc` (done automatically by `scripts/docgen.sh`)
3335
- [x] update `stackql-provider-registry.mdx` in the root of the new provider to add the `currentProvider` prop, e.g. `<RegistryPage currentProvider="okta" />` (done automatically by `scripts/docgen.sh`)

‎ci-scripts/get-providers-to-deploy.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ const allProviders = [
2020
'netlify',
2121
'okta',
2222
'sumologic',
23+
'vercel',
2324
rootName];
2425

2526
const appendToOutput = (providers) => {
@@ -45,7 +46,7 @@ module.exports = async ({ github, context, core, pathOutput }) => {
4546

4647
// if(!(diff.startsWith('.github')) || !(diff.startsWith('scripts'))) globalChange = true;
4748

48-
// globalChange = true;
49+
globalChange = true;
4950

5051
}).filter(Boolean)
5152

‎docs/vercel-docs/index.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: vercel
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- vercel
7+
- stackql
8+
- infrastructure-as-code
9+
- configuration-as-data
10+
- cloud inventory
11+
description: Query, deploy, and manage Vercel resources using SQL
12+
custom_edit_url: null
13+
image: /img/providers/vercel/stackql-vercel-provider-featured-image.png
14+
id: vercel-doc
15+
slug: /providers/vercel
16+
17+
---
18+
Cloud platform for serverless deployment and hosting of web applications.
19+
20+
:::info Provider Summary (v23.12.00183)
21+
22+
<div class="row">
23+
<div class="providerDocColumn">
24+
<span>total services:&nbsp;<b>19</b></span><br />
25+
<span>total methods:&nbsp;<b>138</b></span><br />
26+
</div>
27+
<div class="providerDocColumn">
28+
<span>total resources:&nbsp;<b>40</b></span><br />
29+
<span>total selectable resources:&nbsp;<b>36</b></span><br />
30+
</div>
31+
</div>
32+
33+
:::
34+
35+
See also:
36+
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
37+
* * *
38+
39+
## Installation
40+
41+
To pull the latest version of the `vercel` provider, run the following command:
42+
43+
```bash
44+
REGISTRY PULL vercel;
45+
```
46+
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
47+
48+
## Authentication
49+
50+
The following system environment variables are used for authentication by default:
51+
52+
- `VERCEL_API_TOKEN` - Vercel API Token (see [Creating a Vercel API Token](https://vercel.com/account/tokens))
53+
54+
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
55+
56+
<details>
57+
58+
<summary>Using different environment variables</summary>
59+
60+
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
61+
62+
```bash
63+
64+
AUTH='{ "okta": { "type": "bearer", "credentialsenvvar": "YOUR_VERCEL_API_TOKEN_VAR" }}'
65+
stackql shell --auth="${AUTH}"
66+
67+
```
68+
or using PowerShell:
69+
70+
```powershell
71+
72+
$Auth = "{ 'okta': { 'type': 'bearer', 'credentialsenvvar': 'YOUR_VERCEL_API_TOKEN_VAR' }}"
73+
stackql.exe shell --auth=$Auth
74+
75+
```
76+
</details>
77+
78+
## Services
79+
<div class="row">
80+
<div class="providerDocColumn">
81+
<a href="/providers/vercel/aliases/">aliases</a><br />
82+
<a href="/providers/vercel/artifacts/">artifacts</a><br />
83+
<a href="/providers/vercel/authentication/">authentication</a><br />
84+
<a href="/providers/vercel/billing_settings/">billing_settings</a><br />
85+
<a href="/providers/vercel/cache/">cache</a><br />
86+
<a href="/providers/vercel/certs/">certs</a><br />
87+
<a href="/providers/vercel/checks/">checks</a><br />
88+
<a href="/providers/vercel/deployments/">deployments</a><br />
89+
<a href="/providers/vercel/dns/">dns</a><br />
90+
<a href="/providers/vercel/domains/">domains</a><br />
91+
</div>
92+
<div class="providerDocColumn">
93+
<a href="/providers/vercel/edge_config/">edge_config</a><br />
94+
<a href="/providers/vercel/integrations/">integrations</a><br />
95+
<a href="/providers/vercel/log_drains/">log_drains</a><br />
96+
<a href="/providers/vercel/project_members/">project_members</a><br />
97+
<a href="/providers/vercel/projects/">projects</a><br />
98+
<a href="/providers/vercel/secrets/">secrets</a><br />
99+
<a href="/providers/vercel/teams/">teams</a><br />
100+
<a href="/providers/vercel/user/">user</a><br />
101+
<a href="/providers/vercel/webhooks/">webhooks</a><br />
102+
</div>
103+
</div>

‎docs/vercel-docs/providers/vercel/aliases/aliases/index.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: aliases
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- aliases
7+
- aliases
8+
- vercel
9+
- stackql
10+
- infrastructure-as-code
11+
- configuration-as-data
12+
- cloud inventory
13+
description: Query, deploy, and manage Vercel resources using SQL
14+
custom_edit_url: null
15+
image: /img/providers/vercel/stackql-vercel-provider-featured-image.png
16+
---
17+
18+
19+
20+
## Overview
21+
<table><tbody>
22+
<tr><td><b>Name</b></td><td><code>aliases</code></td></tr>
23+
<tr><td><b>Type</b></td><td>Resource</td></tr>
24+
<tr><td><b>Id</b></td><td><code>vercel.aliases.aliases</code></td></tr>
25+
</tbody></table>
26+
27+
## Fields
28+
| Name | Datatype | Description |
29+
|:-----|:---------|:------------|
30+
| `alias` | `string` | The alias name, it could be a `.vercel.app` subdomain or a custom domain |
31+
| `created` | `string` | The date when the alias was created |
32+
| `createdAt` | `number` | The date when the alias was created in milliseconds since the UNIX epoch |
33+
| `creator` | `object` | Information of the user who created the alias |
34+
| `deletedAt` | `number` | The date when the alias was deleted in milliseconds since the UNIX epoch |
35+
| `deployment` | `object` | A map with the deployment ID, URL and metadata |
36+
| `deploymentId` | `string` | The deployment ID |
37+
| `projectId` | `string` | The unique identifier of the project |
38+
| `protectionBypass` | `object` | The protection bypass for the alias |
39+
| `redirect` | `string` | Target destination domain for redirect when the alias is a redirect |
40+
| `redirectStatusCode` | `number` | Status code to be used on redirect |
41+
| `uid` | `string` | The unique identifier of the alias |
42+
| `updatedAt` | `number` | The date when the alias was updated in milliseconds since the UNIX epoch |
43+
## Methods
44+
| Name | Accessible by | Required Params | Description |
45+
|:-----|:--------------|:----------------|:------------|
46+
| `get_alias` | `SELECT` | `idOrAlias, teamId` | Retrieves an Alias for the given host name or alias ID. |
47+
| `list_aliases` | `SELECT` | `teamId` | Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. |
48+
| `delete_alias` | `DELETE` | `aliasId, teamId` | Delete an Alias with the specified ID. |
49+
| `_list_aliases` | `EXEC` | `teamId` | Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases. |

‎docs/vercel-docs/providers/vercel/aliases/deployments/index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: deployments
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- deployments
7+
- aliases
8+
- vercel
9+
- stackql
10+
- infrastructure-as-code
11+
- configuration-as-data
12+
- cloud inventory
13+
description: Query, deploy, and manage Vercel resources using SQL
14+
custom_edit_url: null
15+
image: /img/providers/vercel/stackql-vercel-provider-featured-image.png
16+
---
17+
18+
19+
20+
## Overview
21+
<table><tbody>
22+
<tr><td><b>Name</b></td><td><code>deployments</code></td></tr>
23+
<tr><td><b>Type</b></td><td>Resource</td></tr>
24+
<tr><td><b>Id</b></td><td><code>vercel.aliases.deployments</code></td></tr>
25+
</tbody></table>
26+
27+
## Fields
28+
| Name | Datatype | Description |
29+
|:-----|:---------|:------------|
30+
| `alias` | `string` | The alias name, it could be a `.vercel.app` subdomain or a custom domain |
31+
| `created` | `string` | The date when the alias was created |
32+
| `protectionBypass` | `object` | The protection bypass for the alias |
33+
| `redirect` | `string` | Target destination domain for redirect when the alias is a redirect |
34+
| `uid` | `string` | The unique identifier of the alias |
35+
## Methods
36+
| Name | Accessible by | Required Params | Description |
37+
|:-----|:--------------|:----------------|:------------|
38+
| `list_deployment_aliases` | `SELECT` | `id, teamId` | Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. |
39+
| `_list_deployment_aliases` | `EXEC` | `id, teamId` | Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment. |
40+
| `assign_alias` | `EXEC` | `id, teamId` | Creates a new alias for the deployment with the given deployment ID. The authenticated user or team must own this deployment. If the desired alias is already assigned to another deployment, then it will be removed from the old deployment and assigned to the new one. |

‎docs/vercel-docs/providers/vercel/aliases/index.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: aliases
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- aliases
7+
- vercel
8+
- stackql
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy, and manage Vercel resources using SQL
13+
custom_edit_url: null
14+
image: /img/providers/vercel/stackql-vercel-provider-featured-image.png
15+
---
16+
Aliases
17+
18+
:::info Service Summary
19+
20+
<div class="row">
21+
<div class="providerDocColumn">
22+
<span>total resources:&nbsp;<b>2</b></span><br />
23+
<span>total selectable resources:&nbsp;<b>2</b></span><br />
24+
<span>total methods:&nbsp;<b>7</b></span><br />
25+
</div>
26+
</div>
27+
28+
:::
29+
30+
## Overview
31+
<table><tbody>
32+
<tr><td><b>Name</b></td><td><code>vercel.aliases</code></td></tr>
33+
<tr><td><b>Type</b></td><td>Service</td></tr>
34+
<tr><td><b>Title</b></td><td>Vercel API - Aliases</td></tr>
35+
<tr><td><b>Description</b></td><td>Aliases</td></tr>
36+
<tr><td><b>Id</b></td><td><code>aliases:v23.12.00183</code></td></tr>
37+
</tbody></table>
38+
39+
## Resources
40+
<div class="row">
41+
<div class="providerDocColumn">
42+
<a href="/providers/vercel/aliases/aliases/">aliases</a><br />
43+
</div>
44+
<div class="providerDocColumn">
45+
<a href="/providers/vercel/aliases/deployments/">deployments</a><br />
46+
</div>
47+
</div>

‎docs/vercel-docs/providers/vercel/artifacts/artifacts/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: artifacts
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- artifacts
7+
- artifacts
8+
- vercel
9+
- stackql
10+
- infrastructure-as-code
11+
- configuration-as-data
12+
- cloud inventory
13+
description: Query, deploy, and manage Vercel resources using SQL
14+
custom_edit_url: null
15+
image: /img/providers/vercel/stackql-vercel-provider-featured-image.png
16+
---
17+
18+
19+
20+
## Overview
21+
<table><tbody>
22+
<tr><td><b>Name</b></td><td><code>artifacts</code></td></tr>
23+
<tr><td><b>Type</b></td><td>Resource</td></tr>
24+
<tr><td><b>Id</b></td><td><code>vercel.artifacts.artifacts</code></td></tr>
25+
</tbody></table>
26+
27+
## Fields
28+
`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
29+
## Methods
30+
| Name | Accessible by | Required Params | Description |
31+
|:-----|:--------------|:----------------|:------------|
32+
| `artifact_exists` | `EXEC` | `hash, teamId` | Check that a cache artifact with the given `hash` exists. This request returns response headers only and is equivalent to a `GET` request to this endpoint where the response contains no body. |
33+
| `artifact_query` | `EXEC` | `teamId, data__hashes` | Query information about an array of artifacts. |
34+
| `download_artifact` | `EXEC` | `hash, teamId` | Downloads a cache artifact indentified by its `hash` specified on the request path. The artifact is downloaded as an octet-stream. The client should verify the content-length header and response body. |
35+
| `record_events` | `EXEC` | `teamId` | Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are `HIT` and `MISS`. The source is either `LOCAL` the cache event was on the users filesystem cache or `REMOTE` if the cache event is for a remote cache. When the event is a `HIT` the request also accepts a number `duration` which is the time taken to generate the artifact in the cache. |
36+
| `status` | `EXEC` | `teamId` | Check the status of Remote Caching for this principal. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits. |
37+
| `upload_artifact` | `EXEC` | `Content-Length, hash, teamId` | Uploads a cache artifact identified by the `hash` specified on the path. The cache artifact can then be downloaded with the provided `hash`. |

‎docs/vercel-docs/providers/vercel/artifacts/index.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: artifacts
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- artifacts
7+
- vercel
8+
- stackql
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy, and manage Vercel resources using SQL
13+
custom_edit_url: null
14+
image: /img/providers/vercel/stackql-vercel-provider-featured-image.png
15+
---
16+
Artifacts
17+
18+
:::info Service Summary
19+
20+
<div class="row">
21+
<div class="providerDocColumn">
22+
<span>total resources:&nbsp;<b>1</b></span><br />
23+
<span>total selectable resources:&nbsp;<b>0</b></span><br />
24+
<span>total methods:&nbsp;<b>6</b></span><br />
25+
</div>
26+
</div>
27+
28+
:::
29+
30+
## Overview
31+
<table><tbody>
32+
<tr><td><b>Name</b></td><td><code>vercel.artifacts</code></td></tr>
33+
<tr><td><b>Type</b></td><td>Service</td></tr>
34+
<tr><td><b>Title</b></td><td>Vercel API - Artifacts</td></tr>
35+
<tr><td><b>Description</b></td><td>Artifacts</td></tr>
36+
<tr><td><b>Id</b></td><td><code>artifacts:v23.12.00183</code></td></tr>
37+
</tbody></table>
38+
39+
## Resources
40+
<div class="row">
41+
<div class="providerDocColumn">
42+
<a href="/providers/vercel/artifacts/artifacts/">artifacts</a><br />
43+
</div>
44+
<div class="providerDocColumn">
45+
</div>
46+
</div>

0 commit comments

Comments
 (0)