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

allow retrieving game data from hash #618

Open
Jamiras opened this issue Jun 15, 2021 · 1 comment
Open

allow retrieving game data from hash #618

Jamiras opened this issue Jun 15, 2021 · 1 comment
Labels
area/api-connect Client Integration API

Comments

@Jamiras
Copy link
Member

Jamiras commented Jun 15, 2021

As a client developer, I'd like to be able to fetch the achievements/leaderboards/rich presence data for a game using the same server call as resolving the hash.

Almost every time a hash is resolved via the gameid API, the next thing to do is to call the patch API with the resulting game ID.

I'd like to propose passing the hash to the patch API and have it return the patch data (which includes the game ID) if the hash resolves, or a null PatchData if the hash does not resolve (possibly even a Success=false,Error='Unknown Hash'). The API currently returns empty arrays when passed a non-existant game ID. This would also be acceptable as long as the PatchData.ID field is not set, it's obvious the game doesn't exist.

{"Success":true,"PatchData":{"Achievements":[],"Leaderboards":[]}}

This would avoid a second server request when loading a game, making it load just a little bit faster.

@Jamiras Jamiras added the area/api-connect Client Integration API label Jun 15, 2021
@jeffjenx jeffjenx added this to the v2.x Upcoming milestone Sep 13, 2021
@luchaos luchaos modified the milestones: v2.x Upcoming, v1.0 Maintenance Jun 3, 2022
@luchaos
Copy link
Member

luchaos commented Jun 3, 2022

Makes sense and should be easy to implement - in a backwards compatible fashion even. Ready for v1 anytime imo

@luchaos luchaos removed this from the v1.0 Maintenance milestone Jun 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api-connect Client Integration API
Projects
None yet
Development

No branches or pull requests

3 participants