mirror of
https://github.com/Dokploy/website.git
synced 2026-07-16 11:25: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:
58
apps/docs-new/content/docs/api/organization.mdx
Normal file
58
apps/docs-new/content/docs/api/organization.mdx
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Organization
|
||||
full: true
|
||||
_openapi:
|
||||
toc:
|
||||
- depth: 2
|
||||
title: Organization create
|
||||
url: '#organization-create'
|
||||
- depth: 2
|
||||
title: Organization all
|
||||
url: '#organization-all'
|
||||
- depth: 2
|
||||
title: Organization one
|
||||
url: '#organization-one'
|
||||
- depth: 2
|
||||
title: Organization update
|
||||
url: '#organization-update'
|
||||
- depth: 2
|
||||
title: Organization delete
|
||||
url: '#organization-delete'
|
||||
- depth: 2
|
||||
title: Organization all Invitations
|
||||
url: '#organization-all-invitations'
|
||||
- depth: 2
|
||||
title: Organization remove Invitation
|
||||
url: '#organization-remove-invitation'
|
||||
- depth: 2
|
||||
title: Organization update Member Role
|
||||
url: '#organization-update-member-role'
|
||||
- depth: 2
|
||||
title: Organization set Default
|
||||
url: '#organization-set-default'
|
||||
structuredData:
|
||||
headings:
|
||||
- content: Organization create
|
||||
id: organization-create
|
||||
- content: Organization all
|
||||
id: organization-all
|
||||
- content: Organization one
|
||||
id: organization-one
|
||||
- content: Organization update
|
||||
id: organization-update
|
||||
- content: Organization delete
|
||||
id: organization-delete
|
||||
- content: Organization all Invitations
|
||||
id: organization-all-invitations
|
||||
- content: Organization remove Invitation
|
||||
id: organization-remove-invitation
|
||||
- content: Organization update Member Role
|
||||
id: organization-update-member-role
|
||||
- content: Organization set Default
|
||||
id: organization-set-default
|
||||
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":"/organization.create","method":"post"},{"path":"/organization.all","method":"get"},{"path":"/organization.one","method":"get"},{"path":"/organization.update","method":"post"},{"path":"/organization.delete","method":"post"},{"path":"/organization.allInvitations","method":"get"},{"path":"/organization.removeInvitation","method":"post"},{"path":"/organization.updateMemberRole","method":"post"},{"path":"/organization.setDefault","method":"post"}]} showTitle={true} />
|
||||
Reference in New Issue
Block a user