Skip to content

Latest commit

 

History

History
221 lines (133 loc) · 8.03 KB

CHANGELOG.md

File metadata and controls

221 lines (133 loc) · 8.03 KB
Raw

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]

Added

  • Added option --spec_path to the generator command with requests as default value (rswag#607)
  • Add support for :getter parameter option to explicitly define custom parameter getter method and avoid RSpec conflicts with include matcher and status method (rswag#605)
  • Added support strict schema validation and allow to pass metadata to run_test! (rswag#604)

Changed

Fixed

  • Invalid URI error when specifying protocol within server configuration (rswag#591)
  • Fix ADDITIONAL_RSPEC_OPTS to always apply (rswag#584)

Documentation

  • Ask for dependency versions in issue template (rswag#575)

[2.8.0]

Added

  • Add support for nullable & required on header parameters (rswag#527)
  • Add option to set Host in header (rswag#570)
  • Add Support for Request body examples (rswag#555)

Changed

Fixed

  • Fix support for referenced parameter schema rswag#564)

Documentation

[2.7.0]

Added

  • Add tooling for measuring test coverage so that changes are safer (rswag#551)
  • Add CSP compatible with rswag in case the Rails one is not compatible (rswag#263)
  • Add ADDITIONAL_RSPEC_OPTS env variable (rswag#556)
  • Add option to set Host header (rswag#184)

Changed

  • Change default dev tooling setup to Ruby 2.7 and Rails 6 (rswag#542)
  • Make the development docker user non-root for easier volume sharing (rswag#550)
  • Update json-schema dependency version constraint (rswag#517)
  • Add deprecation notice for intent to drop support for Ruby 2.6 and RSpec 2 (rswag#552)

Fixed

  • Fix request body examples (rswag#555)
  • Corrected method name in README example (rswag#566)
  • Fix Style/SingleArgumentDig issue in swagger_formatter (rswag#486)
  • Make dependency on rspec-core explicit instead of implied (rswag#554)
  • Fix base path for OAS3 specification (rswag#547)
  • Fix ResponseValidator adding support for nullable and required headers (rswag#527)

Documentation

[2.6.0] - 2022-09-09

Added

  • Examples generated with run_test! now have the rspec tag rswag
  • Add query parameter serialization styles (OAS3) (rswag#507)
  • Support for adding descriptions in body params (rswag#422)
  • Display all validation errors instead of only the first (rswag#461)

Fixed

  • Fixes examples for OAS3 specification, allowing multiple examples (rswag#501)
  • Fix array parameter serialization on OAS3 (rswag#507)
  • Fix assorted spelling errors (rswag#535)
  • Fix null-checking when using a referenced property (rswag#515)

Changed

  • Rename generated rswag-ui.rb file to match Ruby style (rswag#508)
  • Code comment formatting changes (rswag#487)

Documentation

[2.5.1] - 2022-02-10

Fixed

  • Fixed missing assets in rswag-ui #493

[2.5.0] - 2022-02-08

Added

  • Update swagger-ui to 3.52.5 #453
  • Added specs print failed body #406
  • Added ability to specify multiple params in short form #300
  • REVERTS #300, help wanted! #407
  • Added better messages for missing lets #441
  • Added Rails 7.0 support #450

Fixed

  • Fixed allowed $refs in components #404

Documentation

  • Documents support for multiple tags #416
  • Documents libv8 troubleshooting #426

Development

  • Development - Replaces TheRubyRacer with mini_racer #442
  • Development - Migrate to GH Action for tests #475
  • Development - Test improvements#481

[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 meta-tag #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