feat: adding Blizzard ID to the search JSON #98
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Enhancement
PR Summary: The pull request introduces a new property, 'blizzard_id', to the JSON structure returned by the search players request handler. This addition aims to future-proof the application against potential changes in URL redirection by external services, specifically targeting the use case described in issue #96.
Decision: Comment
📝 Type: 'Enhancement' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.
General suggestions:
- It's crucial to verify that the 'url' field, now being used as 'blizzard_id', consistently contains valid Blizzard IDs. If there's any possibility of it containing other types of URLs, consider implementing a validation mechanism or using a more reliable source for Blizzard IDs.
- Given the importance of this new 'blizzard_id' field for future-proofing the application, it might be beneficial to document its purpose and expected values within the code or related documentation. This can aid in maintenance and understanding of the codebase for future developers.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
|
|
Thank you ! I just updated the tests (still have to rework them in the future 🙈) and exposed "search player" model 👍 |
|
Ahh thank you! Missed those models (don't work with python, I'm a NodeJS dev). |
As stated in #96, there's a new property on search. This will add it to the JSON from the search results.
This is a selfish addition as a way of preparing for the potential risk of them removing the automatic redirects from from the old URL format to the new format. This new property will allow us to capture the ID and start using that instead.