QLqlty
Components

List components

Changed on

Retrieve all Components defined for a Project. Supports JSON, newline-delimited JSON (application/x-ndjson), and CSV (text/csv) response formats via the Accept header.

get/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/components

Request

  • Base URL
    https://api.qlty.sh
  • Auth
    HTTP bearer

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp
projectKeyOrIdstring required

Repository name or project ID

Example:my-repo

Response

List components for the project

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Backend API",
      "description": "Core backend API services",
      "pathGlobs": [
        "src/api/*"
      ],
      "fileCount": 42
    }
  ]
}

Changes

  • b61e0586adfeRevision changes
    • breaking

      the // response's property type changed from string to array for status