openapi: 3.0.0
info:
  title: API de Proyectos y Auditorías
  version: 1.0.0
  description: |
    Documentación de la API desarrollada en Laravel.
    Contiene endpoints para gestionar **Projects** y listar **Audits**.

servers:
  - url: http://localhost:8000/api
    description: Servidor local (Laravel)

paths:

  /projects:
    get:
      summary: Listar proyectos
      description: Retorna todos los proyectos registrados.
      responses:
        '200':
          description: Lista de proyectos
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'

    post:
      summary: Crear un nuevo proyecto
      description: Registra un proyecto en la base de datos.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectCreate'
      responses:
        '201':
          description: Proyecto creado exitosamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'

  /projects/{id}:
    get:
      summary: Obtener un proyecto por ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Proyecto encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'

    put:
      summary: Actualizar un proyecto
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectUpdate'
      responses:
        '200':
          description: Proyecto actualizado

    delete:
      summary: Eliminar un proyecto
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '204':
          description: Proyecto eliminado correctamente

  /audits:
    get:
      summary: Listado de auditorías
      description: Devuelve todas las auditorías registradas en la aplicación.
      responses:
        '200':
          description: Lista de auditorías
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Audit'

components:

  schemas:

    Project:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time

    ProjectCreate:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        description:
          type: string

    ProjectUpdate:
      type: object
      properties:
        name:
          type: string
        description:
          type: string

    Audit:
      type: object
      properties:
        id:
          type: integer
        user_id:
          type: integer
        event:
          type: string
        auditable_type:
          type: string
        auditable_id:
          type: integer
        old_values:
          type: object
        new_values:
          type: object
        created_at:
          type: string
          format: date-time
