swaggerOptions.js

const swaggerDefinition = {
  openapi: "3.0.0",
  info: {
    title: "Portfolio API",
    version: "1.0.0",
    description: "API for managing portfolio projects and timeline entries",
  },
  servers: [
    {
      url: "http://localhost:3000",
      description: "Local server",
    },
  ],
};

const Project = {
  type: "object",
  properties: {
    _id: {
      type: "string",
      description: "The auto-generated ID of the project",
    },
    title: {
      type: "string",
      description: "The title of the project",
    },
    description: {
      type: "string",
      description: "The description of the project",
    },
    tags: {
      type: "array",
      items: {
        type: "string",
      },
      description: "List of tags associated with the project",
    },
    images: {
      type: "array",
      items: {
        type: "string",
      },
      description: "List of image URLs",
    },
    liveUrl: {
      type: "string",
      description: "URL to the live website",
    },
    sourceUrl: {
      type: "string",
      description: "URL to the source code",
    },
  },
};

const Timeline = {
  type: "object",
  properties: {
    _id: {
      type: "string",
      description: "The auto-generated ID of the timeline",
    },
    year: {
      type: "number",
      description: "The year of the timeline/milestone",
      default: "The current year",
    },
    timeline: {
      type: "string",
      description: "The title of the timeline",
    },
    duration: {
      type: "string",
      description: "The duration of the timeline",
    },
    details: {
      type: "string",
      description: "A detailed description of the timeline",
    },
  },
};

const components = {
  schemas: {
    Project,
    Timeline,
  },
};

const swaggerOptions = {
  swaggerDefinition,
  components,
  apis: ["./routes/project.route.js", "./routes/timeline.route.js"],
};

module.exports = swaggerOptions;