secret-scanning-location

APIs.ioEngineeringPlatform

Properties

Name Type Description
type string 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 wa
details object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-secret-scanning-location-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/secret-scanning-location",
  "title": "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.",
      "example": "commit"
    },
    "details": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/secret-scanning-location-commit"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-issue-title"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-issue-body"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-issue-comment"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-discussion-title"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-discussion-body"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-discussion-comment"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-pull-request-title"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-pull-request-body"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-pull-request-review"
        },
        {
          "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment"
        }
      ]
    }
  },
  "required": [
    "type",
    "details"
  ]
}