search

Adyen / adyen-openapi

OpenAPI specification for the Adyen APIs
MIT License
67 stars 50 forks source link

Some OpenAPI files have webhooks but no paths and declare version 3.0.x not 3.1.x #23

Closed MikeRalphson closed 1 year ago

MikeRalphson commented 3 years ago

Describe the bug

Commit https://github.com/Adyen/adyen-openapi/commit/ac74290fb7ffa72593efa6dfcc72896f9323cee6 updated the MarketPayNotificationService APIs to remove the paths top level object and replace it with webhooks, but the openapi property was not updated. The webhooks object (and the optionality of paths) are only valid in OpenAPI 3.1.0+.

https://github.com/Adyen/adyen-openapi/blob/ac74290fb7ffa72593efa6dfcc72896f9323cee6/yaml/MarketPayNotificationService-v6.yaml#L1

a-akimov commented 3 years ago

Hi @MikeRalphson, nice to have you here!

Indeed, this was something that we overlooked. Actually, our specs are 3.1.0-ready, and we plan to change it to 3.1.0 soon (otherwise, we'll have to rollback to 3.0.3 the entire structure of the specs, which is not our preference at this point).

At the same time, I was still waiting for any easy linting these specs to make sure they 100% comply with 3.1.0. If you have any recommendation how we can automatically verify 3.1.0-compliance, please let me know.

But we will fix these specs soon anyway.

MikeRalphson commented 3 years ago

I will let you know as soon as the next version of oas-kitis released, it will have support for converting, validating and linting v3.1 documents.