Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/sync-management-api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ jobs:
working-directory: apps/docs
run: pnpm fetch-openapi

- name: Clean stale endpoint files
run: find apps/docs/content/docs/management-api/endpoints -name '*.mdx' -type f -delete

- name: Generate docs
working-directory: apps/docs
run: pnpm tsx scripts/generate-docs.ts
Expand All @@ -51,6 +54,19 @@ jobs:
git status --short -- apps/docs/content/docs/management-api/
fi

- name: Validate links
if: steps.changes.outputs.changed == 'true'
run: pnpm run lint:links

- name: Validate spelling
if: steps.changes.outputs.changed == 'true'
run: pnpm run lint:spellcheck

- name: Build docs
if: steps.changes.outputs.changed == 'true'
working-directory: apps/docs
run: pnpm exec next build

- name: Commit and push
if: steps.changes.outputs.changed == 'true'
run: |
Expand All @@ -61,4 +77,5 @@ jobs:
git push "https://x-access-token:${{ secrets.BOT_TOKEN_DOCS_COMMIT }}@github.com/${{ github.repository }}.git" HEAD:${{ github.ref_name }}

- name: Trigger Vercel deploy
if: steps.changes.outputs.changed == 'true'
run: curl --fail -X POST "${{ secrets.VERCEL_DEPLOY_HOOK_URL }}"
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Deletes the connection with the given ID.
url: /management-api/endpoints/connections/delete-connections-by-id
metaTitle: 'DELETE /v1/connections/{id} | Delete connection - Prisma Postgres'
metaDescription: 'Management API: Deletes the connection with the given ID. DELETE /v1/connections/{id}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Get connection
full: true
_openapi:
path: "/v1/connections/{id}"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns the connection with the given ID.
url: /management-api/endpoints/connections/get-connections-by-id
metaTitle: 'GET /v1/connections/{id} | Get connection - Prisma Postgres'
metaDescription: 'Management API: Returns the connection with the given ID. GET /v1/connections/{id}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns the connection with the given ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/connections/{id}","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
---
title: Get connection
title: List connections
full: true
_openapi:
path: "/v1/connections/{id}"
path: "/v1/connections"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns the connection with the given ID.
- content: >-
Returns all connections the actor has access to, with optional
database filter.
url: /management-api/endpoints/connections/get-connections
metaTitle: 'GET /v1/connections | List connections - Prisma Postgres'
metaDescription: 'Management API: Returns all connections the actor has access to, with optional database filter. GET /v1/connections.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns the connection with the given ID.
Returns all connections the actor has access to, with optional database filter.

