SettingsEffectiveComponentDetails

The EffectiveComponentDetails structure contains information that provide more details about the component from the depot.


Properties

string
display_name Required

Display name of the component.


string
display_version Required

Human readable version of the component.


note Optional

Note assosicated with this component. If unset, note is present for this component.


overridden_components Required

List of other component versions present in base-image, add-ons or solutions that this component is overriding. For example, if a component version-1 was implicitly present in the base-image, but user wants it to be changed to version-2. In that case, EffectiveComponentDetails.source would be USER and there will be one entry in this list indicating base-image component version-1 is being overridden.


source Required

Final effective source of the component.

Possible values are: BASE_IMAGEADD_ONUSERSOLUTIONHARDWARE_SUPPORT_PACKAGE


string
vendor Required

Vendor of the component.

JSON Example

{
    "display_name": "string",
    "display_version": "string",
    "overridden_components": [
        {
            "display_version": "string",
            "note": {
                "args": [
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "source": "enum",
            "version": "string"
        }
    ],
    "source": "enum",
    "vendor": "string"
}
Feedback

Was this page helpful?