pactflow / roadmap

Public Pactflow issue tracker and roadmap
MIT License
15 stars 0 forks source link

OAS 3.1 Support #82

Closed mefellows closed 1 year ago

mefellows commented 1 year ago

Adds support for OAS v3.1 in our Bi-Directional Contract Testing Feature (https://docs.pactflow.io/docs/bi-directional-contract-testing/contracts/oas#supported-versions).

YOU54F commented 1 year ago

:rocket: Bi-Directional Contract Testing: Release announcement :new:

Just checking in to let you know we have dropped a major update to our Bi-Directional Contract Testing feature.

As a summary, we have released support for:

Lastly - and most importantly - we have improved how we support the logical keywords anyOf oneOf and allOf, including for use cases in composition, inheritance and polymorphism. These changes improve the guarantees, including ensuring the use of discriminator is correct (instead of ignoring the invalid setup), and simplify the setup previously required to make this work the way you would expect.

:warning: The validation has improved in this release which may cause some tests that were previously passing to now fail. This is a good-bad thing. Good, because we have improved the guarantees, bad because you will need to update your tests to cater for this. See the changelog for advice on addressing these errors :warning:

For a full review of the OAS features we support, see :point_right: https://docs.pactflow.io/docs/bi-directional-contract-testing/contracts/oas/features.

We have also made a number of updates to our documentation, which is much more comprehensive than before including improved “how to fix” compatibility errors, detailed breakdown of our supported features and an overview of how we support keywords (an area that seems to trip people up the most)

Lastly, we have created a helpful repository of example OpenAPI documents and pact files that can be used to better understand how the features and capabilities translate to real life. This should help bring to life the theoretical documentation.