codeScanningGetSarif
Get information about a SARIF upload
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id} - Operation ID:
code-scanning/get-sarif
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"sarif_id": {
"description": "The SARIF ID obtained after uploading.",
"required": true,
"location": "path",
"type": "string"
}
}Response Schema
{
"type": "object",
"properties": {
"processing_status": {
"type": "string",
"enum": [
"pending",
"complete",
"failed"
],
"description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed."
},
"analyses_url": {
"type": "string",
"description": "The REST API URL for getting the analyses associated with the upload.",
"format": "uri",
"readOnly": true,
"nullable": true
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Any errors that ocurred during processing of the delivery.",
"readOnly": true,
"nullable": true
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('codeScanningGetSarif', {
# Add required parameters here
})