Skip to main content

SettingsOption

Represents a single configuration option within a setting. Contains metadata for UI rendering and the current value of this specific option.

type SettingsOption {
  currentValue: JSON
  default: JSON
  description: String
  key: String!
  required: Boolean!
  title: String
  type: String!
}

Fields​

SettingsOption.currentValue ● JSON scalar​

Current value of this option

SettingsOption.default ● JSON scalar​

Default value for this option

SettingsOption.description ● String scalar​

Detailed description of what this option does

SettingsOption.key ● String! non-null scalar​

The key of this option (e.g., 'external_allocation')

SettingsOption.required ● Boolean! non-null scalar​

Whether this option is required

SettingsOption.title ● String scalar​

Human-readable title for the option

SettingsOption.type ● String! non-null scalar​

Data type of the option (e.g., 'boolean', 'string', 'integer')

Member Of​

SettingsConfig object