rswag

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Changed

Update swagger-ui to 3.52.5

[2.4.0] - 2021-02-09

Added

Added SWAGGER_DRY_RUN env variable #274

[2.3.3] - 2021-02-07

Fixed

Include response examples #394

Changed

Update swagger-ui to 3.42.0

[2.3.2] - 2021-01-27

Added

RequestBody now supports the required flag #342

Fixed

Fix response example rendering #330
Fix empty content block #347

[2.3.1] - 2020-04-08

Fixed

Remove require for byebug #295

[2.3.0] - 2020-04-05

Added

Support for OpenAPI 3.0 ! #286
Custom headers in rswag-api #187
Allow document: false rspec metatag #255
Add parameterized pattern for spec files #254
Support Basic Auth on rswag-ui #167

Changed

Update swagger-ui version to 3.23.11 #239
Rails constraint moved from < 6.1 to < 7 #253
Swaggerize now outputs base RSpec text on completion to avoid silent failures #293
Update swagger-ui version to 3.28.0

[2.2.0] - 2019-11-01

Added

New swagger_format config option for setting YAML output #251

Changed

rswag-api will serve yaml files as yaml #251

[2.1.1] - 2019-10-18

Fixed

Fix incorrect require reference for swagger_generator #248

[2.1.0] - 2019-10-17

Added

New Spec Generator #75
Support for Options and Trace verbs; You must use a framework that supports this, for Options Rails 6.1+ Rails 6 does not support Trace. #237

Changed

Update swagger-ui to 3.18.2 #240

[2.0.6] - 2019-10-03

Added

Support for Rails 6 #228
Support for Windows paths #176

Changed

Show response body when error code is not expected #117

[2.0.5] - 2018-07-10