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

Clean up API #5

Merged
merged 6 commits into from
Apr 29, 2024
Merged

Clean up API #5

merged 6 commits into from
Apr 29, 2024

Conversation

Syriiin
Copy link
Owner

@Syriiin Syriiin commented Apr 29, 2024

Why?

For an initial release, we should start with the simplest possible friendly API, and add to it as needed, not the other way around.

Changes

  • Add basic input validation
  • Remove accuracy input parameters
    • (they appear as equally good input, but are inferior to hit results because of approximation)
  • Remove /difficulty and /performance API endpoints
    • (they didn't serve enough purpose to warrant existing separate from /calculation)
  • Add calculated accuracy and combo to returned calculations
  • Update C# syntax

Syriiin added 6 commits April 28, 2024 22:01
The only benefit of /performance over /calculation is the tiny bit of
saved serialisation. Not worth the extra api and code complexity.

The only benefit of /difficulty over /calculation is avoiding the
performance calculation, but performance calc is over 1000x faster than
difficulty calculation. The only tangible benefit is when the
difficulties have already been calculated and are in the cache, but I
still don't think its worth the complexity of the extra api. Can add
back later if requested.
@Syriiin Syriiin merged commit 3723adf into master Apr 29, 2024
2 checks passed
@Syriiin Syriiin deleted the clean-up-api branch April 29, 2024 14:13
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 this pull request may close these issues.

1 participant