fix: iconImage in an app response is optional

[rossiam]

Changes

• marked iconImage field as optional in response from API
• minor updates to CONTRIBUTING.md document to make things more clear

Notes

The iconImage field is an object which contains a single url key which means there are three possible ways this can be defined:

1. The iconImage field is omitted entirely.
2. It is included but url is not. ("iconImage": {})
3. It is included with a url populated. ("iconImage": { "url": "<my-url>" })

When submitting data to the API, all three are accepted and work as expected.

When retrieving data, option 2 is sensibly never returned, normalizing to option 1 if option 2 was submitted via creation.

So, the type used for creation and updating was left as iconImage?: IconImage which allows for all three cases, but the type for the return value was changed to iconImage?: Required<IconImage> which allows for options 1 and 3. (The previous value of iconImage: Required<IconImage> allowed only for option 3.)

[changeset-bot]

🦋 Changeset detected

Latest commit: a9ec956

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@smartthings/core-sdk	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR