developer-relations icon indicating copy to clipboard operation
developer-relations copied to clipboard
verified publisher icon RiotGames

[DOC] Spectator v4 featured games missing field in documentation

Open simivar opened this issue 5 years ago • 4 comments

Bug Description
While looking at Spectator v4 featured games docs object FeaturedGameInfo doesn't have gameTypeConfigId field that is returned by API

Problem Description
gameTypeConfigId field should be part of the documentation of FeaturedGameInfo class

Expected Result
gameTypeConfigId field should be part of the documentation of FeaturedGameInfo class

Actual Result
no gameTypeConfigId field in FeaturedGameInfo class fields list

Developer Impact
Unlisted field/property can be aproblem when working with API as:

  • developers can miss that such property exists
  • developers must guess what type this property has
  • developers must guess what this property means
  • developers can't be sure that it's expected and will not be deleted

simivar avatar Oct 23 '20 19:10 simivar

The same is true for skinIndex property of Participant class, it's missing from the documentation

simivar avatar Oct 23 '20 20:10 simivar

Preconditions Use developer key

AoshiW avatar Oct 23 '20 20:10 AoshiW

skinIndex might get deleted since MATCH-V4 doesn't have it, this issue will be more suited with a [DOC] prefix instead of a [BUG] prefix since it is working just not documented. We normally assume things that are not documented will be deleted at some time and not include that field into any consideration.

ianhco avatar Oct 24 '20 18:10 ianhco

As far as I can tell these fields are no longer returned slash gameQueueConfigId is used now.

MingweiSamuel avatar Feb 11 '22 00:02 MingweiSamuel