← Files Codex SecurityARCHIVED FILE

schemas/coverage.schema.json

3.8 KB · Nov 21, 2026 · 18:10 UTC

↓ Download file

See the change to this file →

{
  "$id": "https://openai.com/codex-security/schemas/coverage.schema.json",
  "title": "Codex Security scan coverage",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentType": { "const": "codex-security.coverage" },
    "schemaVersion": { "const": "1.0" },
    "scanId": { "type": "string", "minLength": 1 },
    "mode": {
      "enum": [
        "repository",
        "scoped_path",
        "diff",
        "commit",
        "branch_diff",
        "working_tree",
        "deep_repository"
      ]
    },
    "inventoryStrategy": {
      "enum": ["repository", "scoped_path", "diff", "directory", "custom"]
    },
    "includePaths": { "type": "array", "items": { "type": "string" } },
    "excludePaths": { "type": "array", "items": { "type": "string" } },
    "surfaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "label": { "type": "string", "minLength": 1 },
          "disposition": {
            "enum": [
              "reported",
              "no_issue_found",
              "rejected",
              "not_applicable",
              "needs_follow_up"
            ]
          },
          "receiptRefs": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "pattern": "^(?!.*(?:^|/)\\.\\.(?:/|$))(?!.*\\\\)artifacts/.+$"
            }
          },
          "riskArea": { "type": "string", "minLength": 1 },
          "notes": { "type": "string", "minLength": 1 }
        },
        "required": ["id", "label", "disposition", "receiptRefs"]
      }
    },
    "explicitExclusions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pattern": { "type": "string", "minLength": 1 },
          "reason": { "type": "string", "minLength": 1 }
        },
        "required": ["pattern", "reason"]
      }
    },
    "deferred": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "reason": { "type": "string", "minLength": 1 },
          "paths": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "oneOf": [
                {},
                {
                  "type": "string",
                  "$comment": "invalidSealedDeferredPath",
                  "pattern": "^(?:/|[A-Za-z]:)|(?:^|/)\\.\\.(?:/|$)|[\\\\\\x00-\\x1f]|[\\ud800-\\udbff](?![\\udc00-\\udfff])|(?:^|[^\\ud800-\\udbff])[\\udc00-\\udfff]"
                }
              ]
            }
          },
          "surfaceIds": {
            "type": "array",
            "items": { "type": "string", "minLength": 1 }
          }
        },
        "required": ["id", "reason"]
      }
    },
    "resolvedDeferred": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "reason": { "type": "string", "minLength": 1 }
        },
        "required": ["id", "reason"],
        "additionalProperties": false
      },
      "description": "Completed generic review tasks, with their saved IDs and completion reasons."
    },
    "openQuestions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "question": { "type": "string", "minLength": 1 },
          "followUpPrompt": { "type": "string", "minLength": 1 }
        },
        "required": ["question"]
      }
    }
  },
  "required": [
    "documentType",
    "schemaVersion",
    "scanId",
    "mode",
    "inventoryStrategy",
    "includePaths",
    "excludePaths",
    "surfaces",
    "explicitExclusions",
    "deferred"
  ]
}

SHA-256: 3629bdde34e73e13be85d54c81487805677560c6d7c9077a50444715afcf188d