bunq / doc

The bunq API documentation
https://doc.bunq.com
MIT License
30 stars 20 forks source link

Swagger/DOC doesn't fit to API #203

Open ternes3 opened 1 year ago

ternes3 commented 1 year ago

I am currently working on an application that will make some of my work with bunq easier. For this, I have generated a client from the Swagger file in the master via the OpenAPI generator.

I have now noticed some differences in the documentation and the use of the API during programming.

For example, GET /v1/user/$userId/monetary-account/ returns a MonetaryAccountListing, whereas the attributes monetaryAccountBank and monetaryAccountJoint are supposed to be a MonetaryAccount[Bank|Joint] object. I have switched to using a MonetaryAccount[Bank|Joint] listing. The current MonetaryAccount[Bank|Joint] object does not even contain a BunqId. That doesn't fit somehow.

Another example is a POST to "/v1/user/$userId/monetary-account/$monetaryAccountId/request-inquiry.

According to the documentation, a RequestInguiry expects a LabelMonetaryAccount as "counterparty_alias". However, it should be a Pointer Object, so that it will work against the API.

Since doc.bunq.com is also generated from the Swagger file, the description there is also wrong / not applicable.

ternes3 commented 1 year ago

Additional example for GET /v1/user/$userId/monetary-account/$monateryId/schedule-payment Bildschirm­foto 2023-02-10 um 19 04 27

agonbina commented 1 year ago

The definitions being wrong defeats the purpose of even providing a Swagger file in the first place. I thought the Bunq apps are built on top of the public APIs which can be used by developers too? Do you have an internal definition of the API which is correct?

Thanks 🙏