Fix: Properly parse custom array documentation #86
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
- Reproduces "Empty model" error when using Grape::Entity with all hidden properties - Tests custom documentation override with Array[Object] type - Includes working example showing expected behavior - Follows existing issue spec patterns in the codebase
This commit addresses a long-standing issue where array types in documentation were not correctly parsed unless the explicit `is_array` option was used. The primary changes are: - A new `array_type?` method is introduced in `attribute_parser.rb` to intelligently check for `is_array`, `type: 'array'`, or `type: 'Array[Object]'`. - The `parse_grape_entity_params` method in `parser.rb` is refactored to improve readability and reduce complexity
Here's an example of a CHANGELOG.md entry: * [#86](https://github.com/ruby-grape/grape-swagger-entity/pull/86): Fix: properly parse custom array documentation - [@numbata](https://github.com/numbata).Generated by 🚫 Danger |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 addresses the issue where
grape-swagger-entitywas not correctly parsing custom array documentation (e.g.,type: 'Array[Object]'), leading to incorrect Swagger schema generation.The fix introduces a new
array_type?method that intelligently identifies various array notations (is_array,type: 'array', ortype: 'Array[Object]'). This ensures that the documentation override is correctly recognized and that the generated Swagger schema accurately reflects the intended type.Part of [#962](ruby-grape/grape-swagger#962)