<?php

namespace App\Swagger\v1;

/**
 * @OA\Tag(
 *   name="Design Audit",
 *   description="Design-time audit logs"
 * )
 */
class AuditLogApi
{
    /**
     * @OA\Get(
     *   path="/api/v1/design/audit-logs",
     *   tags={"Design Audit"},
     *   summary="List audit logs",
     *   security={{"ApiKeyAuth": {}, "BearerAuth": {}}},
     *
     *   @OA\Parameter(name="page", in="query", @OA\Schema(type="integer", minimum=1)),
     *   @OA\Parameter(name="size", in="query", @OA\Schema(type="integer", minimum=1, maximum=200)),
     *   @OA\Parameter(name="target_type", in="query", @OA\Schema(type="string")),
     *   @OA\Parameter(name="target_id", in="query", @OA\Schema(type="integer")),
     *   @OA\Parameter(name="action", in="query", @OA\Schema(type="string")),
     *   @OA\Parameter(name="actor_id", in="query", @OA\Schema(type="integer")),
     *   @OA\Parameter(name="from", in="query", @OA\Schema(type="string", format="date-time")),
     *   @OA\Parameter(name="to", in="query", @OA\Schema(type="string", format="date-time")),
     *
     *   @OA\Response(
     *     response=200,
     *     description="List",
     *
     *     @OA\JsonContent(
     *       type="object",
     *
     *       @OA\Property(property="success", type="boolean"),
     *       @OA\Property(property="message", type="string"),
     *       @OA\Property(property="data", type="object",
     *         @OA\Property(property="current_page", type="integer"),
     *         @OA\Property(property="data", type="array", @OA\Items(type="object",
     *           @OA\Property(property="tenant_id", type="integer"),
     *           @OA\Property(property="target_type", type="string"),
     *           @OA\Property(property="target_id", type="integer", nullable=true),
     *           @OA\Property(property="action", type="string"),
     *           @OA\Property(property="before", type="object", nullable=true),
     *           @OA\Property(property="after", type="object", nullable=true),
     *           @OA\Property(property="actor_id", type="integer", nullable=true),
     *           @OA\Property(property="ip", type="string", nullable=true),
     *           @OA\Property(property="ua", type="string", nullable=true),
     *           @OA\Property(property="created_at", type="string", format="date-time")
     *         ))
     *       )
     *     )
     *   )
     * )
     */
    public function docs() {}
}
