Support for hidden properties

Hidden property as boolean or proc

Author: onemanstartup

lib/grape-swagger/representable/parser.rb

@@ -104,6 +104,8 @@ def representer_mapping(representer, documentation, property, is_a_collection =
       def parse_representer(representer)
         properties = representer.map.each_with_object({}) do |value, property|
           property_name = value[:as].try(:call) || value.name
+          hidden_property = value[:documentation]&.[](:hidden)
+          next if hidden_property && (hidden_property.is_a?(Proc) ? hidden_property.call : hidden_property)
           property[property_name] = parse_representer_property(value)
         end
 

spec/grape-swagger/representers/response_representer_spec.rb

@@ -27,8 +27,13 @@ class Tag < Representable::Decorator
         class Error < Representable::Decorator
           include Representable::JSON
 
-          property :code, documentation: { type: 'string', desc: 'Error code' }
+          property :code, documentation: { type: 'string', hidden: -> { false }, desc: 'Error code' }
           property :message, documentation: { type: 'string', desc: 'Error message' }
+          property :developer_message, documentation: { type: 'string', hidden: -> { !developer? }, desc: 'Developer hidden error message' }
+
+          def self.developer?
+            false
+          end
         end
 
         class Something < Representable::Decorator
@@ -100,6 +105,17 @@ def app
     )
   end
 
+  it 'should document specified models with hidden property' do
+    allow(ThisApi::Representers::Error).to receive(:developer?).and_return(true)
+    expect(subject['definitions']['Error']).to eq(
+      'type' => 'object',
+      'description' => 'This returns something',
+      'properties' => { 'code' =>    { 'description' => 'Error code', 'type' => 'string' },
+                        'message' => { 'description' => 'Error message', 'type' => 'string' },
+                        'developer_message' => { 'description' => 'Developer hidden error message', 'type' => 'string' } }
+    )
+  end
+
   it 'should document specified models as show action' do
     expect(subject['paths']['/something/{id}']['get']['responses']).to eq(
       '200' => {