Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom generator support to open api spec #912

Merged
merged 10 commits into from
Feb 3, 2025
Prev Previous commit
Next Next commit
fix phpdoc
olivernybroe committed Nov 11, 2024
commit f5d2523143156e112323621a71f8361f346976eb
2 changes: 2 additions & 0 deletions src/Writing/OpenApiSpecGenerators/OpenApiGenerator.php
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@ public function __construct(protected DocumentationConfig $config)
/**
* This section is the root of the OpenAPI document. It contains general info about the API.
*
* @param array $root
* @param array<int, array{description: string, name: string, endpoints: OutputEndpointData[]}> $groupedEndpoints
* @return array
* @see https://spec.openapis.org/oas/v3.1.1.html#openapi-object
@@ -39,6 +40,7 @@ public function root(array $root, array $groupedEndpoints): array
* This section is the individual path item object in an OpenApi document. It contains the details of the specific
* endpoint. This will be called for each individual endpoint, e.g. post, get, put, delete, etc.
*
* @param array $pathItem
* @param array<int, array{description: string, name: string, endpoints: OutputEndpointData[]}> $groupedEndpoints
* @param OutputEndpointData $endpoint
* @return array