TakeoutSidecarCandidateDto
| Field | Required | Description |
|---|---|---|
id | Yes | string |
metadata | Yes | See definition below |
path | Yes | string |
Complete definition
required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.
Field definitions: TakeoutMetadataDto
{
"properties": {
"id": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/TakeoutMetadataDto"
},
"path": {
"type": "string"
}
},
"required": [
"id",
"metadata",
"path"
],
"type": "object"
}© 2026 Frameleaf Inc. All rights reserved.
Frameleaf and the Frameleaf logo are Trademarks of Frameleaf Inc.