Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

parameter[:getter] option #605

Merged
merged 2 commits into from
Mar 31, 2023
Merged

Conversation

pechorin
Copy link
Contributor

@pechorin pechorin commented Mar 7, 2023

Problem

Adopted pull request #436
Fix known issue: conflict with rspec default matchers include #188 (and also with status method)

Solution

Add support for :getter parameter option to explicitly define custom param getter method and avoid rspec conflicts with include matcher and status method

This concerns this parts of the OpenAPI Specification:

The changes I made are compatible with:

  • OAS2
  • OAS3
  • OAS3.1

Related Issues

#188

Checklist

  • Added tests
  • Changelog updated
  • Added documentation to README.md

Steps to Test or Reproduce

@pechorin
Copy link
Contributor Author

pechorin commented Mar 9, 2023

Hello @jtannas, can you please look at this PR? Maybe this is still worked solution for rswag?

@romanblanco romanblanco self-assigned this Mar 18, 2023
@romanblanco romanblanco added this to the Gem 2.X.0 milestone Mar 18, 2023
Copy link
Member

@romanblanco romanblanco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pechorin, thank you for continuing in @Zooip's effort!

Besides some minor typo fixes and adjustment, the changes look good 👍

Would you, please, also update test-app/ with an example of how to use the enhancement and include changes in OpenAPI spec?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
rswag-specs/spec/rswag/specs/request_factory_spec.rb Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
rswag-specs/lib/rswag/specs/swagger_formatter.rb Outdated Show resolved Hide resolved
@pechorin
Copy link
Contributor Author

Thanks for response, i will fix all issues within days!

@pechorin
Copy link
Contributor Author

@romanblanco thanks for cool review, can you check my fixes please? :)

Copy link
Member

@romanblanco romanblanco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Thank you for the contribution, @pechorin!

@romanblanco romanblanco merged commit 77759f0 into rswag:master Mar 31, 2023
@romanblanco romanblanco removed this from the Gem 2.10.0 milestone May 8, 2023
@romanblanco romanblanco mentioned this pull request Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants