Dokploy/website
1
0
Fork 0
mirror of https://github.com/Dokploy/website.git synced 2026-07-04 13:35:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: update API documentation and OpenAPI integration

Browse Source 
- 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
2025-12-07 06:05:00 -06:00
parent 55b254da6d
commit baaf062975
41 changed files with 2657 additions and 408 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
apps/docs-new/scripts/fix-openapi.mjs
View File

@@ -11,23 +11,64 @@ try {
let fixed = 0;
let securityFixed = false;
// Fix missing Authorization security scheme
// Remove Authorization security scheme and add x-api-key
if (!openapi.components) {
openapi.components = {};
}
if (!openapi.components.securitySchemes) {
openapi.components.securitySchemes = {};
}
if (!openapi.components.securitySchemes.Authorization) {
openapi.components.securitySchemes.Authorization = {
// Remove old Authorization scheme
if (openapi.components.securitySchemes['Authorization']) {
delete openapi.components.securitySchemes['Authorization'];
securityFixed = true;
}
// Add x-api-key scheme
if (!openapi.components.securitySchemes['x-api-key']) {
openapi.components.securitySchemes['x-api-key'] = {
type: 'apiKey',
in: 'header',
name: 'Authorization',
description: 'API key authentication using Authorization header'
name: 'x-api-key',
description: 'API key authentication. Use YOUR-GENERATED-API-KEY'
};
securityFixed = true;
}
// Replace global security from Authorization to x-api-key
if (openapi.security) {
openapi.security = openapi.security.filter(
sec => !sec['Authorization']
);
} else {
openapi.security = [];
}
const hasApiKeySecurity = openapi.security.some(
sec => sec['x-api-key']
);
if (!hasApiKeySecurity) {
openapi.security.push({ 'x-api-key': [] });
securityFixed = true;
}
// Replace Authorization with x-api-key in all operation security
for (const [path, pathItem] of Object.entries(openapi.paths || {})) {
for (const [method, operation] of Object.entries(pathItem)) {
if (operation && operation.security) {
// Replace Authorization with x-api-key
operation.security = operation.security.map(sec => {
if (sec['Authorization'] !== undefined) {
securityFixed = true;
return { 'x-api-key': [] };
}
return sec;
});
}
}
}
// Fix empty response schemas
for (const [path, pathItem] of Object.entries(openapi.paths || {})) {
for (const [method, operation] of Object.entries(pathItem)) {
@@ -54,7 +95,7 @@ try {
if (fixed > 0 || securityFixed) {
writeFileSync(openapiPath, JSON.stringify(openapi, null, 2));
if (fixed > 0) console.log(`✓ Fixed ${fixed} empty response schemas`);
if (securityFixed) console.log(`✓ Added missing Authorization security scheme`);
if (securityFixed) console.log("✓ Added x-api-key security scheme");
} else {
console.log('✓ No fixes needed');
}