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

[DOCUMENTATION] Incorrect and incomplete documentation on lol-challenges endpoints #993

Open
noahkohrs opened this issue Sep 9, 2024 · 0 comments

Comments

@noahkohrs
Copy link

noahkohrs commented Sep 9, 2024

/lol/challenges/v1/challenges/config

ChallengeConfigInfoDto.localizedNames: Map[String, Map[String, string]] is too vague.

localizedNames could be specified as Map[String, ChallengeDto]

where ChallengeDto is:

public data class ChallengeDto(
    val description: String,
    val name: String,
    val shortDescription: String,
)

/lol/challenges/v1/challenges/percentiles

Incorrectly written as
Return value: Map[Long, Map[Integer, Map[Level, Double]]]

Description: Map of level to percentile of players who have achieved it - keys: ChallengeId -> Season -> Level -> percentile of players who achieved it

But is in reality:
Return value: Map[Long, Map[String, Double]]

Description: Map of level to percentile of players who have achieved it - keys: ChallengeId -> Rank-> percentile of players who achieved it.

This issue might be updated with additional lol-challenges documentation problems

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

1 participant