Skip to main content

SettingDto

Setting response DTO

categorystringrequired

Category for grouping settings

Example: scanning
defaultValuestringrequired

Default value for this setting

Example: 2
descriptionstringrequired

Human-readable description

Example: Number of concurrent scanning jobs
idstring<uuid>required

Setting unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000
isSensitivebooleanrequired

Whether value should be masked in responses

Example: false
keystringrequired

Setting key name

Example: scan.concurrent_jobs
maxValueinteger,null<int64>nullable

Maximum allowed value (for numeric settings)

Example: 16
minValueinteger,null<int64>nullable

Minimum allowed value (for numeric settings)

Example: 1
updatedAtstring<date-time>required

When the setting was last updated

Example: 2024-01-15T10:30:00Z
updatedBystring,null<uuid>nullable

User who last updated the setting

valuestringrequired

Current setting value

Example: 4
valueTypestringrequired

Data type of the value (string, integer, boolean, etc.)

Example: integer
versioninteger<int32>required

Version number for optimistic locking

Example: 1
SettingDto
{
"category": "scanning",
"defaultValue": "2",
"description": "Number of concurrent scanning jobs",
"id": "550e8400-e29b-41d4-a716-446655440000",
"isSensitive": false,
"key": "scan.concurrent_jobs",
"maxValue": 16,
"minValue": 1,
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"value": "4",
"valueType": "integer",
"version": 1
}