Disable 404 status on version endpoint; Add new description to version endpoint

Author: bjoern-hempel

docker-compose.override.yml

@@ -54,8 +54,6 @@
 #
 # ===========================================
 
-version: "3.8"
-
 # Configures the services
 services:
 

docker-compose.yml

@@ -54,8 +54,6 @@
 #
 # ===========================================
 
-version: "3.8"
-
 # Configures the services
 services:
 

src/ApiPlatform/Resource/Version.php

@@ -1,7 +1,5 @@
 <?php
 
-declare(strict_types=1);
-
 /*
  * This file is part of the ixnode/php-api-version-bundle project.
  *
@@ -11,6 +9,8 @@
  * file that was distributed with this source code.
  */
 
+declare(strict_types=1);
+
 namespace Ixnode\PhpApiVersionBundle\ApiPlatform\Resource;
 
 use ApiPlatform\Metadata\Get;
@@ -27,7 +27,20 @@
  */
 #[Get(
     openapiContext: [
-        'description' => VersionRoute::DESCRIPTION
+        'summary' => VersionRoute::SUMMARY_GET,
+        'description' => VersionRoute::DESCRIPTION_GET,
+        'responses' => [
+            '200' => [
+                'description' => 'Version resource',
+                'content' => [
+                    'application/json' => [
+                        'schema' => [
+                            '$ref' => "#/components/schemas/Version"
+                        ]
+                    ]
+                ]
+            ]
+        ]
     ],
     provider: VersionProvider::class
 )]

src/ApiPlatform/Route/VersionRoute.php

@@ -26,5 +26,7 @@ final class VersionRoute extends BaseRoute
 {
     final public const PROPERTIES = [];
 
-    public const DESCRIPTION = "# Version resource\nRetrieves a Version resource.";
+    public const SUMMARY_GET = 'Retrieves a Version resource';
+
+    public const DESCRIPTION_GET = 'This endpoint is used to obtain the versions of this application.';
 }