mirror of
https://github.com/Dokploy/website.git
synced 2026-07-16 19:35:27 +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
148
apps/docs-new/content/docs/api/application.mdx
Normal file
148
apps/docs-new/content/docs/api/application.mdx
Normal file
@@ -0,0 +1,148 @@
|
||||
---
|
||||
title: Application
|
||||
full: true
|
||||
_openapi:
|
||||
toc:
|
||||
- depth: 2
|
||||
title: Application create
|
||||
url: '#application-create'
|
||||
- depth: 2
|
||||
title: Application one
|
||||
url: '#application-one'
|
||||
- depth: 2
|
||||
title: Application reload
|
||||
url: '#application-reload'
|
||||
- depth: 2
|
||||
title: Application delete
|
||||
url: '#application-delete'
|
||||
- depth: 2
|
||||
title: Application stop
|
||||
url: '#application-stop'
|
||||
- depth: 2
|
||||
title: Application start
|
||||
url: '#application-start'
|
||||
- depth: 2
|
||||
title: Application redeploy
|
||||
url: '#application-redeploy'
|
||||
- depth: 2
|
||||
title: Application save Environment
|
||||
url: '#application-save-environment'
|
||||
- depth: 2
|
||||
title: Application save Build Type
|
||||
url: '#application-save-build-type'
|
||||
- depth: 2
|
||||
title: Application save Github Provider
|
||||
url: '#application-save-github-provider'
|
||||
- depth: 2
|
||||
title: Application save Gitlab Provider
|
||||
url: '#application-save-gitlab-provider'
|
||||
- depth: 2
|
||||
title: Application save Bitbucket Provider
|
||||
url: '#application-save-bitbucket-provider'
|
||||
- depth: 2
|
||||
title: Application save Gitea Provider
|
||||
url: '#application-save-gitea-provider'
|
||||
- depth: 2
|
||||
title: Application save Docker Provider
|
||||
url: '#application-save-docker-provider'
|
||||
- depth: 2
|
||||
title: Application save Git Provider
|
||||
url: '#application-save-git-provider'
|
||||
- depth: 2
|
||||
title: Application disconnect Git Provider
|
||||
url: '#application-disconnect-git-provider'
|
||||
- depth: 2
|
||||
title: Application mark Running
|
||||
url: '#application-mark-running'
|
||||
- depth: 2
|
||||
title: Application update
|
||||
url: '#application-update'
|
||||
- depth: 2
|
||||
title: Application refresh Token
|
||||
url: '#application-refresh-token'
|
||||
- depth: 2
|
||||
title: Application deploy
|
||||
url: '#application-deploy'
|
||||
- depth: 2
|
||||
title: Application clean Queues
|
||||
url: '#application-clean-queues'
|
||||
- depth: 2
|
||||
title: Application kill Build
|
||||
url: '#application-kill-build'
|
||||
- depth: 2
|
||||
title: Application read Traefik Config
|
||||
url: '#application-read-traefik-config'
|
||||
- depth: 2
|
||||
title: Application update Traefik Config
|
||||
url: '#application-update-traefik-config'
|
||||
- depth: 2
|
||||
title: Application read App Monitoring
|
||||
url: '#application-read-app-monitoring'
|
||||
- depth: 2
|
||||
title: Application move
|
||||
url: '#application-move'
|
||||
- depth: 2
|
||||
title: Application cancel Deployment
|
||||
url: '#application-cancel-deployment'
|
||||
structuredData:
|
||||
headings:
|
||||
- content: Application create
|
||||
id: application-create
|
||||
- content: Application one
|
||||
id: application-one
|
||||
- content: Application reload
|
||||
id: application-reload
|
||||
- content: Application delete
|
||||
id: application-delete
|
||||
- content: Application stop
|
||||
id: application-stop
|
||||
- content: Application start
|
||||
id: application-start
|
||||
- content: Application redeploy
|
||||
id: application-redeploy
|
||||
- content: Application save Environment
|
||||
id: application-save-environment
|
||||
- content: Application save Build Type
|
||||
id: application-save-build-type
|
||||
- content: Application save Github Provider
|
||||
id: application-save-github-provider
|
||||
- content: Application save Gitlab Provider
|
||||
id: application-save-gitlab-provider
|
||||
- content: Application save Bitbucket Provider
|
||||
id: application-save-bitbucket-provider
|
||||
- content: Application save Gitea Provider
|
||||
id: application-save-gitea-provider
|
||||
- content: Application save Docker Provider
|
||||
id: application-save-docker-provider
|
||||
- content: Application save Git Provider
|
||||
id: application-save-git-provider
|
||||
- content: Application disconnect Git Provider
|
||||
id: application-disconnect-git-provider
|
||||
- content: Application mark Running
|
||||
id: application-mark-running
|
||||
- content: Application update
|
||||
id: application-update
|
||||
- content: Application refresh Token
|
||||
id: application-refresh-token
|
||||
- content: Application deploy
|
||||
id: application-deploy
|
||||
- content: Application clean Queues
|
||||
id: application-clean-queues
|
||||
- content: Application kill Build
|
||||
id: application-kill-build
|
||||
- content: Application read Traefik Config
|
||||
id: application-read-traefik-config
|
||||
- content: Application update Traefik Config
|
||||
id: application-update-traefik-config
|
||||
- content: Application read App Monitoring
|
||||
id: application-read-app-monitoring
|
||||
- content: Application move
|
||||
id: application-move
|
||||
- content: Application cancel Deployment
|
||||
id: application-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":"/application.create","method":"post"},{"path":"/application.one","method":"get"},{"path":"/application.reload","method":"post"},{"path":"/application.delete","method":"post"},{"path":"/application.stop","method":"post"},{"path":"/application.start","method":"post"},{"path":"/application.redeploy","method":"post"},{"path":"/application.saveEnvironment","method":"post"},{"path":"/application.saveBuildType","method":"post"},{"path":"/application.saveGithubProvider","method":"post"},{"path":"/application.saveGitlabProvider","method":"post"},{"path":"/application.saveBitbucketProvider","method":"post"},{"path":"/application.saveGiteaProvider","method":"post"},{"path":"/application.saveDockerProvider","method":"post"},{"path":"/application.saveGitProvider","method":"post"},{"path":"/application.disconnectGitProvider","method":"post"},{"path":"/application.markRunning","method":"post"},{"path":"/application.update","method":"post"},{"path":"/application.refreshToken","method":"post"},{"path":"/application.deploy","method":"post"},{"path":"/application.cleanQueues","method":"post"},{"path":"/application.killBuild","method":"post"},{"path":"/application.readTraefikConfig","method":"get"},{"path":"/application.updateTraefikConfig","method":"post"},{"path":"/application.readAppMonitoring","method":"get"},{"path":"/application.move","method":"post"},{"path":"/application.cancelDeployment","method":"post"}]} showTitle={true} />
|
||||
Reference in New Issue
Block a user