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

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "GuardianApprovalReview": {
      "description": "[UNSTABLE] Temporary guardian approval review payload used by `item/autoApprovalReview/*` notifications. This shape is expected to change soon.",
      "properties": {
        "rationale": {
          "type": [
            "string",
            "null"
          ]
        },
        "riskLevel": {
          "anyOf": [
            {
              "$ref": "#/definitions/GuardianRiskLevel"
            },
            {
              "type": "null"
            }
          ]
        },
        "status": {
          "$ref": "#/definitions/GuardianApprovalReviewStatus"
        },
        "userAuthorization": {
          "anyOf": [
            {
              "$ref": "#/definitions/GuardianUserAuthorization"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "status"
      ],
      "type": "object"
    },
    "GuardianApprovalReviewAction": {
      "oneOf": [
        {
          "properties": {
            "command": {
              "type": "string"
            },
            "cwd": {
              "type": "string"
            },
            "source": {
              "$ref": "#/definitions/GuardianCommandSource"
            },
            "type": {
              "enum": [
                "command"
              ],
              "title": "CommandGuardianApprovalReviewActionType",
              "type": "string"
            }
          },
          "required": [
            "command",
            "cwd",
            "source",
            "type"
          ],
          "title": "CommandGuardianApprovalReviewAction",
          "type": "object"
        },
        {
          "properties": {
            "argv": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "cwd": {
              "type": "string"
            },
            "program": {
              "type": "string"
            },
            "source": {
              "$ref": "#/definitions/GuardianCommandSource"
            },
            "type": {
              "enum": [
                "execve"
              ],
              "title": "ExecveGuardianApprovalReviewActionType",
              "type": "string"
            }
          },
          "required": [
            "argv",
            "cwd",
            "program",
            "source",
            "type"
          ],
          "title": "ExecveGuardianApprovalReviewAction",
          "type": "object"
        },
        {
          "properties": {
            "cwd": {
              "type": "string"
            },
            "files": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "applyPatch"
              ],
              "title": "ApplyPatchGuardianApprovalReviewActionType",
              "type": "string"
            }
          },
          "required": [
            "cwd",
            "files",
            "type"
          ],
          "title": "ApplyPatchGuardianApprovalReviewAction",
          "type": "object"
        },
        {
          "properties": {
            "host": {
              "type": "string"
            },
            "port": {
              "format": "uint16",
              "minimum": 0.0,
              "type": "integer"
            },
            "protocol": {
              "$ref": "#/definitions/NetworkApprovalProtocol"
            },
            "target": {
              "type": "string"
            },
            "type": {
              "enum": [
                "networkAccess"
              ],
              "title": "NetworkAccessGuardianApprovalReviewActionType",
              "type": "string"
            }
          },
          "required": [
            "host",
            "port",
            "protocol",
            "target",
            "type"
          ],
          "title": "NetworkAccessGuardianApprovalReviewAction",
          "type": "object"
        },
        {
          "properties": {
            "connectorId": {
              "type": [
                "string",
                "null"
              ]
            },
            "connectorName": {
              "type": [
                "string",
                "null"
              ]
            },
            "server": {
              "type": "string"
            },
            "toolName": {
              "type": "string"
            },
            "toolTitle": {
              "type": [
                "string",
                "null"
              ]
            },
            "type": {
              "enum": [
                "mcpToolCall"
              ],
              "title": "McpToolCallGuardianApprovalReviewActionType",
              "type": "string"
            }
          },
          "required": [
            "server",
            "toolName",
            "type"
          ],
          "title": "McpToolCallGuardianApprovalReviewAction",
          "type": "object"
        }
      ]
    },
    "GuardianApprovalReviewStatus": {
      "description": "[UNSTABLE] Lifecycle state for a guardian approval review.",
      "enum": [
        "inProgress",
        "approved",
        "denied",
        "timedOut",
        "aborted"
      ],
      "type": "string"
    },
    "GuardianCommandSource": {
      "enum": [
        "shell",
        "unifiedExec"
      ],
      "type": "string"
    },
    "GuardianRiskLevel": {
      "description": "[UNSTABLE] Risk level assigned by guardian approval review.",
      "enum": [
        "low",
        "medium",
        "high",
        "critical"
      ],
      "type": "string"
    },
    "GuardianUserAuthorization": {
      "description": "[UNSTABLE] Authorization level assigned by guardian approval review.",
      "enum": [
        "unknown",
        "low",
        "medium",
        "high"
      ],
      "type": "string"
    },
    "NetworkApprovalProtocol": {
      "enum": [
        "http",
        "https",
        "socks5Tcp",
        "socks5Udp"
      ],
      "type": "string"
    }
  },
  "description": "[UNSTABLE] Temporary notification payload for guardian automatic approval review. This shape is expected to change soon.\n\nTODO(ccunningham): Attach guardian review state to the reviewed tool item's lifecycle instead of sending separate standalone review notifications so the app-server API can persist and replay review state via `thread/read`.",
  "properties": {
    "action": {
      "$ref": "#/definitions/GuardianApprovalReviewAction"
    },
    "review": {
      "$ref": "#/definitions/GuardianApprovalReview"
    },
    "targetItemId": {
      "type": "string"
    },
    "threadId": {
      "type": "string"
    },
    "turnId": {
      "type": "string"
    }
  },
  "required": [
    "action",
    "review",
    "targetItemId",
    "threadId",
    "turnId"
  ],
  "title": "ItemGuardianApprovalReviewStartedNotification",
  "type": "object"
}