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

Pull out API routes in separate controller #95

Closed
3 of 6 tasks
TomNaessens opened this issue May 25, 2022 · 11 comments · Fixed by #128
Closed
3 of 6 tasks

Pull out API routes in separate controller #95

TomNaessens opened this issue May 25, 2022 · 11 comments · Fixed by #128
Assignees

Comments

@TomNaessens
Copy link
Member

TomNaessens commented May 25, 2022

This will clean up the code a bit and allow for easy API versioning when making future changes.

This will change the routes for the API so it will be a breaking change for applications using the API. We can copypaste it first, and then remove the old ones to give the dependent applications a bit of time to migrate.

Applications dependent on the API are:

@TomNaessens
Copy link
Member Author

@bobbybobbypangang @FKD13 @mcbloch are you aware of any scripts/applications using the Tab API?

@SammyDelanghe
Copy link

SammyDelanghe commented May 26, 2022

My scripts for treasuring bookkeeping request all the transactions for user Zeus. (which takes a while, asking transactions for a given year would be helpful). Those are in the private penning repo, but updating them is very easy and I'll after it when this goes online. (For me it is not needed to wait with removing the old one first, since the are manually run scripts and uptime isn't needed)

@niknetniko
Copy link
Member

The hydra app for Android also uses it

@redfast00
Copy link
Member

  • The Tappb app
  • My personal script for plain-text accounting

@ninewise
Copy link
Member

My scripts are not very complicated so I don't really mind you breaking them. I will whine about it though.

@redfast00
Copy link
Member

Tap also uses the Tab API, it's important this doesn't break

@redfast00
Copy link
Member

And Haldis does not use the Tab API at the moment (this feature is planned, but has not been implemented yet)

@TomNaessens TomNaessens self-assigned this May 29, 2022
@TomNaessens
Copy link
Member Author

PR open in #99, on the Rails 7 branch, to be merged and deployed soon(tm).

@TomNaessens
Copy link
Member Author

So this accidentally kinda already got merged into master, and it is available.

The new endpoint for API requests is the same as the old one, except the URL is tap.zeus.gent/api/v1/.... The implementation should be the same, if you notice any differences, let me know.

I'll remove the old endpoints in about a week as the migration is pretty easy.

For the future, these migrations and API changes will be easier as we can just add a v2 endpoint where necessary.

@TomNaessens TomNaessens added the API label Jun 5, 2022
@TomNaessens
Copy link
Member Author

In case anyone wants to view a preview of the documentation, there's a screenshot here: #120

@TomNaessens
Copy link
Member Author

#128 It's happening 😁

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

Successfully merging a pull request may close this issue.

5 participants