Skip to content

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

@noahkohrs

Description

@noahkohrs

/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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions