Can we remove required parameters for request body?

[akira-19]

When I generate a document, parameters for request body are set as required.
Is there any way to set the parameters optional?
I would like to remove the following required section.

requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                param1:
                  type: boolean
                param2:
                  type: boolean
                param3:
                  type: boolean
              required:
              - param1
              - param2
              - param3

[exoego]

It is to add a test case that use only required parameters.

it `...` do
  # use all parameters
end

it `...` do
  # use only required parameters
end

Then, rspec-openapi exclude unused parameters from required

[akira-19]

@exoego Thank you. I want it to have no required field. I mean all parameters are optional.

it `...` do
  # use all parameters
end

it `...` do
  # use no parameters
end

I tried this, and it didn't work though what you showed worked.

[exoego]

Hmm, that is strange.
If a minimum reproduction is provided, I will look.

These tests correspond to this feature (automatic required generation for request body).

rspec-openapi/spec/requests/rails_smart_merge_spec.rb

Lines 65 to 92 in d8ea652

	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 'accepts nested object' do
	post '/users', headers: { authorization: 'k0kubun', 'Content-Type': 'application/json' }, params: {
	name: 'alice',
	foo: {
	bar: {
	baz: 42,
	},
	},
	}.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',
	avatar_url: 'https://example.com/avatar.png',
	}.to_json
	expect(response.status).to eq(201)
	end
	end

The below fixture illustrates the result. Always-specified parameters are included in required, others are not.
For this example, the top-level field name is required, and foo is not.

rspec-openapi/spec/rails/doc/smart/expected.yaml

Lines 399 to 419 in d8ea652

	PostUsersRequest:
	type: object
	properties:
	name:
	type: string
	avatar_url:
	type: string
	foo:
	type: object
	properties:
	bar:
	type: object
	properties:
	baz:
	type: integer
	required:
	- baz
	required:
	- bar
	required:
	- name

[akira-19]

@exoego Your example works, but it doesn't work when I try to make all the parameters optional like below.

it 'returns 201' do
  params = {
    param1: true,
    param2: true,
    param3: true
  }
  patch api_path, params: params, headers: token
  expect(response.status).to eq 201
end

it 'returns 201' do
  params = {}
  patch api_path, params: params, headers: token
  expect(response.status).to eq 201
end

[exoego]

@akira-19 This was fixed in #196 and landed in v0.16.0.

[akira-19]

@exoego Thank you!