secret-scanning-location

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/main/json-schema/github-secret-scanning-location-schema.json",
  "title": "secret-scanning-location",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/github-secret-scanning-api-openapi.yml#/components/schemas/secret-scanning-location",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "commit",
        "issue_title",
        "issue_body",
        "issue_comment",
        "discussion_title",
        "discussion_body",
        "discussion_comment",
        "pull_request_title",
        "pull_request_body",
        "pull_request_comment",
        "pull_request_review",
        "pull_request_review_comment"
      ],
      "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found."
    },
    "details": {
      "oneOf": [
        {
          "$ref": "#/$defs/secret-scanning-location-commit"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-issue-title"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-issue-body"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-issue-comment"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-discussion-title"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-discussion-body"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-discussion-comment"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-pull-request-title"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-pull-request-body"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-pull-request-comment"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-pull-request-review"
        },
        {
          "$ref": "#/$defs/secret-scanning-location-pull-request-review-comment"
        }
      ]
    }
  },
  "required": [
    "type",
    "details"
  ],
  "$defs": {
    "secret-scanning-location-commit": {
      "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.",
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "description": "The file path in the repository"
        },
        "start_line": {
          "type": "number",
          "description": "Line number at which the secret starts in the file"
        },
        "end_line": {
          "type": "number",
          "description": "Line number at which the secret ends in the file"
        },
        "start_column": {
          "type": "number",
          "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII"
        },
        "end_column": {
          "type": "number",
          "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII"
        },
        "blob_sha": {
          "type": "string",
          "description": "SHA-1 hash ID of the associated blob"
        },
        "blob_url": {
          "type": "string",
          "description": "The API URL to get the associated blob resource"
        },
        "commit_sha": {
          "type": "string",
          "description": "SHA-1 hash ID of the associated commit"
        },
        "commit_url": {
          "type": "string",
          "description": "The API URL to get the associated commit resource"
        }
      },
      "required": [
        "path",
        "start_line",
        "end_line",
        "start_column",
        "end_column",
        "blob_sha",
        "blob_url",
        "commit_sha",
        "commit_url"
      ]
    },
    "secret-scanning-location-discussion-body": {
      "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.",
      "type": "object",
      "properties": {
        "discussion_body_url": {
          "type": "string",
          "format": "uri",
          "description": "The URL to the discussion where the secret was detected."
        }
      },
      "required": [
        "discussion_body_url"
      ]
    },
    "secret-scanning-location-discussion-comment": {
      "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.",
      "type": "object",
      "properties": {
        "discussion_comment_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the discussion comment where the secret was detected."
        }
      },
      "required": [
        "discussion_comment_url"
      ]
    },
    "secret-scanning-location-discussion-title": {
      "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.",
      "type": "object",
      "properties": {
        "discussion_title_url": {
          "type": "string",
          "format": "uri",
          "description": "The URL to the discussion where the secret was detected."
        }
      },
      "required": [
        "discussion_title_url"
      ]
    },
    "secret-scanning-location-issue-body": {
      "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.",
      "type": "object",
      "properties": {
        "issue_body_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the issue where the secret was detected."
        }
      },
      "required": [
        "issue_body_url"
      ]
    },
    "secret-scanning-location-issue-comment": {
      "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.",
      "type": "object",
      "properties": {
        "issue_comment_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the issue comment where the secret was detected."
        }
      },
      "required": [
        "issue_comment_url"
      ]
    },
    "secret-scanning-location-issue-title": {
      "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
      "type": "object",
      "properties": {
        "issue_title_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the issue where the secret was detected."
        }
      },
      "required": [
        "issue_title_url"
      ]
    },
    "secret-scanning-location-pull-request-body": {
      "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.",
      "type": "object",
      "properties": {
        "pull_request_body_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the pull request where the secret was detected."
        }
      },
      "required": [
        "pull_request_body_url"
      ]
    },
    "secret-scanning-location-pull-request-comment": {
      "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.",
      "type": "object",
      "properties": {
        "pull_request_comment_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the pull request comment where the secret was detected."
        }
      },
      "required": [
        "pull_request_comment_url"
      ]
    },
    "secret-scanning-location-pull-request-review": {
      "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.",
      "type": "object",
      "properties": {
        "pull_request_review_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the pull request review where the secret was detected."
        }
      },
      "required": [
        "pull_request_review_url"
      ]
    },
    "secret-scanning-location-pull-request-review-comment": {
      "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.",
      "type": "object",
      "properties": {
        "pull_request_review_comment_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the pull request review comment where the secret was detected."
        }
      },
      "required": [
        "pull_request_review_comment_url"
      ]
    },
    "secret-scanning-location-pull-request-title": {
      "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.",
      "type": "object",
      "properties": {
        "pull_request_title_url": {
          "type": "string",
          "format": "uri",
          "description": "The API URL to get the pull request where the secret was detected."
        }
      },
      "required": [
        "pull_request_title_url"
      ]
    }
  }
}