mirror of
https://github.com/Dokploy/website.git
synced 2026-06-28 10:35:22 +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:
43
apps/docs-new/content/docs/api/github.mdx
Normal file
43
apps/docs-new/content/docs/api/github.mdx
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: Github
|
||||
full: true
|
||||
_openapi:
|
||||
toc:
|
||||
- depth: 2
|
||||
title: Github one
|
||||
url: '#github-one'
|
||||
- depth: 2
|
||||
title: Github get Github Repositories
|
||||
url: '#github-get-github-repositories'
|
||||
- depth: 2
|
||||
title: Github get Github Branches
|
||||
url: '#github-get-github-branches'
|
||||
- depth: 2
|
||||
title: Github github Providers
|
||||
url: '#github-github-providers'
|
||||
- depth: 2
|
||||
title: Github test Connection
|
||||
url: '#github-test-connection'
|
||||
- depth: 2
|
||||
title: Github update
|
||||
url: '#github-update'
|
||||
structuredData:
|
||||
headings:
|
||||
- content: Github one
|
||||
id: github-one
|
||||
- content: Github get Github Repositories
|
||||
id: github-get-github-repositories
|
||||
- content: Github get Github Branches
|
||||
id: github-get-github-branches
|
||||
- content: Github github Providers
|
||||
id: github-github-providers
|
||||
- content: Github test Connection
|
||||
id: github-test-connection
|
||||
- content: Github update
|
||||
id: github-update
|
||||
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":"/github.one","method":"get"},{"path":"/github.getGithubRepositories","method":"get"},{"path":"/github.getGithubBranches","method":"get"},{"path":"/github.githubProviders","method":"get"},{"path":"/github.testConnection","method":"post"},{"path":"/github.update","method":"post"}]} showTitle={true} />
|
||||
Reference in New Issue
Block a user