Releases: TeKrop/overfast-api
Version 2.19.0
Changelog
- [#52] Added
operation_id
for routes. FastAPI allows us to set a unique identifier for each route calledoperation_id
. Thisoperation_id
is mainly used by third party libraries to identified each endpoint easily and to generate code from it. Thank you @s-rigaud for this change 😄 - [#53] Made it easier to support a new hero into the API after its release : it only requires adding it into a CSV file in a PR :
app/data/heroes.csv
. The documentation will automatically be updated, and it doesn't require to update the test suite to properly work.
Version 2.18.0
Changelog
- Updated FastAPI to v0.101.0 and Pydantic from v1 to v2, with a lot of refactoring. As a consequence, performances are improved and documentation is more relevant regarding required and optional parameters.
- Updated player title processing by returning
null
for the"No Title"
special value on Blizzard pages - Updated others various dependencies
Version 2.17.2
Changelog
- Added last season played in player summary. The
season
value is available on "Get player summary" and "Get all player data" endpoints.
Version 2.17.1
Changelog
-
Fixed an issue with statistics retrieval for heroes when the number of games played for the hero is 0, but some other statistics are available. It apparently can happen if you played a hero for only a few minutes during a game, and in that case the "Time played" value is correct. Statistics are now correctly returned by the API, even if the number of games played is 0.
- Endpoints :
- Get player stats summary (/players/{player_id}/stats/summary)
- Endpoints :
-
Fixed an issue when a single statistic is exposed with its label in singular on Blizzard pages (for example, "Game won" instead of "Games won"). Now, data is correctly retrieved and exposed in the API.
- Endpoints :
- Get player stats summary (/players/{player_id}/stats/summary)
- Endpoints :
-
Harmonized statistics keys in the API : every keys are now exposed with their plural syntax instead of sometimes singular or plural depending on what is on Blizzard pages. For example, we could have
{"game_won": 1}
before, now it will be{"games_won": 1}
.- Endpoints :
- Get player career stats (/players/{player_id}/stats/career)
- Get player stats with labels (/players/{player_id}/stats)
- Get all player data (/players/{player_id})
- Endpoints :
Version 2.17.0
Changelog
- Added
/player/{{PLAYER_ID}}/stats/career
endpoint, exposing all statistics of a player without labels of categories and statistics. For labels, call the/player/{{PLAYER_ID}}/stats
endpoint as usual. (#45) - Reorganized and renamed endpoints for retrieving players informations
Miscellaneous
- Updated main dependencies :
fastapi
,httpx
,redis
- Updated dev dependencies :
fakeredis
,pytest-cov
,pytest-xdist
,ruff
Version 2.16.0
Changelog
- Added
games_won
andgames_lost
into stats summary endpoint (#42)
Miscellaneous
- Updated Docker Compose workflow to facilitate production usage
Version 2.15.1
Changelog
- Split hero ability video links into both available formats,
mp4
andwebm
- Fixed invalid
shields
value for Wrecking Ball
Version 2.15.0
Changelog
- Added
hitpoints
in specific hero pages :health
,armor
,shields
andtotal
- Added links to abilities videos (and thumbnails) in specific hero pages
- Fixed a blocking issue with specific hero page for new released heroes
Miscellaneous
- Fixed a minor code smell detected by SonarCloud
- Added
CONTRIBUTING.md
to indicate how to update maps and heroes statistics if necessary - Updated dependencies
Version 2.14.0
Changelog
- Reworked Github Actions workflows
- Configured SonarCloud in CI, and fixed some code smells
- Added healthcheck in compose configuration
Version 2.13.1
Changelog
- Improved tests and updated fixtures after Lifeweaver release
- Updated some dependencies