Skip to content

Fix: Recognize Grape::API::Boolean as a primitive type #82

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 9, 2025
Merged

Fix: Recognize Grape::API::Boolean as a primitive type #82

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa54c3d
Fix: Handle Boolean type as a primitive in attribute parser
numbata May 7, 2025
978ddea
Let rubocop be happy
numbata May 7, 2025
686d9a4
Update CHANGELOG
numbata May 7, 2025
2b31730
Rely on request primitive check from GrapeSwagger
numbata May 8, 2025
fa7f11a
Update CHANGELOG.md file
numbata May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#### Fixes

* Your contribution here.
* [#82](https://github.com/ruby-grape/grape-swagger-entity/pull/82): Fix: recognize grape::api::boolean as a primitive type - [@numbata](https://github.com/numbata).

### 0.6.1 (2025/05/06)

Expand Down
2 changes: 1 addition & 1 deletion lib/grape-swagger/entity/attribute_parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ class AttributeParser
attr_reader :endpoint

# The list of that doesn't handled by `GrapeSwagger::DocMethods::DataType.primitive?` method
ADDITIONAL_PRIMITIVE_TYPES = %w[string array].freeze
ADDITIONAL_PRIMITIVE_TYPES = %w[boolean string array].freeze

def initialize(endpoint)
@endpoint = endpoint
Expand Down
18 changes: 18 additions & 0 deletions spec/grape-swagger/entity/attribute_parser_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,24 @@ def self.to_s
it { is_expected.not_to include('$ref') }
end

context 'when it is exposed as a Boolean class' do
let(:entity_options) do
{ documentation: { type: Grape::API::Boolean, example: example_value, default: example_value } }
end

context 'when the example value is true' do
let(:example_value) { true }

it { is_expected.to include(type: 'boolean', example: example_value, default: example_value) }
end

context 'when the example value is false' do
let(:example_value) { false }

it { is_expected.to include(type: 'boolean', example: example_value, default: example_value) }
end
end

context 'when it is exposed as a boolean' do
let(:entity_options) { { documentation: { type: 'boolean', example: example_value, default: example_value } } }

Expand Down