APIs.io Engineering Platform · Schema

secret-scanning-location-commit

Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
path	string	The file path in the repository
start_line	number	Line number at which the secret starts in the file
end_line	number	Line number at which the secret ends in the file
start_column	number	The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
end_column	number	The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
blob_sha	string	SHA-1 hash ID of the associated blob
blob_url	string	The API URL to get the associated blob resource
commit_sha	string	SHA-1 hash ID of the associated commit
commit_url	string	The API URL to get the associated commit resource

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/secret-scanning-location-commit",
  "title": "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",
      "example": "/example/secrets.txt"
    },
    "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",
      "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
    },
    "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",
      "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
    },
    "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"
  ]
}