Skip to content
This repository has been archived by the owner on Nov 12, 2024. It is now read-only.

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
planetscale-actions-bot committed Sep 13, 2024
1 parent e83d8a2 commit b0b233e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/concepts/planetscale-api-oauth-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Learn more about the API and how to use it in the [PlanetScale API documentation

Some examples of what you can do with the PlanetScale API:

- Automatically [create and delete database branches](https://api-docs.planetscale.com/reference/create-a-branch) from CI/CD pipelines or data migration tooling
- Automatically [create and delete database branches](https://api-docs.planetscale.com/reference/create_branch) from CI/CD pipelines or data migration tooling
- Programmatically build out new environments that connect to PlanetScale database branches for testing
- Get information about a PlanetScale user, database, branch, organization, and deploy request
- [Check the status of deploy requests](https://api-docs.planetscale.com/reference/get-a-deploy-request) in the deploy queue
- Automate [creating and deleting database connection strings](https://api-docs.planetscale.com/reference/create-a-password) for internal users or tools
- [Create, update, approve, deploy, and delete deploy requests](https://api-docs.planetscale.com/reference/create-a-deploy-request) programmatically from tooling outside of PlanetScale
- [Check the status of deploy requests](https://api-docs.planetscale.com/reference/get_deploy_request) in the deploy queue
- Automate [creating and deleting database connection strings](https://api-docs.planetscale.com/reference/create_password) for internal users or tools
- [Create, update, approve, deploy, and delete deploy requests](https://api-docs.planetscale.com/reference/create_deploy_request) programmatically from tooling outside of PlanetScale

Anywhere that can programmatically use an HTTP API can be integrated with PlanetScale. This includes CLI tools, build scripts, desktop applications, and more.

Expand Down
22 changes: 11 additions & 11 deletions docs/reference/webhook-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If there is an event you want to use that is not included in this list, please [

The branch has a new anomaly event in PlanetScale Insights.

The `branch.anomaly` event uses the same response body as a `200` response from the [Get a branch](https://api-docs.planetscale.com/reference/get-a-branch) API endpoint. The link includes a detailed description of each field in the API reference.
The `branch.anomaly` event uses the same response body as a `200` response from the [Get a branch](https://api-docs.planetscale.com/reference/get_branch) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -124,7 +124,7 @@ The `branch.anomaly` event uses the same response body as a `200` response from

The branch is created and ready to connect.

The `branch.ready` event uses the same response body as a `200` response from the [Get a branch](https://api-docs.planetscale.com/reference/get-a-branch) API endpoint. The link includes a detailed description of each field in the API reference.
The `branch.ready` event uses the same response body as a `200` response from the [Get a branch](https://api-docs.planetscale.com/reference/get_branch) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -203,7 +203,7 @@ The `branch.ready` event uses the same response body as a `200` response from th

The branch is now sleeping.

The `branch.sleeping` event uses the same response body as a `200` response from the [Get a branch](https://api-docs.planetscale.com/reference/get-a-branch) API endpoint. The link includes a detailed description of each field in the API reference.
The `branch.sleeping` event uses the same response body as a `200` response from the [Get a branch](https://api-docs.planetscale.com/reference/get_branch) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -282,7 +282,7 @@ The `branch.sleeping` event uses the same response body as a `200` response from

The deploy request has been opened.

The `deploy_request.opened` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.opened` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -362,7 +362,7 @@ The `deploy_request.opened` event uses the same response body as a `200` respons

The deploy request has been added to the deploy queue.

The `deploy_request.queued` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.queued` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -462,7 +462,7 @@ The `deploy_request.queued` event uses the same response body as a `200` respons

The deploy request has started running.

The `deploy_request_in_progress` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request_in_progress` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -562,7 +562,7 @@ The `deploy_request_in_progress` event uses the same response body as a `200` re

The deploy request has stopped due to an error.

The `deploy_request.errored` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.errored` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -672,7 +672,7 @@ The `deploy_request.errored` event uses the same response body as a `200` respon

The deploy request is ready to apply the schema and is waiting on the user to confirm.

The `deploy_request.pending_cutover` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.pending_cutover` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

**Example:**

Expand Down Expand Up @@ -785,7 +785,7 @@ The `deploy_request.pending_cutover` event uses the same response body as a `200

The deploy request has finished applying the schema.

The `deploy_request.schema_applied` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.schema_applied` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

```json
{
Expand Down Expand Up @@ -918,7 +918,7 @@ The `deploy_request.schema_applied` event uses the same response body as a `200`

The deploy request has been reverted.

The `deploy_request.reverted` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.reverted` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

```json
{
Expand Down Expand Up @@ -1051,7 +1051,7 @@ The `deploy_request.reverted` event uses the same response body as a `200` respo

The deploy request has been closed.

The `deploy_request.closed` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get-a-deploy-request) API endpoint. The link includes a detailed description of each field in the API reference.
The `deploy_request.closed` event uses the same response body as a `200` response from the [Get a deploy request](https://api-docs.planetscale.com/reference/get_deploy_request) API endpoint. The link includes a detailed description of each field in the API reference.

```json
{
Expand Down

0 comments on commit b0b233e

Please sign in to comment.