osuTitanic / banchobot

Discord bot for the titanic discord server
MIT License
2 stars 1 forks source link

Bump ossapi from 3.4.4 to 4.0.0 #264

Closed dependabot[bot] closed 1 month ago

dependabot[bot] commented 1 month ago

Bumps ossapi from 3.4.4 to 4.0.0.

Release notes

Sourced from ossapi's releases.

v4.0.0

The big change in this release is to account for the migration from old score ids (https://osu.ppy.sh/scores/osu/3772000814) to new score ids (https://osu.ppy.sh/scores/1312718771). The former requires the gamemode while the latter does not. Endpoints which previously took both a gamemode and a score id have been changed to take just a score id (new format), while the previous endpoint behavior was kept under a different method name.

Breaking changes

  • rename api.score to api.score_mode
  • add a new api.score method which takes the new score id format
  • rename api.download_score to api.download_score_mode
  • rename BeatmapScores.userScore to BeatmapScores.user_score
  • add a new api.download_score method which takes the new score id format
  • rename before and after parameters of api.match to before_id and after_id, to better reflect that the api filters by id and not something like time
  • remove Domain.LAZER
    • lazer.ppy.sh was decommissioned in the past few months, so this parameter has no effect and in fact causes errors. Lazer data is now live on the main site and you do not need to pass a Domain to access it

Migration guide

  • change any api.score calls to api.score_mode (and consider migrating to the new api.score, to use the new score ids without gamemodes)
  • change any api.download_score calls to api.download_score_mode (and consider migrating to the new api.download_score, for the same reason)
  • rename any api.match(before=..., after=...) calls to api.match(before_id=..., after_id=...)

Non-breaking changes

  • add legacy_only parameter to applicable endpoints
  • make Statistics counts optional
  • correctly type cursor_string as optional

v4.0.0beta1

This is a beta release. You can install it with pip install -U --pre ossapi. I may make breaking changes based on feedback before releasing 4.0.0 final (though I don't expect to).

The big change in this release is to account for the migration from old score ids (https://osu.ppy.sh/scores/osu/3772000814) to new score ids (https://osu.ppy.sh/scores/1312718771). The former requires the gamemode while the latter does not. Endpoints which previously took both a gamemode and a score id have been changed to take just a score id (new format), while the previous endpoint behavior was kept under a different method name.

Breaking changes

  • rename api.score to api.score_mode
  • add a new api.score method which takes the new score id format
  • rename api.download_score to api.download_score_mode
  • add a new api.download_score method which takes the new score id format
  • rename before and after parameters of api.match to before_id and after_id, to better reflect that the api filters by id and not something like time
  • remove Domain.LAZER
    • lazer.ppy.sh was decommissioned in the past few months, so this parameter has no effect and in fact causes errors. Lazer data is now live on the main site and you do not need to pass a Domain to access it

Migration guide

  • change any api.score calls to api.score_mode (and consider migrating to the new api.score, to use the new score ids without gamemodes)
  • change any api.download_score calls to api.download_score_mode (and consider migrating to the new api.download_score, for the same reason)
  • rename any api.match(before=..., after=...) calls to api.match(before_id=..., after_id=...)

Non-breaking changes

  • make Statistics counts optional

... (truncated)

Commits
  • 8bd92bd reword docs
  • f095b42 reword docs
  • 9507605 remove single header
  • 1839aff reword expandable models docs
  • 58f725b update foreign keys docs for fk changes
  • aadebfe update tests for fk/expand changes
  • 7710b72 - #expand now always updates the model, even if already non-compact
  • 01d4231 update api v1 link
  • c41555e proper enum for UserStatistics.variants (semi-breaking change)
  • c3a1f70 typo
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)