mirror of
https://github.com/Dokploy/website.git
synced 2026-07-06 22:45:26 +02:00
feat: update API documentation and OpenAPI integration
- Refactored API documentation generation to utilize the new `fumadocs-openapi` features, including improved error handling and output structure. - Replaced the Authorization security scheme with x-api-key for enhanced API key authentication. - Added new MDX files for various API endpoints, ensuring comprehensive documentation coverage. - Updated the OpenAPI specification to reflect the latest changes in security definitions and response schemas. - Enhanced the documentation generation script to streamline the process and ensure consistency.
This commit is contained in:
78
apps/docs-new/content/docs/api/postgres.mdx
Normal file
78
apps/docs-new/content/docs/api/postgres.mdx
Normal file
@@ -0,0 +1,78 @@
|
||||
---
|
||||
title: Postgres
|
||||
full: true
|
||||
_openapi:
|
||||
toc:
|
||||
- depth: 2
|
||||
title: Postgres create
|
||||
url: '#postgres-create'
|
||||
- depth: 2
|
||||
title: Postgres one
|
||||
url: '#postgres-one'
|
||||
- depth: 2
|
||||
title: Postgres start
|
||||
url: '#postgres-start'
|
||||
- depth: 2
|
||||
title: Postgres stop
|
||||
url: '#postgres-stop'
|
||||
- depth: 2
|
||||
title: Postgres save External Port
|
||||
url: '#postgres-save-external-port'
|
||||
- depth: 2
|
||||
title: Postgres deploy
|
||||
url: '#postgres-deploy'
|
||||
- depth: 2
|
||||
title: Postgres change Status
|
||||
url: '#postgres-change-status'
|
||||
- depth: 2
|
||||
title: Postgres remove
|
||||
url: '#postgres-remove'
|
||||
- depth: 2
|
||||
title: Postgres save Environment
|
||||
url: '#postgres-save-environment'
|
||||
- depth: 2
|
||||
title: Postgres reload
|
||||
url: '#postgres-reload'
|
||||
- depth: 2
|
||||
title: Postgres update
|
||||
url: '#postgres-update'
|
||||
- depth: 2
|
||||
title: Postgres move
|
||||
url: '#postgres-move'
|
||||
- depth: 2
|
||||
title: Postgres rebuild
|
||||
url: '#postgres-rebuild'
|
||||
structuredData:
|
||||
headings:
|
||||
- content: Postgres create
|
||||
id: postgres-create
|
||||
- content: Postgres one
|
||||
id: postgres-one
|
||||
- content: Postgres start
|
||||
id: postgres-start
|
||||
- content: Postgres stop
|
||||
id: postgres-stop
|
||||
- content: Postgres save External Port
|
||||
id: postgres-save-external-port
|
||||
- content: Postgres deploy
|
||||
id: postgres-deploy
|
||||
- content: Postgres change Status
|
||||
id: postgres-change-status
|
||||
- content: Postgres remove
|
||||
id: postgres-remove
|
||||
- content: Postgres save Environment
|
||||
id: postgres-save-environment
|
||||
- content: Postgres reload
|
||||
id: postgres-reload
|
||||
- content: Postgres update
|
||||
id: postgres-update
|
||||
- content: Postgres move
|
||||
id: postgres-move
|
||||
- content: Postgres rebuild
|
||||
id: postgres-rebuild
|
||||
contents: []
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
<APIPage document={"./public/openapi.json"} webhooks={[]} operations={[{"path":"/postgres.create","method":"post"},{"path":"/postgres.one","method":"get"},{"path":"/postgres.start","method":"post"},{"path":"/postgres.stop","method":"post"},{"path":"/postgres.saveExternalPort","method":"post"},{"path":"/postgres.deploy","method":"post"},{"path":"/postgres.changeStatus","method":"post"},{"path":"/postgres.remove","method":"post"},{"path":"/postgres.saveEnvironment","method":"post"},{"path":"/postgres.reload","method":"post"},{"path":"/postgres.update","method":"post"},{"path":"/postgres.move","method":"post"},{"path":"/postgres.rebuild","method":"post"}]} showTitle={true} />
|
||||
Reference in New Issue
Block a user