{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Artifact scanning report",
    "description": "The detail of all the findings for a given artifact",
    "type": "object",
    "required": [
        "release",
        "scan_info",
        "scan_results"
    ],
    "properties": {
        "release": {
            "type": "object",
            "required": [
                "title",
                "package_name",
                "version"
            ],
            "properties": {
                "title": {
                    "type": "string",
                    "examples": [
                        "ggshield 1.0.2"
                    ]
                },
                "package_name": {
                    "type": "string",
                    "examples": [
                        "ggshield"
                    ]
                },
                "version": {
                    "type": "string",
                    "examples": [
                        "1.0.2"
                    ]
                }
            }
        },
        "scan_info": {
            "type": "object",
            "required": [
                "scanner_version",
                "scanned_at"
            ],
            "properties": {
                "scanner_version": {
                    "type": "string",
                    "examples": [
                        "2.99.0"
                    ]
                },
                "scanned_at": {
                    "type": "date-time",
                    "examples": [
                        "2023-11-16T17:10:25Z"
                    ]
                }
            }
        },
        "scan_results": {
            "type": "array",
            "items": {
                "type": "object",
                "required": [
                    "artifact",
                    "secrets"
                ],
                "properties": {
                    "artifact": {
                        "type": "object",
                        "required": [
                            "name",
                            "sha256_digest"
                        ],
                        "properties": {
                            "name": {
                                "type": "string",
                                "examples": [
                                    "ggshield-1.0.2.zip"
                                ]
                            },
                            "sha256_digest": {
                                "type": "string",
                                "examples": [
                                    "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
                                ]
                            }
                        }
                    },
                    "secrets": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "required": [
                                "detector_name",
                                "detector_display_name",
                                "company_name",
                                "filepath",
                                "matches",
                                "validity_status"
                            ],
                            "properties": {
                                "detector_name": {
                                    "type": "string",
                                    "examples": [
                                        "google_aiza"
                                    ]
                                },
                                "detector_display_name": {
                                    "type": "string",
                                    "examples": [
                                        "Google API Key"
                                    ]
                                },
                                "company_name": {
                                    "type": "string",
                                    "examples": [
                                        "Google"
                                    ]
                                },
                                "documentation_url": {
                                    "type": "uri",
                                    "examples": [
                                        "https://docs.gg.com/google_aiza"
                                    ]
                                },
                                "filepath": {
                                    "type": "string",
                                    "examples": [
                                        "/ggshield/connect/google.py"
                                    ]
                                },
                                "matches": {
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "required": [
                                            "match_name",
                                            "index_start",
                                            "index_end"
                                        ],
                                        "properties": {
                                            "match_name": {
                                                "type": "string",
                                                "examples": [
                                                    "apikey"
                                                ]
                                            },
                                            "index_start": {
                                                "type": "integer",
                                                "examples": [
                                                    12
                                                ]
                                            },
                                            "index_end": {
                                                "type": "integer",
                                                "examples": [
                                                    32
                                                ]
                                            }
                                        }
                                    }
                                },
                                "validity_status": {
                                    "type": "string",
                                    "enum": [
                                        "NO_CHECKER",
                                        "FAILED_TO_CHECK",
                                        "VALID",
                                        "INVALID"
                                    ],
                                    "examples": [
                                        "VALID"
                                    ]
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "examples": [
        {
            "release": {
                "title": "ggshield 1.0.2",
                "package_name": "ggshield",
                "version": "1.0.2"
            },
            "scan_info": {
                "scanner_version": "2.99.0",
                "scanned_at": "2023-11-16T17:10:25Z"
            },
            "scan_results": [
                {
                    "artifact": {
                        "name": "ggshield-1.0.2.zip",
                        "sha256_digest": "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
                    },
                    "secrets": [
                        {
                            "detector_name": "google_aiza",
                            "detector_display_name": "Google API Key",
                            "company_name": "Google",
                            "documentation_url": "https://docs.gg.com/google_aiza",
                            "filepath": "/ggshield/connect/google.py",
                            "matches": [
                                {
                                    "match_name": "apikey",
                                    "index_start": 12,
                                    "index_end": 32
                                }
                            ],
                            "validity_status": "VALID"
                        }
                    ]
                }
            ]
        }
    ]
}