Module Values.RecommendationSummarySource

Information about recommendations.

Sourcetype nonrec t = {
  1. filePath : FilePath.t option;
    (*

    Name of the file on which a recommendation is provided.

    *)
  2. recommendationId : RecommendationId.t option;
    (*

    The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

    *)
  3. startLine : LineNumber.t option;
    (*

    Start line from where the recommendation is applicable in the source commit or source branch.

    *)
  4. endLine : LineNumber.t option;
    (*

    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.

    *)
  5. description : Text.t option;
    (*

    A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

    *)
  6. recommendationCategory : RecommendationCategory.t option;
    (*

    The type of a recommendation.

    *)
  7. ruleMetadata : RuleMetadata.t option;
    (*

    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.

    *)
  8. severity : Severity.t option;
    (*

    The severity of the issue in the code that generated this recommendation.

    *)
}
Sourceval make : ?filePath:??? -> ?recommendationId:??? -> ?startLine:??? -> ?endLine:??? -> ?description:??? -> ?recommendationCategory:??? -> ?ruleMetadata:??? -> ?severity:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of LineNumber.t | `String of FilePath.t | `Structure of (string * [> `List of [> `String of RuleTag.t ] list | `String of RuleId.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t