RecommendationSummary ¶

class RecommendationSummary(TypedDict, closed=True):
    file_path: NotRequired["capo_codeguru_reviewer.types.file_path.FilePath"]
    """<p>Name of the file on which a recommendation is provided.</p>"""
    recommendation_id: NotRequired[
        "capo_codeguru_reviewer.types.recommendation_id.RecommendationId"
    ]
    """<p>The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.</p>"""
    start_line: NotRequired["capo_codeguru_reviewer.types.line_number.LineNumber"]
    """<p>Start line from where the recommendation is applicable in the source commit or source branch.</p>"""
    end_line: NotRequired["capo_codeguru_reviewer.types.line_number.LineNumber"]
    """<p>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.</p>"""
    description: NotRequired["capo_codeguru_reviewer.types.text.Text"]
    """<p>A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.</p>"""
    recommendation_category: NotRequired[
        "capo_codeguru_reviewer.types.recommendation_category.RecommendationCategory"
    ]
    """<p>The type of a recommendation.</p>"""
    rule_metadata: NotRequired[
        "capo_codeguru_reviewer.types.rule_metadata.RuleMetadata"
    ]
    """<p>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.</p>"""
    severity: NotRequired["capo_codeguru_reviewer.types.severity.Severity"]
    """<p>The severity of the issue in the code that generated this recommendation.</p>"""