643 matches
22 actions
LGTM API specification
22 actions
Other/LGTM API specification
Get the results of a code review using the review identifier for the task.
When you request a code review, the response includes a task result URL of the form: /codereviews/{review-id}.
This endpoint reports the results of a complete code review, or the status of a review that's still in progress.
{
"type": "object",
"properties": {
"review-id": {
"type": "string"
}
},
"required": [
"review-id"
],
"additionalProperties": false
}{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier for the review."
},
"languages": {
"type": "array",
"description": "Detailed information for each language analyzed.",
"items": {
"type": "object",
"properties": {
"alerts": {
"type": "array",
"description": "The list of added and fixed alerts per query for this language.",
"items": {
"type": "object",
"properties": {
"fixed": {
"type": "integer",
"format": "int32",
"description": "The number of alerts fixed by the patch for this query."
},
"new": {
"type": "integer",
"format": "int32",
"description": "The number of alerts introduced by the patch for this query."
},
"query": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The numeric identifier of the query."
},
"language": {
"type": "string",
"description": "The [language code](https://lgtm.com/help/lgtm/analysis-faqs#which-languages-are-supported) of the query."
},
"name": {
"type": "string",
"description": "The `@name` of the query."
},
"pack": {
"type": "string",
"description": "The name of the query pack that contains the query."
},
"properties": {
"type": "object",
"properties": {
"id": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "object",
"additionalProperties": true
},
"severity": {
"type": "object",
"additionalProperties": true
},
"tags": {
"type": "object",
"additionalProperties": true
}
}
},
"url": {
"type": "string",
"description": "A page on LGTM to view the details of the query."
}
}
}
}
}
},
"fixed": {
"type": "integer",
"format": "int32",
"description": "The total number of alerts fixed by the patch for this language."
},
"language": {
"type": "string",
"description": "The language analyzed."
},
"new": {
"type": "integer",
"format": "int32",
"description": "The total number of alerts introduced by the patch for this language."
},
"status": {
"type": "string",
"description": "The status for analysis of this language.",
"enum": [
"pending",
"failure",
"success"
]
},
"status-message": {
"type": "string",
"description": "The current state of analysis of this langauge. When available, a summary of analysis results."
}
}
}
},
"results-url": {
"type": "string",
"description": "A page on LGTM to view the status and results of this code review."
},
"status": {
"type": "string",
"description": "The status of the code review.",
"enum": [
"pending",
"failure",
"success"
]
},
"status-message": {
"type": "string",
"description": "A summary of the current status of the code review."
}
}
}
}