🔧 fix(HealthCheckController.php): rename 'version' key to 'app_versio…

…n' and add 'api_version' key to improve clarity and consistency in health check response 🔧 fix(ErrorResponse.php, SuccessResponse.php): rename 'version' property to 'app_version' and add 'api_version' property to match changes in HealthCheckController.php
VMGWARE · Jul 24, 2023 · 3686d2d · 3686d2d
1 parent 07dc956
commit 3686d2d
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/src/app/Http/Controllers/API/HealthCheckController.php b/src/app/Http/Controllers/API/HealthCheckController.php
@@ -48,7 +48,8 @@ public function index(): JsonResponse
             'data' => [
                 'uptime' => 'N/A', // TODO: Get uptime from 'uptime' command
                 'timestamp' => now()->toAtomString(),
-                'version' => config('app.version'),
+                'app_version' => config('app.version'),
+                'api_version' => 'v1',
                 'diskspace' => disk_free_space('/') / disk_total_space('/') * 100,
                 'latency' => round(microtime(true) - LARAVEL_START, 3),
                 'dependencies' => $dependencies

diff --git a/src/app/OpenApi/Responses/Utilities/HealthCheck/ErrorResponse.php b/src/app/OpenApi/Responses/Utilities/HealthCheck/ErrorResponse.php
@@ -19,7 +19,8 @@ public function build(): Response
             Schema::object('data')->properties(
                 Schema::string('uptime')->example('3 days 2 hours'),
                 Schema::string('timestamp')->example('2021-01-01 00:00:00'),
-                Schema::string('version')->example('1.0.0'),
+                Schema::string('app_version')->example('1.0.0'),
+                Schema::string('api_version')->example('v1'),
                 Schema::number('diskspace')->example(50.0),
                 Schema::number('latency')->example(0.123)
             ),

diff --git a/src/app/OpenApi/Responses/Utilities/HealthCheck/SuccessResponse.php b/src/app/OpenApi/Responses/Utilities/HealthCheck/SuccessResponse.php
@@ -19,7 +19,8 @@ public function build(): Response
             Schema::object('data')->properties(
                 Schema::string('uptime')->example('3 days 2 hours'),
                 Schema::string('timestamp')->example('2021-01-01 00:00:00'),
-                Schema::string('version')->example('1.0.0'),
+                Schema::string('app_version')->example('1.0.0'),
+                Schema::string('api_version')->example('v1'),
                 Schema::number('diskspace')->example(50.0),
                 Schema::number('latency')->example(0.123)
             ),