Fix OpenAPI Route Parameter Handling in Pode #1454
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This pull request addresses issue #1450, where routes containing parameters (e.g.,
/api/users/:userId
) were not correctly added to the OpenAPI Routes list in Pode. This fix adjusts the code to properly recognize and add parameterized routes, ensuring they appear in the generated OpenAPI documentation.Fix Details:
The modification was made in
public/Route.ps1
at line 455.Original Code:
Updated Code:
Issue and Solution Explanation:
The previous implementation checked and added the
$OpenApiPath
variable, which did not correctly account for routes with parameters, such as/api/users/:userId
. By updating the condition to check and add$Path
instead of$OpenApiPath
, parameterized routes are now accurately identified and included in theRoutes
collection within Pode’s OpenAPI configuration.Testing and Validation: