Additional properties override (#178)

Author: nicvw

lib/rspec/openapi/schema_merger.rb

@@ -42,7 +42,8 @@ def merge_schema!(base, spec)
         # parameters need to be merged as if `name` and `in` were the Hash keys.
         merge_arrays(base, key, value)
       else
-        base[key] = value
+        # do not ADD `properties` or `required` fields if `additionalProperties` field is present
+        base[key] = value unless base.key?('additionalProperties') && %w[properties required].include?(key)
       end
     end
     base

spec/integration_tests/rails_test.rb

@@ -245,3 +245,13 @@ class EngineExtraRoutesTest < ActionDispatch::IntegrationTest
     assert_response 200
   end
 end
+
+class AdditionalPropertiesTest < ActionDispatch::IntegrationTest
+  i_suck_and_my_tests_are_order_dependent!
+  openapi!
+
+  test 'returns some content' do
+    get '/additional_properties'
+    assert_response 200
+  end
+end

spec/rails/app/controllers/additional_properties_controller.rb

@@ -0,0 +1,13 @@
+class AdditionalPropertiesController < ApplicationController
+  def index
+    response = {
+      required_key: 'value',
+      variadic_key: {
+        gold: 1,
+        silver: 2,
+        bronze: 3
+      }
+    }
+    render json: response
+  end
+end

spec/rails/config/routes.rb

@@ -20,5 +20,7 @@
     get '/test_block' => ->(_env) { [200, { 'Content-Type' => 'text/plain' }, ['A TEST']] }
 
     get '/secret_items' => 'secret_items#index'
+
+    get '/additional_properties' => 'additional_properties#index'
   end
 end

spec/rails/doc/openapi.json

@@ -15,6 +15,49 @@
     }
   ],
   "paths": {
+    "/additional_properties": {
+      "get": {
+        "summary": "index",
+        "tags": [
+          "AdditionalProperty"
+        ],
+        "responses": {
+          "200": {
+            "description": "returns some content",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "required_key": {
+                      "type": "string"
+                    },
+                    "variadic_key": {
+                      "type": "object",
+                      "additionalProperties": {
+                        "type": "integer"
+                      }
+                    }
+                  },
+                  "required": [
+                    "required_key",
+                    "variadic_key"
+                  ]
+                },
+                "example": {
+                  "required_key": "value",
+                  "variadic_key": {
+                    "gold": 1,
+                    "silver": 2,
+                    "bronze": 3
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/images": {
       "get": {
         "summary": "index",

spec/rails/doc/openapi.yaml

@@ -14,6 +14,34 @@ info:
 servers:
 - url: http://localhost:3000
 paths:
+  "/additional_properties":
+    get:
+      summary: index
+      tags:
+      - AdditionalProperty
+      responses:
+        '200':
+          description: returns some content
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  required_key:
+                    type: string
+                  variadic_key:
+                    type: object
+                    additionalProperties:
+                      type: integer
+                required:
+                - required_key
+                - variadic_key
+              example:
+                required_key: value
+                variadic_key:
+                  gold: 1
+                  silver: 2
+                  bronze: 3
   "/images":
     get:
       summary: index

spec/requests/rails_spec.rb

@@ -246,3 +246,12 @@
     end
   end
 end
+
+RSpec.describe 'Additional Properties test', type: :request do
+  describe '#test' do
+    it 'returns some content' do
+      get '/additional_properties'
+      expect(response.status).to eq(200)
+    end
+  end
+end