From abc4fcf5447996012a98839a6649fc0376167aa8 Mon Sep 17 00:00:00 2001
From: Ron Rise <ron@siteworxpro.com>
Date: Mon, 1 Dec 2025 10:34:38 -0500
Subject: [PATCH] feat: add Swagger UI service to docker-compose and update
 OpenAPI annotations in controllers

---
 src/Api.php                                               | 6 +++---
 .../{SwaggerController.php => OpenApiController.php}      | 8 +++++++-
 2 files changed, 10 insertions(+), 4 deletions(-)
 rename src/Controllers/{SwaggerController.php => OpenApiController.php} (80%)

diff --git a/src/Api.php b/src/Api.php
index 77d81bd..99f7bdc 100644
--- a/src/Api.php
+++ b/src/Api.php
@@ -11,7 +11,7 @@ use League\Route\Router;
 use Nyholm\Psr7\Factory\Psr17Factory;
 use Siteworxpro\App\Controllers\HealthcheckController;
 use Siteworxpro\App\Controllers\IndexController;
-use Siteworxpro\App\Controllers\SwaggerController;
+use Siteworxpro\App\Controllers\OpenApiController;
 use Siteworxpro\App\Http\JsonResponseFactory;
 use Siteworxpro\App\Http\Middleware\CorsMiddleware;
 use Siteworxpro\App\Http\Middleware\JwtMiddleware;
@@ -74,8 +74,8 @@ class Api
         $this->router->get('/healthz', HealthcheckController::class . '::get');
 
         $this->router->group('/.well-known', function (RouteGroup $router) {
-            $router->get('/swagger.yaml', SwaggerController::class . '::get');
-            $router->get('/swagger.json', SwaggerController::class . '::get');
+            $router->get('/swagger.yaml', OpenApiController::class . '::get');
+            $router->get('/swagger.json', OpenApiController::class . '::get');
         });
 
         $this->router->middleware(new CorsMiddleware());
diff --git a/src/Controllers/SwaggerController.php b/src/Controllers/OpenApiController.php
similarity index 80%
rename from src/Controllers/SwaggerController.php
rename to src/Controllers/OpenApiController.php
index 0b03260..0fdeda9 100644
--- a/src/Controllers/SwaggerController.php
+++ b/src/Controllers/OpenApiController.php
@@ -9,8 +9,14 @@ use Nyholm\Psr7\ServerRequest;
 use OpenApi\Generator;
 use Psr\Http\Message\ResponseInterface;
 
-class SwaggerController extends Controller
+class OpenApiController extends Controller
 {
+    /**
+     * Handles the GET request to generate and return the OpenAPI specification.
+     *
+     * @param ServerRequest $request
+     * @return ResponseInterface
+     */
     public function get(ServerRequest $request): ResponseInterface
     {
         $openapi = new Generator()->generate([