Releases: Afischbacher/Nhl.Api
v3.5.0
Nhl.Api Updates
- Introduced two new asynchronous methods to the NHL API:
GetRealtimePlayerStatisticsBySeasonAndFilterExpressionAsync
GetTimeOnIcePlayerStatisticsBySeasonAndFilterExpressionAsync
- Enhanced functionality for retrieving player statistics.
- Allows access to real-time and time-on-ice statistics for players during specific seasons, with filtering and sorting options.
- Implemented nullable return types in the
NhlTeamService
interface. - Improved the retry mechanism in the testing attributes.
- Updated the README to reflect these changes.
Breakdown of Changes
Files | Change Summary |
---|---|
Nhl.Api/README.md | Added documentation for new asynchronous methods related to player statistics. |
Nhl.Api.Domain/Services/NhlTeamService.cs | Updated method signatures to nullable types and added handling for TeamEnum.UtahHockeyClub. |
Nhl.Api/Src/GameApi/NhlGameApi.cs | Modified GetGameCenterBoxScoreByGameIdAsync to perform concurrent data retrieval using asynchronous HTTP requests. |
Nhl.Api.Tests/Helpers/Attributes/TestMethodWithRetryAttribute.cs | Enhanced retry functionality with a new backoff strategy and updated default retry delay. |
Nhl.Api.Tests/TeamTests.cs | Reordered using directives for clarity. |
Nhl.Api.Tests/StatisticsTests.cs | Added multiple new test methods to validate player and goalie statistics across various seasons, including edge cases. |
v3.4.2
Release Notes for v3.4.2
Nhl.Api.Common
- Version Update: Updated version number from
3.4.1
to3.4.2
.
Nhl.Api.Domain
- Version Update: Updated version number from
3.4.1
to3.4.2
. - Enhancements:
- Updated
PlayerEnumFileGeneratorHelper.cs
to usevar
for variable declarations and enhanced theplayers
dictionary to include detailed player information. - Modified
GoalieProfile
andPlayerProfile
classes to handle nullable properties forHeightInInches
andBirthDate
, with updated logic forHeightInFeetAndInches
andAge
calculations. - Enhanced
ThreeStar
class properties to be nullable inGameCenterLanding.cs
.
- Updated
Nhl.Api.Tests
- Version Update: Updated version number from
3.4.1
to3.4.2
. - New Tests:
- Added
GetPlayerInformationAsync_Test_PlayerEnum_Returns_Valid_Information_Null_Age
to test player information retrieval with null age.
- Added
- Test Adjustments:
- Updated
StatisticsTests.cs
to assert player statistics count greater than 500 instead of 650.
- Updated
- Formatting:
- Minor formatting adjustment in
GameTests.cs
.
- Minor formatting adjustment in
Nhl.Api
- Version Update: Updated version number from
3.4.1
to3.4.2
.
These changes enhance the flexibility and robustness of the data model by supporting nullable properties and improve test coverage and accuracy.
v3.4.1
Refactor
- Introduced consistent coding standards across the project with a new .editorconfig file.
- Improved code readability and structure in various API components and services.
- Simplified syntax in several classes for better maintainability.
New Features
- Enhanced the GameCenterBoxScore model with new properties and a class for team game statistics.
Bug Fixes
- Corrected namespace declarations and syntax errors across the project.
- Fixed issues in HTTP client files for more reliable data fetching.
Tests
- Updated and added new assertions in test files for better coverage and reliability.
Chores
- Updated project version numbers for all components, indicating minor improvements and fixes.
v3.4.0
v3.4.0
New Features
Added methods to retrieve NHL player and goalie statistics for specific seasons with detailed filters.
Enhanced player API to include season year in headshot image retrieval, improving clarity and functionality.
Bug Fixes
Improved validation for seasonYear parameter in league API methods to better handle null values.
Documentation
Enabled documentation generation for the .NET framework 8.0 targeting project.
Refactor
Updated project versions to 3.4.0 across various components.
Modified instantiation of HttpClient and TeamService classes for better dependency management.
Tests
Added new test methods for project structure validation and string manipulation.
Chores
Updated GitHub Actions workflows to exclusively set up .NET version 8, removing previous versions setup.
v3.3.0
- New Features
- Introduced a new method to retrieve NHL players' game center statistics for specific seasons and game types.
- Added the
FullName
property in player profiles to display the full name of NHL players. - Updated functionality to correctly generate enum entries with associated summaries by transforming player data into a structured object before outputting it to the enum file.
- Bug Fixes
- Implemented a method to replace non-ASCII characters with their ASCII equivalents in strings.
- Documentation
- Enabled documentation generation for .NET frameworks 6.0, 7.0, and 8.0.
- Refactor
- Updated the project to version 3.3.0 across various components.
- Removed obsolete
CommonName
class usage and enhanced import directives for better clarity and maintenance.
v3.2.2
v3.2.1
v3.2.0
v3.1.0
- Fixed a lot spelling errors and grammatical issues
- Added a couple new statistics endpoints for Fantasy Statistics Lovers
- Added cancellation token arguments for all methods (not a breaking change)
- Added a new method to get all NHL players
- Upgraded internal projects to .NET 6/7/8
- More updates to come this year!
v3.0.0
- Rewrote and updated the NuGet package for the new NHL API endpoint
https://api-web.nhle.com/v1
with all new features - Restructured all endpoints, as a result this is a breaking update, all previous versions of this NuGet will be deprecated
- Still in the progress of adding additional endpoints, tests, and features, this is an MVP release
- Please reach out and create issues if you find an bugs or problems :)
- Thank you everyone for their support and patience on the NHL pull the plug on their old API