CatalogIntegrationConfigSchema
Defines the configuration schema for the integration.
StringConfigFieldSchema
objectDefines a string value integration config field.
user-friendly name of the configuration field.
Optional brief description of the configuration field.
Denotes whether the config field is a required value.
Default:false
Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.
For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.
Allowed values:unauthorized
The field type of the config value.
Allowed values:string
The default value for the config field.
EnumConfigFieldSchema
objectDefines an enum value integration config field.
user-friendly name of the configuration field.
Optional brief description of the configuration field.
Denotes whether the config field is a required value.
Default:false
Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.
For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.
Allowed values:unauthorized
The field type of config value.
Allowed values:enum
List of enumerated choices that can be selected as the config field value.
Show Child Parameters
The default value for the config field.
Must reference the value of an option listed in choices.
BooleanConfigFieldSchema
objectDefines a boolean value integration config field.
user-friendly name of the configuration field.
Optional brief description of the configuration field.
Denotes whether the config field is a required value.
Default:false
Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.
For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.
Allowed values:unauthorized
The field type of the config value.
Allowed values:boolean
The default value for the config field.
MutableCondition
stringDefines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.
For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.
Allowed values:unauthorized