Skip to content

Latest commit

 

History

History
497 lines (233 loc) · 22.3 KB

CHANGELOG.md

File metadata and controls

497 lines (233 loc) · 22.3 KB
Raw

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

5.0.0 (2023-05-22)

⚠ BREAKING CHANGES

  • Minimum required Node version is 16 now
  • Dropped the support of ajv-oai in favor of the official ajv-formats as ajv-oai is not maintained anymore and only supports [email protected]. This may cause different results when using type with formats.
  • The property dataPath in the validation errors has changed to instancePath and the type has changed from jsPropertySyntax to JSONPointer
  • Unknown formats do not result in a validation-error anymore but log a warning to the error-console. To suppress these log entries for specific formats, pass them with the --ignore-formats option
  • In the validation-errors, should was replaced with must

Features

  • support polymorphism with discriminators (#185) (d596631)

Bug Fixes

4.7.1 (2022-08-01)

Bug Fixes

  • fix "no-additional-properties" option, especially for OpenAPI v2 (#179) (65229c7)
  • upgrade dependencies (#180) (d94855d)

4.7.0 (2022-07-07)

Features

Bug Fixes

4.6.0 (2021-12-03)

Features

  • add date-time validator, according to RFC 3339 (#159) (7055763)

Bug Fixes

4.5.0 (2021-11-10)

Features

  • automatically push docker-images to Docker-Hub for new versions (#154) (1f225e6)

4.4.1 (2021-11-01)

Bug Fixes

4.4.0 (2021-05-28)

Features

  • add option to ignore (unknown) data type formats (#145) (1f1e353)

Bug Fixes

4.3.3 (2021-03-10)

Bug Fixes

  • upgrade dependencies (#138) (8c3493b)
  • remove outputting entire JSON in warning for using schema combiners (#136) (302cb89)

4.3.2 (2021-02-15)

Bug Fixes

  • log warning for all combiners, not only allOf, if additionalProperties-flag is set (#133) (70279f6)

4.3.1 (2021-02-10)

Bug Fixes

  • re-build module after release-job, to update version in build-artifact (99fc59a)

4.3.0 (2021-02-10)

Features

  • do not set noAdditionalProperties on schemas containing JSON schema combiners (#121) (14e01dc)

Bug Fixes

4.2.2 (2021-02-05)

Bug Fixes

  • detect examples with names that have to be escaped (#126) (40b8ea4)

4.2.1 (2021-01-18)

Bug Fixes

4.2.0 (2020-11-21)

Features

  • implement JSON schema draft-04 as default (#110) (94d6880)

Bug Fixes

4.1.1 (2020-10-01)

Bug Fixes

  • add docker-section in README.md (581ce88)

4.1.0 (2020-10-01)

Features

Bug Fixes

  • upgrade ajv-oai from 1.2.0 to 1.2.1 (#101) (8aa4ce4)
  • upgrade json-pointer from 0.6.0 to 0.6.1 (#100) (c8b48da)

4.0.1 (2020-09-15)

Bug Fixes

  • upgrade ajv from 6.12.3 to 6.12.4 (#98) (6052029)
  • upgrade ajv from 6.12.4 to 6.12.5 (#99) (fb8efd2)
  • upgrade json-schema-ref-parser from 9.0.3 to 9.0.5 (#94) (d4a11f3)
  • upgrade json-schema-ref-parser from 9.0.5 to 9.0.6 (#95) (452ca34)

4.0.0 (2020-07-14)

⚠ BREAKING CHANGES

  • The entry function validateExamples in src/index.js is async now

Features

  • support the option to disallow properties that have not been defined in the spec (#87) (c23ec9d)

Bug Fixes

  • upgrade dependencies (67293ad)
  • upgrade yaml from 1.9.2 to 1.10.0 (8a68137)
  • upgrade yaml from 1.9.2 to 1.10.0 (6dad1b8)

3.0.4 (2020-06-08)

Bug Fixes

  • don't recognize value-properties as examples (9457dbe)

3.0.3 (2020-05-19)

Bug Fixes

  • map yaml-parser errors to ApplicationErros (0737dd3)
  • upgrade dependencies (b86daee)

3.0.2 (2020-04-29)

Bug Fixes

  • fix statistics for schemasWithExamples over multiple mapping-files (d694cdf)

3.0.1 (2020-04-27)

Bug Fixes

  • fix statistics for schemasWithExamples (d68f07e)
  • upgrade dependencies (8c56445)

3.0.0 (2020-04-21)

⚠ BREAKING CHANGES

  • Raised minimal requirement of NodeJS to v10

Features

  • support dereferencing JSON Schema $ref pointers (fd85c20)

Bug Fixes

2.1.0 (2020-02-25)

Features

  • add formats int32, float and double to type number and format int64 to type string (9f5a6d9)
  • support example-property (3cf4167)
  • support nullable for input and output data types (c9ceb38)
  • support validation of example/examples in request (as parameters and requestBody) (cb5ca6e)

Bug Fixes

  • test all examples of a spec, not only the last one (e0a2dfc)
  • upgrade node-engine, in package.json (4e281d5)

2.0.1 (2019-11-28)

Bug Fixes

  • upgrade dependencies (fix-versions) (9e70981)
  • upgrade dependencies (minor-versions) (adf4039)
  • upgrade stryker-dependencies (75c6af8)

2.0.0 (2019-11-13)

⚠ BREAKING CHANGES

  • drop Node.js 6 support

Bug Fixes

  • fix CI-pipeline (2acd331)
  • increase mutation score (87ea53b)
  • update dependencies (patches and minor upgrades) (d5acecf)
  • package: update yaml to version 1.7.2 (bad4f89)

Features

  • add mutation-tests to CI-pipeline (91c038e)
  • add stryker-support for mutation-tests (12a2c80)
  • add YAML-support (c72266c)

1.1.2 (2019-08-26)

Bug Fixes

1.1.1 (2019-03-07)

Bug Fixes

  • rename project to openapi-examples-validator (6dc84d1)

1.1.0 (2019-03-03)

Features

  • add codeclimate-badge (402e9c3)
  • submit code coverage to codeclimate (962657b)
  • support internal references (2b9f626)
  • support OpenAPI v3 (de0ea5e)

1.0.0 (2018-10-09)

Bug Fixes

BREAKING CHANGES

  • dropping support for node version < 6

0.9.2 (2018-10-09)

Bug Fixes

  • revert upgrade dependencies and restore compatibility for node versions 4+ (8b310f9)

0.9.1 (2018-10-09)

Bug Fixes

  • fix wrong type of parameter (9116238)
  • upgrade dependencies (0103a7b)

0.9.0 (2018-02-26)

Features

  • support relative paths in mapping-files (21484c5)

0.8.0 (2018-02-23)

Features

  • support wildcards, when using mapping-files (46d7028)

0.7.0 (2018-02-22)

Features

  • improved error handling for missing files and wrong paths (796e018)

0.6.0 (2018-02-20)

Features

  • support validation of external examples (cbeaf7a)
  • support validation of multiple external examples, with a mapping-file (277475b)

0.5.2 (2018-02-16)

Bug Fixes

  • properly validate array-responses (9695e42)

0.5.1 (2017-02-19)

Bug Fixes

  • coveralls - add coverage-task in after_success as well (64145c1)

0.5.0 (2017-02-19)

Bug Fixes

  • wrong examplePath upon invalid examples (fe99ccf)

Features

0.4.0 (2017-02-02)

Features

  • add JSON-pointer to invalid example in error-output (7054fac)

0.3.2 (2017-01-16)

Reverts

  • fix: shrinkwrap dependencies (4f31e08)

0.3.1 (2017-01-16)

Bug Fixes

  • shrinkwrap dependencies (0adab60)

0.3.0 (2017-01-16)

Bug Fixes

  • print all errors of invalid example. fixes #1 (44b74c2)

Features

  • add simple statistics to validation output (da93a1a)

0.2.0 (2017-01-14)

Bug Fixes

Features