Fix Path<T> parameter generation for simple types in OpenAPI#21
Merged
Conversation
When using Path<T> with simple types like Uuid (e.g., Path(user_id): Path<Uuid>), the OpenAPI parameter was not being generated correctly because the implementation only handled structs with properties. This fix updates the Path<T> ParameterProvider implementation to handle both: 1. Structs with properties (existing behavior) 2. Simple types like Uuid, String, i32, etc. (new behavior) For simple types, it now extracts the parameter name from the URL pattern and generates the appropriate OpenAPI parameter. Added comprehensive tests to verify the fix works for: - Path<Uuid> (simple type) - Path<(Uuid,)> (tuple syntax) - Path<(Uuid, String)> (multiple parameters)
The example was mainly for verification purposes. The test suite in gotcha/tests/test_path_params.rs is sufficient to validate the fix.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
When using
Path<T>with simple types likeUuid(e.g.,Path(user_id): Path<Uuid>), the path parameter was not being included in the generated OpenAPI JSON.Solution
Updated the
Path<T>ParameterProvider implementation to handle both struct types with properties and simple types. For simple types, the implementation now extracts the parameter name from the URL pattern and generates the appropriate OpenAPI parameter.Testing
Added comprehensive tests covering:
Path<Uuid>(simple type)Path<(Uuid,)>(tuple syntax)Path<(Uuid, String)>(multiple parameters)All tests pass successfully.