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",
    },
  ],
});