Skip to content

Latest commit

 

History

History
890 lines (358 loc) · 34.7 KB

CHANGELOG.md

File metadata and controls

890 lines (358 loc) · 34.7 KB

14.4.0 (2024-10-08)

Features

  • add option to publish verification result to pact broker (3c4871d)
  • add support for formatted verification results (acbfc75)
  • Bearer token based auth for PactFlow Broker (f42f3ed)
  • support provider branch/tags on verification published (d644079)

14.3.0 (2024-10-04)

14.2.0 (2023-10-09)

Bug Fixes

  • handle type: "object" in schema composition (#47) (f9219ad)

14.1.0 (2023-08-21)

Bug Fixes

14.0.0 (2023-08-04)

Features

  • explicity set additionalProperties to false (82f2a3b)

13.3.0 (2023-07-28)

Bug Fixes

  • handle exclusiveMinimum/exclusiveMaximum in bodies (#37) (fd4dee0)

13.2.0 (2023-07-04)

Bug Fixes

  • incorrect decoding of pact v4 bodies (#33) (0a7f140)

Features

  • allow polymorphic inheritance in request bodies (#34) (beb128b)

13.1.0 (2023-06-30)

Features

  • improve support for allOf, anyOf, oneOf (#32) (8035cce)

13.0.0 (2023-06-28)

Features

  • upgrade Ajv from v6 to v8 (5a17818)

12.3.0 (2023-06-13)

Bug Fixes

  • handle validations for negative scenarios (39f99b8)

12.2.0 (2023-06-05)

Features

  • parse pact-v4 request/response bodies (#29) (bf22ab9)

12.1.0 (2023-05-24)

Bug Fixes

12.0.0 (2023-05-22)

Features

  • upgrade packages and move to ESM-only dist (#24) (b027afb)

11.5.0 (2023-05-12)

Features

  • handle more varieties of json (e59bcdf)

11.4.0 (2023-05-05)

Features

  • hide debug behind feature toggle (c692494)
  • log where validation passes when it should've failed (5691531)
  • Respect request and response content-types (5c86507)

11.3.1 (2023-03-20)

Bug Fixes

  • replace unmaintained dependency request for axios (merge from upstream) (af43f68)

11.3.0 (2022-07-07)

Bug Fixes

Features

  • add pact v4 e2e test (c6b6418)
  • filter requests by type to support v4 (923f241)
  • update pact parser to filter out all unsupported interaction types (343647d)
  • Update pact-parser.ts (a200bf0)

11.2.0 (2022-06-14)

11.1.0 (2022-06-14)

Bug Fixes

  • Convert pact spec 3 headers to v1 format (a0584b0)

11.0.0 (2022-04-22)

Features

  • Breaking change update default flags (#2) (b93d1a8)

BREAKING CHANGES

  • Will change default behaviour to no longer allow additional properties in response by default. Will go out as a major release

10.3.0 (2022-04-22)

Bug Fixes

  • support for open string-valued properties (178240e)

Features

10.2.1 (2022-04-20)

10.2.0 (2022-04-20)

10.1.4 (2022-04-20)

Bug Fixes

  • support for open string-valued properties (178240e)

Features

10.1.3 (2022-03-15)

Bug Fixes

  • do not warn if mock expects content-type in HEAD response and no mime type are defined in the spec (b6aabbc), closes #75

10.1.2 (2022-01-10)

10.1.1 (2021-06-08)

Bug Fixes

  • properly validate formats in root array items (6213a82), closes #92

10.1.0 (2021-02-23)

Features

  • support Pact v3 query format (5bf15c3)

10.0.1 (2021-02-17)

Bug Fixes

  • accept header should match mime-types of any operation responses for openapi 3 (4f0eb55), closes #87

10.0.0 (2020-11-03)

Bug Fixes

  • fix bug when both nullable and swagger custom formats are defined (ed4acf9)

chore

BREAKING CHANGES

  • Dropped support for NodeJS v6 and v8. Migrate to NodeJS v10 or above.

9.0.0 (2019-11-07)

Bug Fixes

  • correctly validate request bodies containing a JSON null or false value (79fae8c)

Features

  • support the nullable attribute for data types (d3c13cc)

BREAKING CHANGES

  • Prior to this change the tool used to succeed when a pact request specified a request body containing solely the JSON literals ‘null' or 'false’, regardless of what the spec accepted. Now, request bodies with such values will only pass validation if the spec is okay with them.

8.0.0 (2019-09-18)

Bug Fixes

  • do not fail if an OpenApi 3 spec defines an empty security requirement (f42ceb1)

BREAKING CHANGES

  • Prior to this change the tool used to fail when a pact request with no auth was validated against an OpenApi 3 operation containing a security requirement (e.g. basic auth) plus an empty security requirement (which is normally used to represent that auth is optional). Now empty security requirements are considered for OpenApi3 specs hence not failing when the request lacks auth attributes.

7.0.0 (2019-08-26)

Bug Fixes

  • do not fail if the spec defines unsupported security requirements (004729a)

BREAKING CHANGES

  • Prior to this change the tool used to fail when a pact request with no apparent auth was validated against a swagger operation containing security requirements both supported and unsupported by the tool (e.g. basic auth and OAuth2). Now if at least one unsupported security requirement is defined in the swagger operation the validation will pass. It is recommended that consumers and providers coordinate upgrading to this release so that both sides agree on what is considered valid vs invalid.

6.0.2 (2019-06-14)

6.0.1 (2019-02-27)

Bug Fixes

  • definitions no needed for parameter schema validation (4a693d6)

6.0.0 (2019-02-05)

Bug Fixes

  • skip request and response body validation when the content-type is unknown (d400a1e)

Features

  • add configurable object depth output to CLI (ecfa0c0)

BREAKING CHANGES

  • Prior to this change the tool used to fail when a pact response body was validated against an unsupported swagger mime type. Now when an unsupported mime type is encountered request body validation is skipped. It is recommended that consumers and providers coordinate upgrading to this release so that both sides agree on what is considered valid vs invalid.

5.2.1 (2018-10-02)

Bug Fixes

  • validate wildcards for media types, drop buggy support for media type parameters (602abbd)

5.2.0 (2018-09-13)

Features

  • support basic auth when using Pact Broker (be5e106), closes #72

5.1.0 (2018-09-06)

Features

  • support tagging when using Pact Broker (f2ca58b), closes #71

5.0.1 (2018-08-29)

Bug Fixes

  • pin swagger-parser to avoid breaking changes when validation logic is changed (ab6c04c)

5.0.0 (2018-08-23)

Bug Fixes

  • do not crash if path-item contains an ^x- property (d57f887)
  • fixed issue with format not being validated for bodies containing primitive values (dca4654)
  • use case-sensitive matching for query string parameters (f269cd9)

Chores

  • removed support for node version 4.x and added build test for node version 10.x (52c4963)

Features

  • add support for OpenApi 3 specs (19deb93)
  • removed swagger warnings from validation results (9a3b757)

BREAKING CHANGES

  • Removed support for node 4.x. Migrate to node 6.x or higher.
  • Prior to this change swagger-mock-validator would return any pact/swagger warnings or errors as part of the validation result. Now when a validation error is encountered with a swagger or pact file the tool will fail with an error. Warnings are no longer reported at all. The list of validation result codes returned by the programatic API have been updated to reflect this change.

4.0.1 (2018-07-05)

Bug Fixes

  • paths without parameters not matching before paths with parameters (b0f0f4e), closes #69

4.0.0 (2018-04-13)

Bug Fixes

  • format validators for int32, int64, float and double no longer accept spaces and now test for the full range of accepted values (a38b085), closes #67

BREAKING CHANGES

  • Prior to this change the tool used to accept blank spaces in path parameters for int32, int64, float and double formatted numbers. A bug has been fixed to disallow blank spaces. This means some mock responses that were previously considered valid will now be considered invalid. This change has also updated the int64 and double format validators to now test for the full range of values these types support. This means some mock responses that were previously considered invalid will now be considered valid.

It is recommended that consumers and providers coordinate upgrading to this release so that both sides agree on what is considered valid vs invalid.

3.0.0 (2018-01-31)

Bug Fixes

  • content negotiation between request content type header and consumes values in spec (100aaf3)

BREAKING CHANGES

  • This release contains a bug fix for the way content type headers were being validated. As a result of this bug fix some mocks and specs which were previously considered valid will now be considered invalid.

2.2.3 (2017-12-21)

Bug Fixes

  • bump swagger-tools to resolve issue where the tool locks up when swagger examples contain a length property (46dac30)

2.2.2 (2017-11-29)

Bug Fixes

  • reverting fix for content negotiation, this will be re-released as a major version (c72993f)

2.2.1 (2017-11-29)

Bug Fixes

  • fix content negotiation between request content type header and consumes values in spec (4953743)

2.2.0 (2017-09-01)

Features

2.1.0 (2017-08-07)

Features

  • allow empty pact list to be returned from pact broker (1eea0ee), closes #63

2.0.2 (2017-07-14)

Bug Fixes

  • spec warnings were not shown if mock validation returns errors (c1328a8)

2.0.0 (2017-07-11)

Bug Fixes

  • allOf validation ignoring required properties and formats (bae1bb7), closes #32

Features

  • add support for circular references in the swagger file (dd61f7b), closes #60
  • only output mockDetails and specDetails when they relevant (8486bf8), closes #56

BREAKING CHANGES

  • Prior to this change the tool used to disallow additional properties in response mocks unless the schema explicitly allowed additional properties. To support the allOf keyword correctly this behavior has been changed. Now additional properties are allowed in response mocks unless a schema explicitly disallows them. This means some mock responses that were previously considered invalid will now be considered valid. It is recommended that consumers and providers coordinate upgrading to this release so that both sides agree on what is considered valid vs invalid.
  • swagger-mock-validator now supports validating schemas containing circular references. Prior to this change schemas containing circular references were ignored. If you have a schema that contains circular references and a mock that is not compatible with that schema the swagger-mock-validator will now fail. It is recommended that consumers and providers coordinate upgrading to this release so that both sides agree on what is considered valid vs invalid.

1.0.0 (2017-03-24)

Bug Fixes

  • the order of security requirements impacts validation results (07a7122)

Features

  • add opt-in analytics (6439444), closes #54
  • rename project to swagger-mock-validator (2594491), closes #16

BREAKING CHANGES

  • The name of the module has changed from “@atlassian/swagger-pact-validator” to “swagger-mock-validator”. To migrate you need to rename the dependency in your package.json and update any code that invokes this cli took from “swagger-pact-validator” to “swagger-mock-validator”.

0.0.31 (2017-02-22)

Features

  • add breakdown of issues detected (5c5075c), closes #39

0.0.30 (2017-02-20)

Features

  • add support for swagger base path (1f9828c), closes #24

0.0.28 (2017-02-16)

Features

  • add support for yaml swagger files (fabbe62), closes #20

0.0.27 (2017-02-08)

Features

  • add validation for auth headers (a9cd312), closes #53

0.0.26 (2017-01-24)

Features

  • add validation for response content type (1a2d1fd), closes #52

0.0.25 (2017-01-23)

Features

  • add validation for swagger consumes (660c618), closes #34
  • add validation for swagger produces (2a341ab), closes #33

0.0.24 (2017-01-17)

Bug Fixes

  • correctly extract provider state from pact interactions (d4dd4fe)

0.0.23 (2017-01-16)

Features

  • add validation for query parameters (774cef3), closes #8

0.0.22 (2017-01-12)

Features

0.0.21 (2017-01-06)

Features

  • add validation for additional property schemas (e4967b9), closes #35

0.0.20 (2017-01-04)

Bug Fixes

  • remove default parameters for node 4.x compatibility (ddbdb45), closes #50

0.0.19 (2017-01-03)

Features

  • add validation for type array (96b44a9), closes #49

0.0.18 (2016-12-30)

Features

  • add validation for enum (e83600e), closes #40
  • add validation for maximum and exclusiveMaximum (8371cc2), closes #41
  • add validation for maxLength and minLength (8aa82e8), closes #45 #46
  • add validation for minimum and exclusiveMinimum (11e7eba), closes #43
  • add validation for multipleOf (bfe149e), closes #48
  • add validation for pattern (d20251e), closes #47

0.0.17 (2016-12-29)

Features

  • add validation for swagger formats (5bab1fd), closes #29

0.0.16 (2016-12-19)

Features

  • add counts of errors and warnings detected (0846030), closes #38
  • add validation for response headers (2218cb3), closes #5

0.0.15 (2016-12-14)

Features

  • display warnings when validation succeeds (1be61b5)

0.0.14 (2016-12-14)

Features

  • add validation for request headers (2676b27), closes #2 #7
  • undefined non-standard request headers are now warnings (adca8bd)

0.0.13 (2016-12-07)

Features

  • add support for default swagger responses (a391c8b), closes #30

0.0.12 (2016-12-05)

Features

  • add validation for response body (ac2c479), closes #6
  • reduce verbosity of the output when errors are detected (d300546), closes #27

0.0.11 (2016-11-30)

Features

  • add validation for response status (6a1feec), closes #4

Performance Improvements

  • improve validation speed for large swagger files (e009399)

0.0.10 (2016-11-24)

Features

  • add validation for json request bodies (7dfb267), closes #22

0.0.9 (2016-11-21)

Bug Fixes

  • partial path matching causing exceptions (8507ff5)

0.0.8 (2016-11-18)

Bug Fixes

  • swagger validation warnings treated as warnings not errors (ccf7251), closes #21 #19

0.0.7 (2016-11-17)

Bug Fixes

  • handle undefined path parameters when method is missing (b595073)

0.0.6 (2016-11-17)

Features

  • add validation for request methods (778b8e0), closes #3

0.0.5 (2016-11-08)

0.0.4 (2016-09-13)

Features

  • add support for retrieving pact and swagger files via urls (ab248dc)

0.0.3 (2016-09-01)

Bug Fixes

  • path parameter parser no longer case sensitive for request method (cab9c81)

0.0.2 (2016-08-24)

Features

  • add validation for request paths (d95aa8f), closes #1