Skip to content

feat: updated again swagger related #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anuragsahu-dev merged 1 commit into from
Dec 27, 2025
Merged

feat: updated again swagger related #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions src/swagger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { config } from "./config/config";
import path from "node:path";

const isProduction = config.server.nodeEnv === "production";
const basePath = isProduction ? path.join(__dirname, "./routes/*.js") : path.join(__dirname, "./routes/*.ts");
const basePath = isProduction
? path.join(__dirname, "./routes/*.js")
: path.join(__dirname, "./routes/*.ts");

const options: swaggerJsdoc.Options = {
definition: {
Expand All @@ -24,7 +26,11 @@ const options: swaggerJsdoc.Options = {
{
url: "/api/v1",
description: "API v1",
}
},
{
url: "/",
description: "Root (for Health endpoints)",
},
],
components: {
securitySchemes: {
Expand All @@ -43,13 +49,15 @@ const options: swaggerJsdoc.Options = {
{ name: "Notes", description: "Project notes management" },
{ name: "Media", description: "File upload operations" },
{ name: "System", description: "System administration" },
{ name: "Health", description: "Health check endpoints" },
{
name: "Health",
description:
"Health check endpoints for monitoring and orchestration. **Note:** Use the '/' (Root) server for these endpoints. Includes liveness probes (`/health`, `/health/live`) for Docker/Kubernetes, readiness probes (`/health/ready`) to verify DB & Redis connectivity, and admin diagnostics (`/health/admin` - requires authentication).",
},
],
},
// Path to the API routes files where JSDoc comments are
apis: [
basePath,
],
apis: [basePath],
};

// Lazy initialization - only generate when first accessed
Expand Down
Loading