Set "required" automatically for Request Body

lib/rspec/openapi/schema_builder.rb

@@ -39,6 +39,20 @@ def build(record)
 
   private
 
+  def enrich_with_required_keys(obj)
+    if obj.dig(:schema, :type) != 'object'
+      obj
+    else
+      # TODO: Nested object
+      required_keys = obj.dig(:schema, :properties)&.map do |key, value|
+        return nil if value[:nullable] == true
+        key
+      end.compact
+      obj[:schema][:required] = required_keys
+      obj
+    end
+  end
+
   def response_example(record, disposition:)
     return nil if !example_enabled? || disposition
 
@@ -113,10 +127,10 @@ def build_request_body(record)
 
     {
       content: {
-        normalize_content_type(record.request_content_type) => {
+        normalize_content_type(record.request_content_type) => enrich_with_required_keys({
           schema: build_property(record.request_params),
           example: (build_example(record.request_params) if example_enabled?),
-        }.compact,
+        }).compact,
       },
     }
   end

lib/rspec/openapi/schema_merger.rb

@@ -37,7 +37,11 @@ def merge_schema!(base, spec)
         if key == 'parameters'
           base[key] = value | base[key]
           base[key].uniq! { |param| param.slice('name', 'in') }
+        elsif key == 'required'
+          # Preserve properties that appears in all test cases
+          base[key] = value & base[key]
         else
+          # last one wins
           base[key] = value
         end
       else

spec/rails/app/controllers/users_controller.rb

@@ -4,7 +4,7 @@ def create
       name: params[:name],
       relations: {
         avatar: {
-          url: params[:avatar_url],
+          url: params[:avatar_url] || 'https://example.com/avatar.png',
         },
         pets: params[:pets] || [],
       },

spec/rails/doc/openapi.json

@@ -189,7 +189,12 @@
                   "database_id": {
                     "type": "integer"
                   }
-                }
+                },
+                "required": [
+                  "name",
+                  "description",
+                  "database_id"
+                ]
               },
               "example": {
                 "name": "k0kubun",
@@ -409,7 +414,10 @@
                       }
                     }
                   }
-                }
+                },
+                "required": [
+                  "nested"
+                ]
               },
               "example": {
                 "nested": {
@@ -569,7 +577,10 @@
                   "no_content": {
                     "type": "string"
                   }
-                }
+                },
+                "required": [
+                  "no_content"
+                ]
               },
               "example": {
                 "no_content": "true"

spec/rails/doc/smart/expected.yaml

@@ -149,6 +149,8 @@ paths:
                   type: string
                 avatar_url:
                   type: string
+              required:
+              - name
             example:
               name: alice
               avatar_url: "https://example.com/avatar.png"

spec/rails/doc/smart/openapi.yaml

@@ -222,6 +222,9 @@ paths:
                   type: array
                   items:
                     "$ref": "#/components/schemas/Pet"
+              required:
+                - name
+                - no-such-field
       responses:
         '201':
           description: returns a user

spec/requests/rails_smart_merge_spec.rb

@@ -61,6 +61,13 @@
 
 RSpec.describe 'Users', type: :request do
   describe '#create' do
+    it 'accepts missing avatar_url' do
+      post '/users', headers: { authorization: 'k0kubun', 'Content-Type': 'application/json' }, params: {
+        name: 'alice',
+      }.to_json
+      expect(response.status).to eq(201)
+    end
+
     it 'returns an user' do
       post '/users', headers: { authorization: 'k0kubun', 'Content-Type': 'application/json' }, params: {
         name: 'alice',

spec/roda/doc/openapi.json

@@ -20,7 +20,10 @@
                   "id": {
                     "type": "integer"
                   }
-                }
+                },
+                "required": [
+                  "id"
+                ]
               },
               "example": {
                 "id": 1