Merge pull request #46 from blocknotes/fix-nested-uploaded-file-examples

Fix nested uploaded file examples
exoego · Mar 30, 2022 · b812c58 · b812c58
2 parents c6ef9dc + f4426c8
commit b812c58
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 9 deletions.
diff --git a/lib/rspec/openapi/schema_builder.rb b/lib/rspec/openapi/schema_builder.rb
@@ -158,9 +158,15 @@ def try_cast(value)
   def build_example(value)
     return nil if value.nil?
     value = value.dup
+    adjust_params(value)
+  end
+
+  def adjust_params(value)
     value.each do |key, v|
       if v.is_a?(ActionDispatch::Http::UploadedFile)
         value[key] = v.original_filename
+      elsif v.is_a?(Hash)
+        adjust_params(v)
       end
     end
   end

diff --git a/spec/rails/doc/openapi.json b/spec/rails/doc/openapi.json
@@ -390,14 +390,25 @@
               "schema": {
                 "type": "object",
                 "properties": {
-                  "image": {
-                    "type": "string",
-                    "format": "binary"
+                  "nested": {
+                    "type": "object",
+                    "properties": {
+                      "image": {
+                        "type": "string",
+                        "format": "binary"
+                      },
+                      "caption": {
+                        "type": "string"
+                      }
+                    }
                   }
                 }
               },
               "example": {
-                "image": "test.png"
+                "nested": {
+                  "image": "#<ActionDispatch::Http::UploadedFile:0x00007fa723dec4a8>",
+                  "caption": "Some caption"
+                }
               }
             }
           }

diff --git a/spec/rails/doc/openapi.yaml b/spec/rails/doc/openapi.yaml
@@ -261,11 +261,18 @@ paths:
             schema:
               type: object
               properties:
-                image:
-                  type: string
-                  format: binary
+                nested:
+                  type: object
+                  properties:
+                    image:
+                      type: string
+                      format: binary
+                    caption:
+                      type: string
             example:
-              image: test.png
+              nested:
+                image: test.png
+                caption: Some caption
       responses:
         '200':
           description: returns a table

diff --git a/spec/requests/rails_spec.rb b/spec/requests/rails_spec.rb
@@ -88,7 +88,9 @@
     end
     let(:image) { Rack::Test::UploadedFile.new('test.png', 'image/png') }
     it 'returns a table' do
-      patch '/tables/1', headers: { authorization: 'k0kubun' }, params: { image: image }
+      patch '/tables/1', headers: { authorization: 'k0kubun' }, params: {
+        nested: { image: image, caption: 'Some caption' }
+      }
       expect(response.status).to eq(200)
     end
   end