Skip to content

Commit 6f28ea7

Browse files
committed
Changelog: Separate change for openapi_first and openapi_first/test
1 parent e443762 commit 6f28ea7

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

CHANGELOG.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,50 @@
44

55
## 3.0.0
66

7-
### Changed
7+
### openapi_first
8+
9+
#### Changed
810
- Breaking: Trailing slashes are no longer ignored in dynamic paths. See [#403](https://github.com/ahx/openapi_first/issues/403).
911
Before this change `GET /things/24/` matched `/things/{id}:`, but it no longer does.
1012
- 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.
11-
- `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](https://github.com/ahx/openapi_first/issues/410).
12-
- `OpenapiFirst::Test` now falls back to using globally registered OADs if nothing was registered inside `OpenapiFirst::Test.setup`.
1313
- Deprecated configuration fields `request_validation_raise_error` and `response_validation_raise_error`. Please pass the `raise_error:` option to the middlewares directly.
14-
- 401er and 500er status are okay to not be described.
1514

16-
### Added
17-
- The Coverage feature in `OpenapiFirst::Test` now supports parallel tests via a DRB client/sever. Thanks to Richard! See [#394](https://github.com/ahx/openapi_first/issues/394).
18-
- Added `OpenapiFirst::Test` Configuration options which are useful when adopting OpenAPI:
19-
- `ignore_unknown_response_status = true` to make API coverage no longer complain about undefined response statuses it sees during a test run.
20-
- `minimum_coverage=` is no longer deprecated. This is useful when gradually adopting OpenAPI
21-
- `ignored_unknown_status=` to overwrite the whole list of ignored unknown status at once
15+
#### Added
2216
- Added support to register OADs globally via:
2317
```ruby
2418
OpenapiFirst.configure { |config| config.register('openapi.yaml') }
2519
```
2620
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.
2721

28-
### Removed
22+
#### Removed
2923
- Removed deprecated methods which produced a warning since 2.0.0.
30-
- Removed internally used `Test::Coverage.current_run, .plans, .install, .uninstall`. If you are using these, use `OpenapiFirst::Test.setup` instead.
3124
- Removed `OpenapiFirst::Configuration#clone`. Use `#child` instead.
3225
- It's no longer supported to remove locally added hooks during runtime.
3326

34-
### Fixed
27+
#### Fixed
3528
- Update dependency `openapi_parameters` to >= 0.7.0, because that version supports unpacking parameters the use `style: deepObject` with `explode: true`.
3629
- 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`.
3730

31+
### openapi_first/test
32+
33+
#### Changed
34+
- `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](https://github.com/ahx/openapi_first/issues/410).
35+
- `OpenapiFirst::Test` now falls back to using globally registered OADs if nothing was registered inside `OpenapiFirst::Test.setup`.
36+
- 401er and 500er status are okay to not be described.
37+
38+
#### Added
39+
- The Coverage feature in `OpenapiFirst::Test` now supports parallel tests via a DRB client/sever. Thanks to Richard! See [#394](https://github.com/ahx/openapi_first/issues/394).
40+
- Added `OpenapiFirst::Test` Configuration options which are useful when adopting OpenAPI:
41+
- `ignore_unknown_response_status = true` to make API coverage no longer complain about undefined response statuses it sees during a test run.
42+
- `minimum_coverage=` is no longer deprecated. This is useful when gradually adopting OpenAPI
43+
- `ignored_unknown_status=` to overwrite the whole list of ignored unknown status at once
44+
45+
#### Removed
46+
- Removed internally used `Test::Coverage.current_run, .plans, .install, .uninstall`. If you are using these, use `OpenapiFirst::Test.setup` instead.
47+
48+
#### Fixed
49+
- 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`.
50+
3851
## 2.11.1
3952

4053
- OpenapiFirst can now route requests correctly for paths like `/stuffs` and `/stuffs{format}` (https://github.com/ahx/openapi_first/issues/386)

0 commit comments

Comments
 (0)