Skip to content

Commit 51c1c71

Browse files
committed
improved swagger command descriptions
1 parent 7923f19 commit 51c1c71

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

app/commands/GenerateSwagger.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ class GenerateSwagger extends Command
1414
protected function configure()
1515
{
1616
$this->setName(self::$defaultName)->setDescription(
17-
'Generate a swagger specification file from existing code.'
17+
'Generate an OpenAPI documentation from the temporary file created by the swagger:annotate command.'
18+
. ' The temporary file is deleted afterwards.'
1819
);
1920
}
2021

app/commands/SwaggerAnnotator.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ class SwaggerAnnotator extends Command
2121

2222
protected function configure(): void
2323
{
24+
$filePath = self::$autogeneratedAnnotationFilePath;
2425
$this->setName(self::$defaultName)->setDescription(
25-
'Annotate all methods with Swagger PHP annotations.'
26+
"Extracts endpoint method annotations and puts them into a temporary file that can be used to generate"
27+
. " an OpenAPI documentation. The file is located at {$filePath}"
2628
);
2729
}
2830

0 commit comments

Comments
 (0)