Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .github/workflows/sync-management-api-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:

- name: Generate docs
working-directory: apps/docs
run: pnpm tsx scripts/generate-docs.ts
run: pnpm run generate:management-api-docs

- name: Check for changes
id: changes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Delete connection
full: true
_openapi:
path: "/v1/connections/{id}"
method: DELETE
toc: []
structuredData:
headings: []
contents:
- content: Deletes the connection with the given ID.
path: '/v1/connections/{id}'
url: /management-api/endpoints/connections/delete-connections-by-id
metaTitle: 'DELETE /v1/connections/{id} | Delete connection'
metaDescription: 'Management API: Deletes the connection with the given ID.'
---

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

Deletes the connection with the given ID.

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

{/* 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
Expand Up @@ -2,17 +2,20 @@
title: Create connection
full: true
_openapi:
path: "/v1/connections"
method: POST
toc: []
structuredData:
headings: []
contents:
- content: Creates a new connection for the specified database.
path: /v1/connections
url: /management-api/endpoints/connections/post-connections
metaTitle: POST /v1/connections | Create connection
metaDescription: 'Management API: Creates a new connection for the specified database.'
---

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

Creates a new connection for the specified database.

<APIPage document={"management-api"} operations={[{"path":"/v1/connections","method":"post"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/connections","method":"post"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Get list of backups
full: true
_openapi:
path: "/v1/databases/{databaseId}/backups"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns backups for the specified database.
path: '/v1/databases/{databaseId}/backups'
url: /management-api/endpoints/database-backups/get-databases-by-database-id-backups
metaTitle: 'GET /v1/databases/{databaseId}/backups | Get list of backups'
metaDescription: 'Management API: Returns backups for the specified database.'
---

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

Returns backups for the specified database.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/backups","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/backups","method":"get"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Get database usage metrics
full: true
_openapi:
path: "/v1/databases/{databaseId}/usage"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns usage metrics for the specified database.
path: '/v1/databases/{databaseId}/usage'
url: /management-api/endpoints/database-usage/get-databases-by-database-id-usage
metaTitle: 'GET /v1/databases/{databaseId}/usage | Get database usage metrics'
metaDescription: 'Management API: Returns usage metrics for the specified database.'
---

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

Returns usage metrics for the specified database.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/usage","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/usage","method":"get"}]} />

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Get list of database connections
full: true
_openapi:
path: "/v1/databases/{databaseId}/connections"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns all connections for the given database.
path: '/v1/databases/{databaseId}/connections'
url: /management-api/endpoints/databases-connections/get-databases-by-database-id-connections
metaTitle: 'GET /v1/databases/{databaseId}/connections | Get list of database connections'
metaDescription: 'Management API: Returns all connections for the given database.'
---

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

Returns all connections for the given database.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/connections","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/connections","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"title": "Connections",
"pages": ["get-databases-id-connections", "post-databases-id-connections", "delete-connections"]
"pages": [
"get-databases-by-database-id-connections",
"post-databases-by-database-id-connections"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Create database connection string
full: true
_openapi:
path: "/v1/databases/{databaseId}/connections"
method: POST
toc: []
structuredData:
headings: []
contents:
- content: Creates a new connection string for the given database.
path: '/v1/databases/{databaseId}/connections'
url: /management-api/endpoints/databases-connections/post-databases-by-database-id-connections
metaTitle: 'POST /v1/databases/{databaseId}/connections | Create database connection string'
metaDescription: 'Management API: Creates a new connection string for the given database.'
---

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

Creates a new connection string for the given database.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/connections","method":"post"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}/connections","method":"post"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Delete database
full: true
_openapi:
path: "/v1/databases/{databaseId}"
method: DELETE
toc: []
structuredData:
headings: []
contents:
- content: Deletes the database with the given ID.
path: '/v1/databases/{databaseId}'
url: /management-api/endpoints/databases/delete-databases-by-database-id
metaTitle: 'DELETE /v1/databases/{databaseId} | Delete database'
metaDescription: 'Management API: Deletes the database with the given ID.'
---

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

Deletes the database with the given ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}","method":"delete"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}","method":"delete"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Get database
full: true
_openapi:
path: "/v1/databases/{databaseId}"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns the database with the given ID.
path: '/v1/databases/{databaseId}'
url: /management-api/endpoints/databases/get-databases-by-database-id
metaTitle: 'GET /v1/databases/{databaseId} | Get database'
metaDescription: 'Management API: Returns the database with the given 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 database with the given ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}","method":"get"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@
title: List databases
full: true
_openapi:
path: "/v1/databases"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: >-
Returns all databases the token has access to. Optionally filter by
project ID.
- content: Returns all databases the token has access to. Optionally filter by project ID.
path: /v1/databases
url: /management-api/endpoints/databases/get-databases
metaTitle: GET /v1/databases | List databases
metaDescription: 'Management API: Returns all databases the token has access to. Optionally filter by project 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 all databases the token has access to. Optionally filter by project ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases","method":"get"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Get list of databases
full: true
_openapi:
path: "/v1/projects/{projectId}/databases"
method: GET
toc: []
structuredData:
headings: []
contents:
- content: Returns databases for the given project.
path: '/v1/projects/{projectId}/databases'
url: /management-api/endpoints/databases/get-projects-by-project-id-databases
metaTitle: 'GET /v1/projects/{projectId}/databases | Get list of databases'
metaDescription: 'Management API: Returns databases for the given project.'
---

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

Returns databases for the given project.

<APIPage document={"management-api"} operations={[{"path":"/v1/projects/{projectId}/databases","method":"get"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/projects/{projectId}/databases","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"title": "Databases",
"pages": [
"get-projects-id-databases",
"get-databases-id",
"post-projects-id-databases",
"delete-databases-id"
"get-projects-by-project-id-databases",
"get-databases-by-database-id",
"post-projects-by-project-id-databases",
"delete-databases-by-database-id"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Update database
full: true
_openapi:
path: "/v1/databases/{databaseId}"
method: PATCH
toc: []
structuredData:
headings: []
contents:
- content: Updates the database with the given ID.
path: '/v1/databases/{databaseId}'
url: /management-api/endpoints/databases/patch-databases-by-database-id
metaTitle: 'PATCH /v1/databases/{databaseId} | Update database'
metaDescription: 'Management API: Updates the database with the given ID.'
---

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

Updates the database with the given ID.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}","method":"patch"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases/{databaseId}","method":"patch"}]} />
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
title: Create database
full: true
_openapi:
path: "/v1/databases"
method: POST
toc: []
structuredData:
headings: []
contents:
- content: Creates a new database in the specified project.
path: /v1/databases
url: /management-api/endpoints/databases/post-databases
metaTitle: POST /v1/databases | Create database
metaDescription: 'Management API: Creates a new database in the specified project.'
---

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

Creates a new database in the specified project.

<APIPage document={"management-api"} operations={[{"path":"/v1/databases","method":"post"}]} />
<APIPage document={"management-api"} operations={[{"path":"/v1/databases","method":"post"}]} />
Loading
Loading