chore(deps): update dependency openapi_first to v3

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
openapi_first (changelog)	"~>2.0" → "~>3.0"

---

Release Notes

ahx/openapi_first (openapi_first)

v3.4.3

Compare Source

Fixed: Loading a document no longer raises NoMethodError: undefined method 'schema' for nil when a Media Type Object has no schema (e.g. it only declares an example). schema is optional in a Media Type Object; such media types now impose no body-schema constraint.

v3.4.2

Compare Source

Fixed: Parsing of JSON-formatted query params issue #​476 (thanks @​Drowze)

v3.4.1

Compare Source

Fixed: Added missing ERB and css file to the gem

v3.3.1

Compare Source

• Optimized caching towards reducing retained memory after calling OpenapiFirst.load without using a global cache. (Removed OpenapiFirst.clear_cache!.)
• Require ruby >= 3.3.0

v3.3.0

Compare Source

• OpenapiFirst will now cache the contents of files that have been loaded. If you need to reload your OpenAPI definition for tests or server hot reloading, you can call OpenapiFirst.clear_cache!.
• Optimized OpenapiFirst::Router#match for faster path matching and reduced memory allocation.

v3.2.1

Compare Source

• Don't raise UnknownQueryParameterError if request is ignored in tests. Fixes #​441.

v3.2.0

Changed

• Changed OpenapiFirst::Test to track the request after the app has handled the request. See PR #​434. You can restore the old behavior with

  include OpenapiFirst::Test::Methods[MyApp, validate_request_before_handling: true]

Added

• Added OpenapiFirst::ValidatedRequest#unknown? and OpenapiFirst::ValidatedResponse#unknown?
• Added new hook: after_response_body_property_validation
• Added support for a static path_prefix value to be set on the creation of a Definition. See PR #​432:

  OpenapiFirst.configure do |config|
    config.register('openapi/openapi.yaml' path_prefix: '/weather')
  end

• Added OpenapiFirst::Test::Configuration#ignore_response_error and #ignore_request_error to configure which request/response errors should not raise an error during testing:

  OpenapiFirst::Test.setup do |test|
    test.ignore_request_error do |validated_request|
      # Ignore unknown requests on certain paths
      validated_request.path.start_with?('/api/v1') && validated_request.unknown?
    end
    
    test.ignore_response_error do |validated_response, rack_request|
      # Ignore invalid response bodies on certain paths
      validated_request.path.start_with?('/api/legacy/stuff') && validated_request.error.type ==  :invalid_body      
    end
  end

v3.1.1

• Changed: Return uniqe errors in default error responses

v3.1.0

Compare Source

openapi_first/test

Changed

• OpenapiFirst::Test now raises OpenapiFirst::Test::UnknownQueryParameterError when it sees unknown query parameters. Note that OpenapiFirst ("core") still allows unknown query parameters.
• OpenapiFirst::Test does not track requests/responses unless the OAD was registered via OpenapiFirst::Test.register (or OpenapiFirst.register)

v3.0.1

Compare Source

• Add missing gem dependency "drb", which is no longer installed by default with newer rubies. This is used in openapi_first/test to make parallel tests work.

v3.0.0

Compare Source

openapi_first

Changed

• Breaking: Trailing slashes are no longer ignored in dynamic paths. See #​403.
  Before this change GET /things/24/ matched /things/{id}:, but it no longer does.
• Breaking: Failure type :response_not_found was split into two more specific types :response_content_type_not_found and :response_status_not_found. This should be mostly internal stuff. So if your custom error response used response_not_found, you will have to adapt.
• Deprecated configuration fields request_validation_raise_error and response_validation_raise_error. Please pass the raise_error: option to the middlewares directly.

Added

• Added support to register OADs globally via:

  OpenapiFirst.configure { |config| config.register('openapi.yaml')  }

  This makes the spec argument in middlewares optional and removes the necessity to load the OAD in the same place where you use the middlewares and adds a cache for parsed OADs.

Removed

• Removed deprecated methods which produced a warning since 2.0.0.
• Removed OpenapiFirst::Configuration#clone. Use #child instead.
• It's no longer supported to remove locally added hooks during runtime.

Fixed

• Update dependency openapi_parameters to >= 0.7.0, because that version supports unpacking parameters the use style: deepObject with explode: true.
• Make OpenapiFirst::Test.setup more robust by adding OpenapiFirst::Configuration#child so it does not matter if you load our OAD before callig OpenapiFirst::Test.setup.

openapi_first/test

Changed

• OpenapiFirst::Test.app now returns an instance of OpenapiFirst::Test::App, instead of Rack::Builer and delegates methods other than #call to the original app. This wrapper adds validated requests, responses to the rack env at env[OpenapiFirst::Test::REQUEST], env[OpenapiFirst::Test::RESPONSE]. This makes it possible to test Rails engines. Thanks to Josh! See #​410.
• OpenapiFirst::Test now falls back to using globally registered OADs if nothing was registered inside OpenapiFirst::Test.setup.
• 401er and 500er status are okay to not be described.

Added

• The Coverage feature in OpenapiFirst::Test now supports parallel tests via a DRB client/sever. Thanks to Richard! See #​394.
• Added OpenapiFirst::Test Configuration options which are useful when adopting OpenAPI:
  • ignore_unknown_response_status = true to make API coverage no longer complain about undefined response statuses it sees during a test run.
  • minimum_coverage= is no longer deprecated. This is useful when gradually adopting OpenAPI
• ignored_unknown_status= to overwrite the whole list of ignored unknown status at once

Removed

• Removed internally used Test::Coverage.current_run, .plans, .install, .uninstall. If you are using these, use OpenapiFirst::Test.setup instead.

Fixed

• Make OpenapiFirst::Test.setup more robust by adding OpenapiFirst::Configuration#child so it does not matter if you load our OAD before callig OpenapiFirst::Test.setup.

---

Configuration

📅 Schedule: (UTC)

• Branch creation
  • At any time (no schedule defined)
• Automerge
  • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.73%. Comparing base (b50d1c4) to head (1e38748).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #866      +/-   ##
==========================================
- Coverage   94.74%   94.73%   -0.02%     
==========================================
  Files         460      460              
  Lines       15800    15800              
==========================================
- Hits        14970    14968       -2     
- Misses        830      832       +2     

Flag	Coverage Δ
postgres	94.54% <ø> (-0.02%)	⬇️
sqlite	94.70% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.