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

API improvements #1826

Merged
merged 27 commits into from
Jul 17, 2020
Merged

API improvements #1826

merged 27 commits into from
Jul 17, 2020

Conversation

kevinpapst
Copy link
Member

Description

  • Moved all serializer configurations from YAML to annotations
  • Includes some BC breaks, please read UPGRADING.md
  • Smoothed out inconsistencies, unfortunately some minor BC breaks had to be introduced
  • Removed attributes order (BC break if you intentionally mis-used the JSON structure)
  • All duplicate result types (Team2, Team3, Activity2...4 ...) could finally be removed (needs refactoring if you used swagger generated code!)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I verified that my code applies to the guidelines (composer code-check)
  • I updated the documentation (see here)
  • I agree that this code is used in Kimai and will be published under the MIT license

@kevinpapst
Copy link
Member Author

kevinpapst commented Jul 16, 2020

ping @hmr-it-jr @kbancerz @infeeeee @AlexandrePTJ please take some time and test these changes before the next release, your integrations might run into issues. I tried hard to avoid API BC breaks, but you can never know if something slipped through...
The API had to be refactored, as it grew "out of control" and had some massive pain points that needed to be cleared out.

@codecov
Copy link

codecov bot commented Jul 16, 2020

Codecov Report

Merging #1826 into master will increase coverage by 0.03%.
The diff coverage is 99.09%.

@@             Coverage Diff              @@
##             master    #1826      +/-   ##
============================================
+ Coverage     92.36%   92.40%   +0.03%     
+ Complexity     5064     5058       -6     
============================================
  Files           471      470       -1     
  Lines         15670    15665       -5     
============================================
+ Hits          14474    14475       +1     
+ Misses         1196     1190       -6     
Impacted Files Coverage Δ Complexity Δ
src/API/Model/TimesheetConfig.php 100.00% <ø> (ø) 6.00 <0.00> (-6.00)
src/API/StatusController.php 100.00% <ø> (ø) 3.00 <0.00> (ø)
src/Controller/ProfileController.php 97.41% <ø> (-0.02%) 46.00 <0.00> (ø)
src/Entity/ActivityMeta.php 100.00% <ø> (ø) 4.00 <0.00> (ø)
src/Entity/ActivityRate.php 100.00% <ø> (ø) 5.00 <0.00> (ø)
src/Entity/ColorTrait.php 100.00% <ø> (ø) 4.00 <0.00> (ø)
src/Entity/CustomerMeta.php 100.00% <ø> (ø) 4.00 <0.00> (ø)
src/Entity/CustomerRate.php 100.00% <ø> (ø) 5.00 <0.00> (ø)
src/Entity/MetaTableTypeTrait.php 95.45% <ø> (ø) 32.00 <0.00> (ø)
src/Entity/ProjectMeta.php 100.00% <ø> (ø) 4.00 <0.00> (ø)
... and 29 more

@kevinpapst kevinpapst merged commit c843dba into master Jul 17, 2020
@kevinpapst kevinpapst deleted the api-improvements branch July 17, 2020 18:30
@j0hannesr0th
Copy link
Contributor

Hi @kevinpapst thanks for notifying. I've tested my app with master after you've merged this PR and everything is still working 🎉 so good job 👍

@kevinpapst
Copy link
Member Author

Thanks!
But you are not using all the team/rate/user routes, are you?
Waiting for @kbancerz to hopefully reply soon.

@j0hannesr0th
Copy link
Contributor

Yes, I don't use these routes.

@AlexandrePTJ
Copy link

Hi @kevinpapst, thanks for the notification. Kemai still working great. (Tested on dev online demo)

@kevinpapst
Copy link
Member Author

Thanks for the feedback!!!

@infeeeee
Copy link
Contributor

infeeeee commented Aug 4, 2020

Everything is working as before the update, tested on demo, I don't use these routes. Thank you for the ping!

pinedev pushed a commit to pinedevstudio/kimai2 that referenced this pull request Mar 23, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Oct 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants