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

[DOCS][BUG] match-v5 MatchDto: match_id is actually matchId & data_version is actually dataVersion #540

Closed
ciriousjoker opened this issue Sep 12, 2021 · 3 comments

Comments

@ciriousjoker
Copy link

ciriousjoker commented Sep 12, 2021

Bug Description
match_id is actually called matchId on MatchDto (match-v5)

Problem Description
DTO is incorrect.

Expected Result

{
  "metadata": {
    "data_version": "2",
    "match_id": "...",

Actual Result

{
  "metadata": {
    "dataVersion": "2",
    "matchId": "...",

Developer Impact
Low, you can rename the field in your interface once you realize that things don't work.

Player Impact
None.

Preconditions
User has to read the documentation in the first place instead of generating the interfaces from the json response.

Repro Steps
Make a sample response on the new match-v5 endpoint here:
https://developer.riotgames.com/apis#match-v5/GET_getMatch

Issue Comments
I'm writing this in Javascript, perhaps there's some behind the scenes magic that javascriptifies the field names? I doubt it though since it's also reproducible in the official test environment.

@ciriousjoker
Copy link
Author

Same exact thing with the data_version field.

Documentation says data_version, reality says dataVersion.

@MingweiSamuel
Copy link

MingweiSamuel commented Sep 28, 2021

@ciriousjoker Can you please update the issue title to include both match_id and data_version, and prefix with [DOCS][BUG] as well, for clarity? Thanks

@ciriousjoker ciriousjoker changed the title [BUG] match_id is actually called matchId on MatchDto (match-v5) [BUG] match-v5 MatchDto: match_id is actually matchId & data_version is actually dataVersion Sep 28, 2021
@ciriousjoker ciriousjoker changed the title [BUG] match-v5 MatchDto: match_id is actually matchId & data_version is actually dataVersion [DOCS][BUG] match-v5 MatchDto: match_id is actually matchId & data_version is actually dataVersion Sep 28, 2021
@ciriousjoker
Copy link
Author

This has been fixed in the docs.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants