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

Incorrect documentation for Match API. #982

Open
noahkohrs opened this issue Aug 17, 2024 · 0 comments
Open

Incorrect documentation for Match API. #982

noahkohrs opened this issue Aug 17, 2024 · 0 comments

Comments

@noahkohrs
Copy link

noahkohrs commented Aug 17, 2024

Bug Description
Error in Match V5's ParticipantDto and ChallengeDto Documentation.

Problem Description
ChallengeDto:
Fields earliestBaron, earliestDragonTakedown, earliestElderDragon, fastestLegendary and thirdInhibitorDestroyedTime are incorrectly documented as Integers while they can be Floats.
ParticipantDto:
Fields playerAugment5 and playerAugment6 are missing from the documentation while being present on request.

Expected
Documentation should be consistent with reality.

Developer Impact
Might cause misusage of the API if the developers don't double checks before usage.

Repro Steps for the false integer value

  1. Do a get match request for the match "EUW1_7071521501" (for instance).
  2. Check the value for earliestDragonTakedown in multiples ChallengeDto, which is Floating Point Number.
@noahkohrs noahkohrs changed the title [BUG] Incorrect documentation for Match API. Incorrect documentation for Match API. Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants