addedOutput schema / $defs
Added value: +{
+ "Report": {
+ "additionalProperties": true,
+ "properties": {
+ "critical": {
+ "description": "Critical findings.",
+ "title": "Critical",
+ "type": "integer"
+ },
+ "grade": {
+ "description": "Letter grade for the score, A to F.",
+ "title": "Grade",
+ "type": "string"
+ },
+ "guidance_locked": {
+ "description": "True when fixes and the fix prompt need a paid plan for this report.",
+ "title": "Guidance Locked",
+ "type": "boolean"
+ },
+ "high": {
+ "description": "High findings.",
+ "title": "High",
+ "type": "integer"
+ },
+ "low": {
+ "description": "Low findings.",
+ "title": "Low",
+ "type": "integer"
+ },
+ "medium": {
+ "description": "Medium findings.",
+ "title": "Medium",
+ "type": "integer"
+ },
+ "scan_id": {
+ "description": "The scan this report summarises.",
+ "title": "Scan Id",
+ "type": "string"
+ },
+ "score": {
+ "description": "Security score from 0 to 100.",
+ "title": "Score",
+ "type": "integer"
+ },
+ "summary_text": {
+ "description": "One plain sentence summing up the report.",
+ "title": "Summary Text",
+ "type": "string"
+ },
+ "top_rules": {
+ "description": "The rules behind the most serious findings.",
+ "items": {
+ "type": "string"
+ },
+ "title": "Top Rules",
+ "type": "array"
+ }
+ },
+ "required": [
+ "scan_id",
+ "score",
+ "grade",
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "top_rules",
+ "summary_text",
+ "guidance_locked"
+ ],
+ "title": "Report",
+ "type": "object"
+ },
+ "ScanSummary": {
+ "additionalProperties": true,
+ "properties": {
+ "commit_sha": {
+ "description": "The exact commit that was scanned.",
+ "title": "Commit Sha",
+ "type": "string"
+ },
+ "created_at": {
+ "description": "When the scan was created, ISO 8601 UTC.",
+ "title": "Created At",
+ "type": "string"
+ },
+ "id": {
+ "description": "The scan_id for sentrint_get_findings and sentrint_get_fix_prompt.",
+ "title": "Id",
+ "type": "string"
+ },
+ "repo_url": {
+ "description": "The GitHub repository that was scanned.",
+ "title": "Repo Url",
+ "type": "string"
+ },
+ "score": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Security score from 0 to 100 once done, else null.",
+ "title": "Score"
+ },
+ "status": {
+ "description": "Such as pending, running, done, failed or cancelled.",
+ "title": "Status",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "When the scan last changed, ISO 8601 UTC.",
+ "title": "Updated At",
+ "type": "string"
+ },
+ "workspace_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The workspace the scan belongs to.",
+ "title": "Workspace Id"
+ }
+ },
+ "required": [
+ "id",
+ "workspace_id",
+ "status",
+ "repo_url",
+ "commit_sha",
+ "score",
+ "created_at",
+ "updated_at"
+ ],
+ "title": "ScanSummary",
+ "type": "object"
+ }
+}
addedOutput schema / properties
Added value: +{
+ "created_at": {
+ "description": "When the submission was made, ISO 8601 UTC.",
+ "title": "Created At",
+ "type": "string"
+ },
+ "done": {
+ "description": "True when polling again cannot change the answer.",
+ "title": "Done",
+ "type": "boolean"
+ },
+ "earlier_scan_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "A report of this commit under older rules, free to read with sentrint_get_findings.",
+ "title": "Earlier Scan Id"
+ },
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Why the submission was rejected, if it was.",
+ "title": "Error Code"
+ },
+ "error_detail": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A sentence explaining error_code.",
+ "title": "Error Detail"
+ },
+ "id": {
+ "description": "The submission_id that was checked.",
+ "title": "Id",
+ "type": "string"
+ },
+ "next_step": {
+ "description": "What to do next, in a sentence written for the agent.",
+ "title": "Next Step",
+ "type": "string"
+ },
+ "report": {
+ "anyOf": [
+ {
+ "$ref": "#/$defs/Report"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Score and counts, once the scan is done."
+ },
+ "reused": {
+ "description": "True when an earlier scan of this commit was reused.",
+ "title": "Reused",
+ "type": "boolean"
+ },
+ "scan": {
+ "anyOf": [
+ {
+ "$ref": "#/$defs/ScanSummary"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The scan, once it exists."
+ },
+ "scan_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The scan, once the submission has one.",
+ "title": "Scan Id"
+ },
+ "scan_status_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The scan in the REST API, once it exists.",
+ "title": "Scan Status Url"
+ },
+ "status": {
+ "description": "accepted, validating, failed or scan_ready.",
+ "title": "Status",
+ "type": "string"
+ },
+ "status_url": {
+ "description": "The same submission in the REST API.",
+ "title": "Status Url",
+ "type": "string"
+ },
+ "updated_at": {
+ "description": "When the submission last changed, ISO 8601 UTC.",
+ "title": "Updated At",
+ "type": "string"
+ }
+}