Fix Correctly handle class types like Time in documentation #79
Conversation
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
This commit fixes an issue where specifying a class like `Time` for the `type` option in `expose` documentation resulted in an error instead of generating the correct Swagger/OpenAPI specification. This functionality was working correctly in v0.5.5 but regressed after PR ruby-grape#75, leading to the following error: ``` GrapeSwagger::Errors::UnregisteredParser: No parser registered for Time. ``` The `primitive_type?` method now uses `GrapeSwagger::DocMethods::DataType.call` to resolve the type name before checking if it's a primitive type. This ensures that types like `Time` are correctly identified as strings with the `date-time` format, restoring the previous behavior.
dblock
approved these changes
Apr 29, 2025
|
@numbata thanks for reviewing this and your past contributions, want to help maintain this gem? make a release? drop me a note to dblock at dblock dot org with your rubygems account name if so |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR fixes an issue where specifying a class like
Timefor thetypeoption inexposedocumentation resulted in an error instead of generating the correct Swagger/OpenAPI specification.This functionality was working correctly in v0.5.5 but regressed after PR #75, leading to the following error:
The
primitive_type?method now usesGrapeSwagger::DocMethods::DataType.callto resolve the type name before checking if it's a primitive type.This ensures that types like
Timeare correctly identified as strings with thedate-timeformat, restoring the previous behavior.@numbata Could you please take a look at this PR when you have a chance?