Adyen / adyen-openapi

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

success is declared as a boolean when it is a string in production and test environments. #26

Open LucasRxTx opened 3 years ago

LucasRxTx commented 3 years ago

Describe the bug success has been declared as a boolean when it is actually a string. Here is one example of many: https://github.com/Adyen/adyen-openapi/blob/4d59745bf59feb74083f5048bad9218801d69ede/json/Webhooks-v1.json#L2065

To Reproduce Look at other definitions of success in the openAPI documentation and see that success is a string. Look at the example notifications in the openAPI documentation; success is a string. Look at a production notification and see that success is a string. Look at a testing environment notification and see that success is a string.

Expected behavior success should be a string. It would have been great if success was actually a boolean, but at this point it has to be a string to break integrations.

Screenshots None

Desktop (please complete the following information): irrelevent

Smartphone (please complete the following information): irrelevent

Additional context This has caused issues in the past. We have getters for success that coax the value to a boolean if it is a string or a bool because it is unclear in your openAPI spec if success will always be a string, or sometimes may possibly be a bool.