quality

Returns packaged hotspot recommendations for a repo-scoped file path.

get/api/projects/{project-id}/quality/hotspots/recommendations

Request

  • Base URL: https://codescene.io (the document declares no server; this is the origin it was published from)
  • URL: https://codescene.io/api/projects/{project-id}/quality/hotspots/recommendations
  • Auth: none declared

Path parameters

project-idinteger required

Query parameters

pathstring required

Response

OR

Example response

{
  "path": "sample-repo/src/Pricing.java",
  "hotspotName": "sample-repo/src/Pricing.java",
  "recommendations": [
    {
      "rank": 1,
      "scope": "function",
      "target": "calculatePrice",
      "recommendationType": "unhealthy_hotspot_with_defect_history_and_complexity",
      "text": "calculatePrice changes frequently, has Code Health issues, has also been associated with defect history, and combines those problems with high complexity.",
      "evidence": {
        "revisions": 42,
        "loc": 74,
        "cyclomaticComplexity": 18,
        "defects": 5,
        "codeHealthIssues": [
          "Deep, Nested Complexity",
          "Complex Method"
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.