Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Improve public api #762

Open
WcaleNieWolny opened this issue Aug 2, 2024 · 0 comments
Open

feat: Improve public api #762

WcaleNieWolny opened this issue Aug 2, 2024 · 0 comments

Comments

@WcaleNieWolny
Copy link
Contributor

WcaleNieWolny commented Aug 2, 2024

Recently, there has been an proposed rename to some database fields. This change would have affected the public API if it was not caught. I DO NOT think that we should keep the same API structure forever nor do I think that the current way of documenting our api is any good.

I propose that we

A) Start versioning the public API
The endpoint would look something like: https://api.capgo.app/v1/channel

B) Set a clear API deprecation policy. We promise to inform of any changes made to the API (promise to inform of a new API version release) and we promise to keep the old api version for 6 months. After that we will deprecate the api. It will return a 410 gone

C) Improve the documentation by using openAPI and swagger

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant