Remove hidden attributes from required params (#87)

Addresses an issue where hidden attributes were incorrectly being marked as required
in the generated Swagger documentation. The main changes ensure that attributes
marked as hidden are excluded from the required fields list.

Author: bogdan

.rubocop_todo.yml

@@ -37,7 +37,7 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 117
+  Max: 120
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns.

CHANGELOG.md

@@ -7,6 +7,7 @@
 #### Fixes
 
 * Your contribution here.
+* [#87](https://github.com/ruby-grape/grape-swagger-entity/pull/87): Remove hidden attributes from required - [@bogdan](https://github.com/bogdan).
 * [#88](https://github.com/ruby-grape/grape-swagger-entity/pull/88): Update danger workflows - [@numbata](https://github.com/numbata).
 
 ### 0.7.0 (2025/08/02)

lib/grape-swagger/entity/parser.rb

@@ -136,8 +136,11 @@ def parse_nested(entity_name, entity_options, parent_model = nil)
 
       def required_params(params)
         params.each_with_object(Set.new) do |(key, options), accum|
-          required = if options.fetch(:documentation, {}).key?(:required)
-                       options.dig(:documentation, :required)
+          documentation = options.fetch(:documentation, {})
+          next if documentation[:hidden]
+
+          required = if documentation.key?(:required)
+                       documentation[:required]
                      else
                        !options.key?(:if) && !options.key?(:unless) && options[:expose_nil] != false
                      end

spec/grape-swagger/entities/response_model_spec.rb

@@ -67,8 +67,7 @@ def app
             'code' => { 'type' => 'string', 'description' => 'Error code' },
             'message' => { 'type' => 'string', 'description' => 'Error message' },
             'attr' => { 'type' => 'string', 'description' => 'Attribute' } },
-      'required' => %w[text colors hidden_attr created_at kind kind2 kind3 tags relation
-                       attr code message]
+      'required' => %w[text colors created_at kind kind2 kind3 tags relation attr code message]
     )
 
     expect(subject['definitions'].keys).to include 'ThisApi_Entities_Kind'

spec/grape-swagger/entity/parser_spec.rb

@@ -21,6 +21,10 @@
           expect(properties[:kind3]['$ref']).to eq('#/definitions/Kind')
         end
 
+        it 'does not mark hidden attributes as required' do
+          expect(required).not_to include(:hidden_attr)
+        end
+
         it 'merges attributes that have merge: true defined' do
           expect(properties[:merged_attribute]).to be_nil
           expect(properties[:code][:type]).to eq('string')