Skip to content

Commit b845c1e

Browse files
committed
Add docs to public method
1 parent ae0260c commit b845c1e

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

Generation/SpecGenerationService.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ public function __construct(AnnotationGenerator $annotationGenerator, SpecGenera
3333
$this->specGenerator = $specGenerator;
3434
}
3535

36+
/**
37+
* Generate an OpenAPI spec for one or more comma-separated plugin names.
38+
*
39+
* @param string $pluginNames Comma-separated plugin names to include in the generated spec.
40+
* @param string $format Output format for the spec, for example `json` or `yaml`.
41+
* @param string $version Version string written into the generated OpenAPI spec.
42+
* @param bool $writeToFile Whether the generated spec should also be written to the plugin tmp specs directory.
43+
* @param bool $addAnnotations Whether API annotations should be regenerated before building the spec.
44+
* @return string The generated OpenAPI spec contents.
45+
* @throws \RuntimeException If no non-empty plugin names are provided.
46+
*/
3647
public function generateSpecForPlugins(
3748
string $pluginNames,
3849
string $format = 'json',

0 commit comments

Comments
 (0)