{ "$schema": "https://json-structure.org/meta/core/v0/#", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-reviewer/refs/heads/main/json-structure/amazon-codeguru-reviewer-recommendation-summary-structure.json", "name": "RecommendationSummary", "description": "Information about recommendations.", "type": "object", "properties": { "FilePath": { "allOf": [ { "$ref": "#/components/schemas/FilePath" }, { "description": "Name of the file on which a recommendation is provided." } ] }, "RecommendationId": { "allOf": [ { "$ref": "#/components/schemas/RecommendationId" }, { "description": "The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback." } ] }, "StartLine": { "allOf": [ { "$ref": "#/components/schemas/LineNumber" }, { "description": "Start line from where the recommendation is applicable in the source commit or source branch." } ] }, "EndLine": { "allOf": [ { "$ref": "#/components/schemas/LineNumber" }, { "description": "Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same." } ] }, "Description": { "allOf": [ { "$ref": "#/components/schemas/Text" }, { "description": "A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line." } ] }, "RecommendationCategory": { "allOf": [ { "$ref": "#/components/schemas/RecommendationCategory" }, { "description": "The type of a recommendation." } ] }, "RuleMetadata": { "allOf": [ { "$ref": "#/components/schemas/RuleMetadata" }, { "description": "Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule." } ] }, "Severity": { "allOf": [ { "$ref": "#/components/schemas/Severity" }, { "description": "The severity of the issue in the code that generated this recommendation." } ] } } }