oscar-team / reepay-php-api

Improved Swagger generated Reepay API PHP library
MIT License
4 stars 9 forks source link

Support for OpenAPI Specification 3? #17

Open JensKirk opened 7 months ago

JensKirk commented 7 months ago

Hi :-)

Any plans to support OpenAPI Specification 3?

Please read: https://changelog.billwerk.plus/api-specification-upgrade-from-swagger-2-to-openapi-3kdjhu

adnedelcu commented 7 months ago

Hi. Yes, we were thinking to rewrite the library to be more "modern" and have type casting as a v2.

Maybe it's also time to update the api specification since this is going to happen on their side also.

JensKirk commented 7 months ago

Thank you and good work by the way :-)

Do you have an ETA for v2 upgrade? :-)

If I understand BillWerk (the URL that I gave) correctly the support for the current version of Swagger will end 1'th April this year? Meaning the it will not work anymore?

adnedelcu commented 7 months ago

We will soon push a new branch here with v2, but it will be marked as dev for a while until we figure out if it works fine.

Will appreciate any support in testing anybody can provide.

JensKirk commented 7 months ago

Thank you :-)

We will gladly test the dev version when you launch it. We are API programmers but have not worked with your SDK.

When do you think that you can launch it? Days or weeks?

Will your SDK stop working the 1'th April (see the announcement from BillWerk)?

adnedelcu commented 6 months ago

Well, we're actively using the library in 2 of our projects and we're invested in it working properly :)

If the v1 will stop working, then we have a big problem ourselves, but I don't think it's going to stop working. According to the article, the API will still work, it's just they will not update the Swagger documentation for it, rather only the OpenAPI one.

JensKirk commented 6 months ago

Okay, thank you :-)

I could start using your current master SDK and later hopefully do an easy update when your new version is launched. Could this be done via composer without breaking anything? Or do I need to update all endpoints in my code? If so, I better wait with installing your SDK until your new version is launched.

Thank you again :-)

JensKirk commented 6 months ago

I got it confirmed now that is only their old doc that they are taken down and not their (old?) API.

Now I just need a reply to my question above before I can start :-)

adnedelcu commented 6 months ago

We pushed a work-in-progress version 2.x. Migration guide will probably be bigger, but the major changes should be already there.

JensKirk commented 6 months ago

Perfect, thank you :-)

I will soon test it.

Is it correct that we get the next version by inserting this into the composer file?

{ "require": { "oscar-team/reepay-php-api": "dev-2.x" } }

I have deleted the old/master install.

adnedelcu commented 6 months ago

I think so. I have not tested it, I only based it on the documentation of composer.

You might need to change something in your composer.json file because it's a dev package and it might not let you install it.

On Sun, Mar 17, 2024, 22:29 Jens Kirk @.***> wrote:

Perfect, thank you :-)

I will soon test it.

Is it correct that we get the next version by inserting this into the composer file?

{ "require": { "oscar-team/reepay-php-api": "dev-2.x" } }

I have deleted the old/master install.

— Reply to this email directly, view it on GitHub https://github.com/oscar-team/reepay-php-api/issues/17#issuecomment-2002623211, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAI5HNTQRSGQRBZVATQXN4LYYYDKPAVCNFSM6AAAAABELXMWZCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMBSGYZDGMRRGE . You are receiving this because you commented.Message ID: @.***>

adnedelcu commented 6 months ago

I am currently in a very poor Internet area and I was not able to test it.