-
Notifications
You must be signed in to change notification settings - Fork 892
fix(docs): fix management API docs generation and regenerate files #7593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kristof-siket
wants to merge
3
commits into
main
Choose a base branch
from
fix/generate-docs-frontmatter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
...ocs/content/docs/management-api/endpoints/connections/get-connections-by-id.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"}]} /> |
15 changes: 10 additions & 5 deletions
15
apps/docs/content/docs/management-api/endpoints/connections/get-connections.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"}]} /> |
9 changes: 9 additions & 0 deletions
9
apps/docs/content/docs/management-api/endpoints/connections/meta.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 0 additions & 21 deletions
21
...tent/docs/management-api/endpoints/databases-connections/delete-connections.mdx
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
apps/docs/content/docs/management-api/endpoints/databases-connections/meta.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 4 additions & 1 deletion
5
apps/docs/content/docs/management-api/endpoints/databases/meta.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
...s/content/docs/management-api/endpoints/integrations/get-integrations-by-id.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"}]} /> |
13 changes: 8 additions & 5 deletions
13
apps/docs/content/docs/management-api/endpoints/integrations/get-integrations.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"}]} /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 7 additions & 1 deletion
8
apps/docs/content/docs/management-api/endpoints/integrations/meta.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.