mirror of
https://github.com/Dokploy/website.git
synced 2026-07-17 11:55:32 +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:
Mauricio Siu
143
apps/docs-new/content/docs/api/compose.mdx
Normal file
143
apps/docs-new/content/docs/api/compose.mdx
Normal file
@@ -0,0 +1,143 @@
|
||||
---
|
||||
title: Compose
|
||||
full: true
|
||||
_openapi:
|
||||
toc:
|
||||
- depth: 2
|
||||
title: Compose create
|
||||
url: '#compose-create'
|
||||
- depth: 2
|
||||
title: Compose one
|
||||
url: '#compose-one'
|
||||
- depth: 2
|
||||
title: Compose update
|
||||
url: '#compose-update'
|
||||
- depth: 2
|
||||
title: Compose delete
|
||||
url: '#compose-delete'
|
||||
- depth: 2
|
||||
title: Compose clean Queues
|
||||
url: '#compose-clean-queues'
|
||||
- depth: 2
|
||||
title: Compose kill Build
|
||||
url: '#compose-kill-build'
|
||||
- depth: 2
|
||||
title: Compose load Services
|
||||
url: '#compose-load-services'
|
||||
- depth: 2
|
||||
title: Compose load Mounts By Service
|
||||
url: '#compose-load-mounts-by-service'
|
||||
- depth: 2
|
||||
title: Compose fetch Source Type
|
||||
url: '#compose-fetch-source-type'
|
||||
- depth: 2
|
||||
title: Compose randomize Compose
|
||||
url: '#compose-randomize-compose'
|
||||
- depth: 2
|
||||
title: Compose isolated Deployment
|
||||
url: '#compose-isolated-deployment'
|
||||
- depth: 2
|
||||
title: Compose get Converted Compose
|
||||
url: '#compose-get-converted-compose'
|
||||
- depth: 2
|
||||
title: Compose deploy
|
||||
url: '#compose-deploy'
|
||||
- depth: 2
|
||||
title: Compose redeploy
|
||||
url: '#compose-redeploy'
|
||||
- depth: 2
|
||||
title: Compose stop
|
||||
url: '#compose-stop'
|
||||
- depth: 2
|
||||
title: Compose start
|
||||
url: '#compose-start'
|
||||
- depth: 2
|
||||
title: Compose get Default Command
|
||||
url: '#compose-get-default-command'
|
||||
- depth: 2
|
||||
title: Compose refresh Token
|
||||
url: '#compose-refresh-token'
|
||||
- depth: 2
|
||||
title: Compose deploy Template
|
||||
url: '#compose-deploy-template'
|
||||
- depth: 2
|
||||
title: Compose templates
|
||||
url: '#compose-templates'
|
||||
- depth: 2
|
||||
title: Compose get Tags
|
||||
url: '#compose-get-tags'
|
||||
- depth: 2
|
||||
title: Compose disconnect Git Provider
|
||||
url: '#compose-disconnect-git-provider'
|
||||
- depth: 2
|
||||
title: Compose move
|
||||
url: '#compose-move'
|
||||
- depth: 2
|
||||
title: Compose process Template
|
||||
url: '#compose-process-template'
|
||||
- depth: 2
|
||||
title: Compose import
|
||||
url: '#compose-import'
|
||||
- depth: 2
|
||||
title: Compose cancel Deployment
|
||||
url: '#compose-cancel-deployment'
|
||||
structuredData:
|
||||
headings:
|
||||
- content: Compose create
|
||||
id: compose-create
|
||||
- content: Compose one
|
||||
id: compose-one
|
||||
- content: Compose update
|
||||
id: compose-update
|
||||
- content: Compose delete
|
||||
id: compose-delete
|
||||
- content: Compose clean Queues
|
||||
id: compose-clean-queues
|
||||
- content: Compose kill Build
|
||||
id: compose-kill-build
|
||||
- content: Compose load Services
|
||||
id: compose-load-services
|
||||
- content: Compose load Mounts By Service
|
||||
id: compose-load-mounts-by-service
|
||||
- content: Compose fetch Source Type
|
||||
id: compose-fetch-source-type
|
||||
- content: Compose randomize Compose
|
||||
id: compose-randomize-compose
|
||||
- content: Compose isolated Deployment
|
||||
id: compose-isolated-deployment
|
||||
- content: Compose get Converted Compose
|
||||
id: compose-get-converted-compose
|
||||
- content: Compose deploy
|
||||
id: compose-deploy
|
||||
- content: Compose redeploy
|
||||
id: compose-redeploy
|
||||
- content: Compose stop
|
||||
id: compose-stop
|
||||
- content: Compose start
|
||||
id: compose-start
|
||||
- content: Compose get Default Command
|
||||
id: compose-get-default-command
|
||||
- content: Compose refresh Token
|
||||
id: compose-refresh-token
|
||||
- content: Compose deploy Template
|
||||
id: compose-deploy-template
|
||||
- content: Compose templates
|
||||
id: compose-templates
|
||||
- content: Compose get Tags
|
||||
id: compose-get-tags
|
||||
- content: Compose disconnect Git Provider
|
||||
id: compose-disconnect-git-provider
|
||||
- content: Compose move
|
||||
id: compose-move
|
||||
- content: Compose process Template
|
||||
id: compose-process-template
|
||||
- content: Compose import
|
||||
id: compose-import
|
||||
- content: Compose cancel Deployment
|
||||
id: compose-cancel-deployment
|
||||
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":"/compose.create","method":"post"},{"path":"/compose.one","method":"get"},{"path":"/compose.update","method":"post"},{"path":"/compose.delete","method":"post"},{"path":"/compose.cleanQueues","method":"post"},{"path":"/compose.killBuild","method":"post"},{"path":"/compose.loadServices","method":"get"},{"path":"/compose.loadMountsByService","method":"get"},{"path":"/compose.fetchSourceType","method":"post"},{"path":"/compose.randomizeCompose","method":"post"},{"path":"/compose.isolatedDeployment","method":"post"},{"path":"/compose.getConvertedCompose","method":"get"},{"path":"/compose.deploy","method":"post"},{"path":"/compose.redeploy","method":"post"},{"path":"/compose.stop","method":"post"},{"path":"/compose.start","method":"post"},{"path":"/compose.getDefaultCommand","method":"get"},{"path":"/compose.refreshToken","method":"post"},{"path":"/compose.deployTemplate","method":"post"},{"path":"/compose.templates","method":"get"},{"path":"/compose.getTags","method":"get"},{"path":"/compose.disconnectGitProvider","method":"post"},{"path":"/compose.move","method":"post"},{"path":"/compose.processTemplate","method":"post"},{"path":"/compose.import","method":"post"},{"path":"/compose.cancelDeployment","method":"post"}]} showTitle={true} />
|
||||
Reference in New Issue
Block a user