{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SetResult",
"description": "Terminal event of `set`: a value written at a dotted path in a structured config file.",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"path": {
"type": "string"
},
"config_path": {
"type": "string"
},
"key_path": {
"type": "string"
},
"old_value": {
"type": [
"string",
"null"
]
},
"new_value": {
"type": "string"
},
"format": {
"type": "string"
},
"comments_preserved": {
"description": "Whether every comment of the source survived the edit.\n\nOmitted for JSON, because JSON has no comments: `true` there was a fact\nabout the format and not about the run, and a caller that reads the\nfield cannot tell the two apart.",
"type": [
"boolean",
"null"
]
},
"write_strategy": {
"description": "Write strategy the atomic layer used: `rename`, `inplace` or `copyback`.\n\nA config file with more than one hard link is written in place so the\nother links keep the same inode, and this field names the path that ran.",
"type": "string"
},
"backup_skipped": {
"description": "Why the requested backup was skipped, when the directory refused it.",
"type": "string"
},
"elapsed_ms": {
"type": "integer",
"format": "uint64",
"minimum": 0
},
"ok": {
"description": "Outcome of the run, stamped by the writer",
"type": "boolean"
},
"code": {
"description": "Machine error code, present when ok is false",
"type": "string"
},
"exit": {
"description": "Process exit status, present when ok is false",
"type": "integer",
"minimum": 0
},
"target_resolved": {
"description": "Absolute targets the run resolved, in invocation order, and never a joined string, so a path holding `,` stays readable; a run with one target publishes a one-item array, so the shape never depends on the count",
"type": "array",
"items": {
"type": "string"
}
},
"target_source": {
"description": "Where the target came from: named in the invocation line, inherited from the workspace slot, or the standard-input stream",
"type": "string",
"enum": [
"argv",
"workspace",
"stdin"
]
},
"workspace_source": {
"description": "Where the workspace root came from: the `--workspace` flag or the process working directory",
"type": "string",
"enum": [
"argv",
"cwd"
]
},
"records_suppressed": {
"description": "Records the writer dropped before the terminal event: `--filter` rejections, `--select` projections that emptied the record, dedupe duplicates and `--limit` cuts. It counts records, never files, so it does not compare with `files_matched`: one file can contribute several records",
"type": "integer",
"minimum": 0
},
"files_budget_dropped": {
"description": "Entries the `--limit` budget dropped, in the unit the verb produces: files for walking verbs, records for streaming ones; a floor, because workers may stop before producing the rest",
"type": "integer",
"minimum": 0
},
"files_planned": {
"description": "Files the run would have modified in `--dry-run` or `--preview`; absent from a run that really wrote",
"type": "integer",
"minimum": 0
},
"truncated": {
"description": "The record itself was cut by `--truncate-content` or `--max-output-bytes`, so the fields are shorter than the source",
"type": "boolean"
},
"truncated_records": {
"description": "Records the writer cut this run, counted once per record",
"type": "integer",
"minimum": 0
}
},
"required": [
"type",
"path",
"config_path",
"key_path",
"new_value",
"format",
"write_strategy",
"elapsed_ms"
]
}