codex/codex-rs/app-server-protocol/schema/json/v2/ThreadSettingsUpdatedNotification.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "AbsolutePathBuf": {
      "description": "A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).\n\nIMPORTANT: When deserializing an `AbsolutePathBuf`, a base path must be set using [AbsolutePathBufGuard::new]. If no base path is set, the deserialization will fail unless the path being deserialized is already absolute.",
      "type": "string"
    },
    "ActivePermissionProfile": {
      "properties": {
        "extends": {
          "default": null,
          "description": "Parent profile identifier from the selected permissions profile's `extends` setting, when present.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "Identifier from `default_permissions` or the implicit built-in default, such as `:workspace` or a user-defined `[permissions.<id>]` profile.",
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "type": "object"
    },
    "ApprovalsReviewer": {
      "description": "Configures who approval requests are routed to for review. Examples include sandbox escapes, blocked network access, MCP approval prompts, and ARC escalations. Defaults to `user`. `auto_review` uses a carefully prompted subagent to gather relevant context and apply a risk-based decision framework before approving or denying the request. The legacy value `guardian_subagent` is accepted for compatibility.",
      "enum": [
        "user",
        "auto_review",
        "guardian_subagent"
      ],
      "type": "string"
    },
    "AskForApproval": {
      "oneOf": [
        {
          "enum": [
            "untrusted",
            "on-failure",
            "on-request",
            "never"
          ],
          "type": "string"
        },
        {
          "additionalProperties": false,
          "properties": {
            "granular": {
              "properties": {
                "mcp_elicitations": {
                  "type": "boolean"
                },
                "request_permissions": {
                  "default": false,
                  "type": "boolean"
                },
                "rules": {
                  "type": "boolean"
                },
                "sandbox_approval": {
                  "type": "boolean"
                },
                "skill_approval": {
                  "default": false,
                  "type": "boolean"
                }
              },
              "required": [
                "mcp_elicitations",
                "rules",
                "sandbox_approval"
              ],
              "type": "object"
            }
          },
          "required": [
            "granular"
          ],
          "title": "GranularAskForApproval",
          "type": "object"
        }
      ]
    },
    "CollaborationMode": {
      "description": "Collaboration mode for a Codex session.",
      "properties": {
        "mode": {
          "$ref": "#/definitions/ModeKind"
        },
        "settings": {
          "$ref": "#/definitions/Settings"
        }
      },
      "required": [
        "mode",
        "settings"
      ],
      "type": "object"
    },
    "ModeKind": {
      "description": "Initial collaboration mode to use when the TUI starts.",
      "enum": [
        "plan",
        "default"
      ],
      "type": "string"
    },
    "MultiAgentMode": {
      "description": "Controls whether the model should only spawn sub-agents after an explicit user request or may delegate proactively when doing so would help.",
      "enum": [
        "explicitRequestOnly",
        "proactive"
      ],
      "type": "string"
    },
    "NetworkAccess": {
      "enum": [
        "restricted",
        "enabled"
      ],
      "type": "string"
    },
    "Personality": {
      "enum": [
        "none",
        "friendly",
        "pragmatic"
      ],
      "type": "string"
    },
    "ReasoningEffort": {
      "description": "A non-empty reasoning effort value advertised by the model.",
      "minLength": 1,
      "type": "string"
    },
    "ReasoningSummary": {
      "description": "A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#reasoning-summaries",
      "oneOf": [
        {
          "enum": [
            "auto",
            "concise",
            "detailed"
          ],
          "type": "string"
        },
        {
          "description": "Option to disable reasoning summaries.",
          "enum": [
            "none"
          ],
          "type": "string"
        }
      ]
    },
    "SandboxPolicy": {
      "oneOf": [
        {
          "properties": {
            "type": {
              "enum": [
                "dangerFullAccess"
              ],
              "title": "DangerFullAccessSandboxPolicyType",
              "type": "string"
            }
          },
          "required": [
            "type"
          ],
          "title": "DangerFullAccessSandboxPolicy",
          "type": "object"
        },
        {
          "properties": {
            "networkAccess": {
              "default": false,
              "type": "boolean"
            },
            "type": {
              "enum": [
                "readOnly"
              ],
              "title": "ReadOnlySandboxPolicyType",
              "type": "string"
            }
          },
          "required": [
            "type"
          ],
          "title": "ReadOnlySandboxPolicy",
          "type": "object"
        },
        {
          "properties": {
            "networkAccess": {
              "allOf": [
                {
                  "$ref": "#/definitions/NetworkAccess"
                }
              ],
              "default": "restricted"
            },
            "type": {
              "enum": [
                "externalSandbox"
              ],
              "title": "ExternalSandboxSandboxPolicyType",
              "type": "string"
            }
          },
          "required": [
            "type"
          ],
          "title": "ExternalSandboxSandboxPolicy",
          "type": "object"
        },
        {
          "properties": {
            "excludeSlashTmp": {
              "default": false,
              "type": "boolean"
            },
            "excludeTmpdirEnvVar": {
              "default": false,
              "type": "boolean"
            },
            "networkAccess": {
              "default": false,
              "type": "boolean"
            },
            "type": {
              "enum": [
                "workspaceWrite"
              ],
              "title": "WorkspaceWriteSandboxPolicyType",
              "type": "string"
            },
            "writableRoots": {
              "default": [],
              "items": {
                "$ref": "#/definitions/AbsolutePathBuf"
              },
              "type": "array"
            }
          },
          "required": [
            "type"
          ],
          "title": "WorkspaceWriteSandboxPolicy",
          "type": "object"
        }
      ]
    },
    "Settings": {
      "description": "Settings for a collaboration mode.",
      "properties": {
        "developer_instructions": {
          "type": [
            "string",
            "null"
          ]
        },
        "model": {
          "type": "string"
        },
        "reasoning_effort": {
          "anyOf": [
            {
              "$ref": "#/definitions/ReasoningEffort"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "model"
      ],
      "type": "object"
    },
    "ThreadSettings": {
      "properties": {
        "activePermissionProfile": {
          "anyOf": [
            {
              "$ref": "#/definitions/ActivePermissionProfile"
            },
            {
              "type": "null"
            }
          ]
        },
        "approvalPolicy": {
          "$ref": "#/definitions/AskForApproval"
        },
        "approvalsReviewer": {
          "$ref": "#/definitions/ApprovalsReviewer"
        },
        "collaborationMode": {
          "$ref": "#/definitions/CollaborationMode"
        },
        "cwd": {
          "$ref": "#/definitions/AbsolutePathBuf"
        },
        "effort": {
          "anyOf": [
            {
              "$ref": "#/definitions/ReasoningEffort"
            },
            {
              "type": "null"
            }
          ]
        },
        "model": {
          "type": "string"
        },
        "modelProvider": {
          "type": "string"
        },
        "personality": {
          "anyOf": [
            {
              "$ref": "#/definitions/Personality"
            },
            {
              "type": "null"
            }
          ]
        },
        "sandboxPolicy": {
          "$ref": "#/definitions/SandboxPolicy"
        },
        "serviceTier": {
          "type": [
            "string",
            "null"
          ]
        },
        "summary": {
          "anyOf": [
            {
              "$ref": "#/definitions/ReasoningSummary"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "approvalPolicy",
        "approvalsReviewer",
        "collaborationMode",
        "cwd",
        "model",
        "modelProvider",
        "sandboxPolicy"
      ],
      "type": "object"
    }
  },
  "properties": {
    "threadId": {
      "type": "string"
    },
    "threadSettings": {
      "$ref": "#/definitions/ThreadSettings"
    }
  },
  "required": [
    "threadId",
    "threadSettings"
  ],
  "title": "ThreadSettingsUpdatedNotification",
  "type": "object"
}