api icon indicating copy to clipboard operation
api copied to clipboard

[BUG]: Reward type is not the kind of reward (such as medals or requisition credits)

Open raginmari opened this issue 7 months ago • 0 comments

Link to faulty endpoint

Not available. Related issue: https://github.com/helldivers-2/json/issues/53

The name of your client/application

X-Super-Client de.reimartwelker.hd2companion

Request information

The type property of the Reward2 is assumed to indicate the kind of reward such as medals. This is apparently not the case, see this related issue. Instead, the "id32" seems to indicate the kind of reward while the meaning of the type is unknown. The id32 is not part of Reward2 so that client apps cannot differentiate between different kinds of rewards.

Steps to reproduce

See https://github.com/helldivers-2/json/issues/53 for an example JSON.

What is expected?

Client apps must be able to identify the kind of reward. Therefore, the "id32" (the reward's item ID, most likely) must be added to Reward2.

What is actually happening?

The "id32" is _not_ available to client apps which cannot identify the kinds of reward to display.

System Info

General issue.

Any additional comments?

Is adding a property to an existing model type considered a breaking change because some deserializers or deserializer configurations might break?

Should the "id32" be passed through as is or be renamed to something like "itemId"?

raginmari avatar May 31 '25 15:05 raginmari