Basic

import { defineConfig } from "adonis-open-swagger";

/**
 * Configuration for Open Swagger
 */
export default defineConfig({
  /**
   * Enable or disable swagger documentation
   */
  enabled: true,

  /**
   * Path where the documentation will be served
   */
  path: "/docs",

  /**
   * Schema validator to use for automatic schema conversion
   * Choose based on your preferred validation library
   */
  validator: "vinejs", // 'vinejs' | 'zod' | 'typebox'

  /**
   * OpenAPI specification information
   */
  info: {
    title: "VoiceOps",
    version: "1.0.0",
    description: "API documentation for VoiceOPS",
    contact: {
      name: "API Support",
      email: "support@example.com",
    },
    license: {
      name: "MIT",
      url: "https://opensource.org/licenses/MIT",
    },
  },

  /**
   * Servers configuration
   */
  servers: [
    {
      url: "http://localhost:3333",
      description: "Development server",
    },
  ],
});

export default defineConfig({
  // ... other config

  securitySchemes: {
    // Cookie Authentication (for session-based auth)
    cookieAuth: {
      type: "apiKey",
      in: "cookie",
      name: "session", // or 'JSESSIONID', 'auth_token', etc.
      description: "Session cookie for authentication",
    },

    // Bearer Token (JWT) Authentication
    bearerAuth: {
      type: "http",
      scheme: "bearer",
      bearerFormat: "JWT",
      description: "Enter your JWT token",
    },

    // API Key in Header
    apiKeyAuth: {
      type: "apiKey",
      in: "header",
      name: "X-API-Key",
      description: "API key passed in header",
    },

    // Basic Authentication
    basicAuth: {
      type: "http",
      scheme: "basic",
      description: "Basic HTTP authentication",
    },

    // OAuth2 Authentication
    oauth2Auth: {
      type: "oauth2",
      description: "OAuth2 authentication",
      flows: {
        authorizationCode: {
          authorizationUrl: "https://example.com/oauth/authorize",
          tokenUrl: "https://example.com/oauth/token",
          scopes: {
            "read:users": "Read user information",
            "write:users": "Modify user information",
          },
        },
      },
    },
  },

  // Global security (applied to all endpoints)
  security: [
    { cookieAuth: [] },
    // { bearerAuth: [] },
  ],
});