Api: Documentation missing Type/Property information.

[gitFurious]

Looking at the Destiny2.GetClanLeaderboards in the documentation it's not clear what Type the Response property is.

Chasing it down in the generated openapi.json file show's the response property is of Destiny.HistoricalStats.DestinyLeaderboardResults which itself has issues displaying some (?) of the properties.

[vpzed]

Also the endpoint doesn't follow the maxtop value. For the few things I tried what it returns is something like submitted "maxtop+3", so if you want top 5 you have to submit maxtop=2.

Plus the mentioned statid values aren't included in the docs (or an enum provided if there is one). I know from using it that you can use the stat names as strings, but you can only give one (not a comma separated list):

lbSingleGameKills
lbPrecisionKills
lbAssists
lbDeaths
lbKills
lbObjectivesCompleted
lbSingleGameScore
lbMostPrecisionKills
lbLongestKillSpree
lbLongestKillDistance
lbFastestCompletionMs
lbLongestSingleLife

But for others it would be nice if they were in the docs.

[gitFurious]

Even further to this; the response type is different between the two OpenAPI generated files.

3.0.0: https://github.com/Bungie-net/api/blob/4c0e5dd64336354201a56a6587eb7e19a1562e12/openapi.json#L1558-L1562

Destiny.HistoricalStats.DestinyLeaderboardResults. Appears to be incorrect.

2.0.0: https://github.com/Bungie-net/api/blob/4c0e5dd64336354201a56a6587eb7e19a1562e12/openapi-2.json#L2396-L2432

A standard base response including Destiny.HistoricalStats.DestinyLeaderboard as the response property. Appears to be correct.

[kylerberry]

to add what @vpzed mentioned with maxtop. The request fails if the maxtop is greater than 24