improved swagger command descriptions

ReCodEx · Dec 6, 2024 · 51c1c71 · 51c1c71
1 parent 7923f19
commit 51c1c71
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/app/commands/GenerateSwagger.php b/app/commands/GenerateSwagger.php
@@ -14,7 +14,8 @@ class GenerateSwagger extends Command
     protected function configure()
     {
         $this->setName(self::$defaultName)->setDescription(
-            'Generate a swagger specification file from existing code.'
+            'Generate an OpenAPI documentation from the temporary file created by the swagger:annotate command.'
+            . ' The temporary file is deleted afterwards.'
         );
     }
 

diff --git a/app/commands/SwaggerAnnotator.php b/app/commands/SwaggerAnnotator.php
@@ -21,8 +21,10 @@ class SwaggerAnnotator extends Command
 
     protected function configure(): void
     {
+        $filePath = self::$autogeneratedAnnotationFilePath;
         $this->setName(self::$defaultName)->setDescription(
-            'Annotate all methods with Swagger PHP annotations.'
+            "Extracts endpoint method annotations and puts them into a temporary file that can be used to generate"
+            . " an OpenAPI documentation. The file is located at {$filePath}"
         );
     }