<APIPage document={"management-api"} operations={[{"path":"/v1/connections/{id}","method":"get"}]} />age document={"management-api"} operations={[{"path":"/v1/connections","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/connections","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"title": "Connections",
"pages": [
"get-connections",
"get-connections-by-id",
"post-connections",
"delete-connections-by-id"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Creates a new connection for the specified database.
url: /management-api/endpoints/connections/post-connections
metaTitle: 'POST /v1/connections | Create connection - Prisma Postgres'
metaDescription: 'Management API: Creates a new connection for the specified database. POST /v1/connections.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns backups for the specified database.
url: /management-api/endpoints/database-backups/get-databases-id-backups
metaTitle: 'GET /v1/databases/{databaseId}/backups | Get list of backups - Prisma Postgres'
metaDescription: 'Management API: Returns backups for the specified database. GET /v1/databases/{databaseId}/backups.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns usage metrics for the specified database.
url: /management-api/endpoints/database-usage/get-databases-id-usage
metaTitle: 'GET /v1/databases/{databaseId}/usage | Get database usage metrics - Prisma Postgres'
metaDescription: 'Management API: Returns usage metrics for the specified database. GET /v1/databases/{databaseId}/usage.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns all connections for the given database.
url: /management-api/endpoints/databases-connections/get-databases-id-connections
metaTitle: 'GET /v1/databases/{databaseId}/connections | Get list of database connections - Prisma Postgres'
metaDescription: 'Management API: Returns all connections for the given database. GET /v1/databases/{databaseId}/connections.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"title": "Connections",
"pages": ["get-databases-id-connections", "post-databases-id-connections", "delete-connections"]
"title": "Database Connections",
"pages": ["get-databases-id-connections", "post-databases-id-connections"]
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Creates a new connection string for the given database.
url: /management-api/endpoints/databases-connections/post-databases-id-connections
metaTitle: 'POST /v1/databases/{databaseId}/connections | Create database connection string - Prisma Postgres'
metaDescription: 'Management API: Creates a new connection string for the given database. POST /v1/databases/{databaseId}/connections.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Deletes the database with the given ID.
url: /management-api/endpoints/databases/delete-databases-id
metaTitle: 'DELETE /v1/databases/{databaseId} | Delete database - Prisma Postgres'
metaDescription: 'Management API: Deletes the database with the given ID. DELETE /v1/databases/{databaseId}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns the database with the given ID.
url: /management-api/endpoints/databases/get-databases-id
metaTitle: 'GET /v1/databases/{databaseId} | Get database - Prisma Postgres'
metaDescription: 'Management API: Returns the database with the given ID. GET /v1/databases/{databaseId}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ _openapi:
- content: >-
Returns all databases the token has access to. Optionally filter by
project ID.
url: /management-api/endpoints/databases/get-databases
metaTitle: 'GET /v1/databases | List databases - Prisma Postgres'
metaDescription: 'Management API: Returns all databases the token has access to. Optionally filter by project ID. GET /v1/databases.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns databases for the given project.
url: /management-api/endpoints/databases/get-projects-id-databases
metaTitle: 'GET /v1/projects/{projectId}/databases | Get list of databases - Prisma Postgres'
metaDescription: 'Management API: Returns databases for the given project. GET /v1/projects/{projectId}/databases.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
{
"title": "Databases",
"pages": [
"get-projects-id-databases",
"get-databases",
"get-databases-id",
"post-databases",
"post-projects-id-databases",
"get-projects-id-databases",
"patch-databases-id",
"delete-databases-id"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Updates the database with the given ID.
url: /management-api/endpoints/databases/patch-databases-id
metaTitle: 'PATCH /v1/databases/{databaseId} | Update database - Prisma Postgres'
metaDescription: 'Management API: Updates the database with the given ID. PATCH /v1/databases/{databaseId}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Creates a new database in the specified project.
url: /management-api/endpoints/databases/post-databases
metaTitle: 'POST /v1/databases | Create database - Prisma Postgres'
metaDescription: 'Management API: Creates a new database in the specified project. POST /v1/databases.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Creates a new database for the given project.
url: /management-api/endpoints/databases/post-projects-id-databases
metaTitle: 'POST /v1/projects/{projectId}/databases | Create database - Prisma Postgres'
metaDescription: 'Management API: Creates a new database for the given project. POST /v1/projects/{projectId}/databases.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Revokes the integration tokens by integration ID.
url: /management-api/endpoints/integrations/delete-integrations-by-id
metaTitle: 'DELETE /v1/integrations/{id} | Delete integration - Prisma Postgres'
metaDescription: 'Management API: Revokes the integration tokens by integration ID. DELETE /v1/integrations/{id}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Revokes the integration tokens with the given client ID.
url: /management-api/endpoints/integrations/delete-workspaces-id-integrations-id
metaTitle: 'DELETE /v1/workspaces/{workspaceId}/integrations/{clientId} | Revoke integration tokens - Prisma Postgres'
metaDescription: 'Management API: Revokes the integration tokens with the given client ID. DELETE /v1/workspaces/{workspaceId}/integrations/{clientId}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Get integration by ID
full: true
_openapi:
path: "/v1/integrations/{id}"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns a single integration by its ID.
url: /management-api/endpoints/integrations/get-integrations-by-id
metaTitle: 'GET /v1/integrations/{id} | Get integration by ID - Prisma Postgres'
metaDescription: 'Management API: Returns a single integration by its ID. GET /v1/integrations/{id}.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns a single integration by its ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/integrations/{id}","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
---
title: Get integration by ID
title: Get list of integrations
full: true
_openapi:
path: "/v1/integrations/{id}"
path: "/v1/integrations"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns a single integration by its ID.
- content: Returns integrations filtered by workspace ID.
url: /management-api/endpoints/integrations/get-integrations
metaTitle: 'GET /v1/integrations | Get list of integrations - Prisma Postgres'
metaDescription: 'Management API: Returns integrations filtered by workspace ID. GET /v1/integrations.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Returns a single integration by its ID.
Returns integrations filtered by workspace ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/integrations/{id}","method":"get"}]} />"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/integrations","method":"get"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns integrations for the given workspace.
url: /management-api/endpoints/integrations/get-workspaces-id-integrations
metaTitle: 'GET /v1/workspaces/{workspaceId}/integrations | Get list of integrations - Prisma Postgres'
metaDescription: 'Management API: Returns integrations for the given workspace. GET /v1/workspaces/{workspaceId}/integrations.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"title": "Integrations",
"pages": ["get-workspaces-id-integrations", "delete-workspaces-id-integrations-id"]
"pages": [
"get-integrations",
"get-integrations-by-id",
"delete-integrations-by-id",
"get-workspaces-id-integrations",
"delete-workspaces-id-integrations-id"
]
}
2 changes: 2 additions & 0 deletions apps/docs/content/docs/management-api/endpoints/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
"title": "Endpoints",
"defaultOpen": true,
"pages": [
"connections",
"databases",
"database-backups",
"database-usage",
"databases-connections",
"integrations",
"projects",
"regions",
"workspaces",
"misc"
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ _openapi:
headings: []
contents:
- content: Returns all available regions for Prisma Accelerate.
url: /management-api/endpoints/misc/get-regions-accelerate
metaTitle: 'GET /v1/regions/accelerate | Get Prisma Accelerate regions - Prisma Postgres'
metaDescription: 'Management API: Returns all available regions for Prisma Accelerate. GET /v1/regions/accelerate.'
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Expand Down
Loading
Loading