allow on the fly conversion between yaml/json openapi fmts

src/Controllers/AbstractService.php

@@ -6,32 +6,67 @@
 use Exception;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
+use Symfony\Component\Yaml\Yaml;
 
 abstract class AbstractService extends AbstractBlank
 {
 
+    /**
+     * Retrieves the OpenAPI specification file (JSON or YAML) from the specified cache directory.
+     * If the ?json query parameter is provided, converts the YAML content to JSON.
+     * If the ?yaml query parameter is provided, converts the JSON content to YAML.
+     * If multiple OpenAPI specs are specified, only the first (in the following order: `openapi.json`, `openapi.yaml`,
+     * `openapi.yml`) will be presented.
+     *
+     * @param Request $request The HTTP request object.
+     * @param Response $response The HTTP response object.
+     * @param array $args The request arguments.
+     * @return Response The response object with the OpenAPI specification content.
+     * @throws Exception If no OpenAPI specification file is found.
+     */
     public function getOpenapi(Request $request, Response $response, array $args = []): Response
     {
-        // Directory to look for paths
         $path = "{$this->settings['glued']['datapath']}/{$this->settings['glued']['uservice']}/cache";
-        $filesWhitelist = ["openapi.json", "openapi.yaml", "openapi.yml"]; // Potential file names
+        $filesWhitelist = ["openapi.json", "openapi.yaml", "openapi.yml"];
+        $convertToJson = $request->getQueryParams()['json'] ?? false;
+        $convertToYaml = $request->getQueryParams()['yaml'] ?? false;
 
         foreach ($filesWhitelist as $file) {
             $fullPath = rtrim($path, '/') . '/' . $file;
             if (file_exists($fullPath)) {
                 $content = file_get_contents($fullPath);
-                $response->getBody()->write($content);
-                $contentType = 'application/json';
-                if (pathinfo($fullPath, PATHINFO_EXTENSION) === 'yaml' || pathinfo($fullPath, PATHINFO_EXTENSION) === 'yml') {
+                $extension = pathinfo($fullPath, PATHINFO_EXTENSION);
+
+                if (($extension === 'yaml' || $extension === 'yml') && $convertToJson) {
+                    $content = json_encode(Yaml::parse($content));
+                    $contentType = 'application/json';
+                } elseif ($extension === 'json' && $convertToYaml) {
+                    $content = Yaml::dump(json_decode($content, true));
                     $contentType = 'application/x-yaml';
+                } else {
+                    $contentType = $extension === 'json' ? 'application/json' : 'application/x-yaml';
                 }
+
+                $response->getBody()->write($content);
                 return $response->withHeader('Content-Type', $contentType);
             }
         }
+
         throw new Exception("OpenAPI specification not found", 404);
     }
 
 
+    /**
+     * Checks the health status of the service, including database connection and authentication status.
+     *
+     * This function performs health checks on the service, including checking the PostgreSQL database connection
+     * and the authentication status, and returns the health status in a JSON response.
+     *
+     * @param Request $request The HTTP request object.
+     * @param Response $response The HTTP response object.
+     * @param array $args The request arguments.
+     * @return Response The response object with the health status in JSON format.
+     */
     public function getHealth(Request $request, Response $response, array $args = []): Response
     {
         try {
@@ -40,7 +75,7 @@ public function getHealth(Request $request, Response $response, array $args = []
             $check['healthy'] = true;
             $check['status']['postgres'] = $this->pg->query("select true as test")->fetch()['test'] ?? false;
             $check['status']['auth'] = $_SERVER['X-GLUED-AUTH-UUID'] ?? 'anonymous';
-        } catch (Exception $e) {
+        } catch (\Exception $e) {
             $check['healthy'] = false;
             return $response->withJson($check);
         }