v3

latestOpenAPI 3.1.02026-07-311725107.3 KB

Components

Update component

Replace a Component's definition. Takes the same fields as create and fully replaces the existing definition; the Component's id and creator are preserved. Requires admin access to the Project, and the Project must have Components enabled.

put/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/components/{componentIdOrName}

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp

Repository owner name (login) or workspace ID

projectKeyOrIdstring required

Repository name or project ID

Example:my-repo

Repository name or project ID

componentIdOrNamestring required

Component ID or name

Example:backend-api

Component ID or name

Request body

namestring required

descriptionstring nullable

pathGlobsstring[] required

Glob patterns matching the Component's file paths, one glob per array element. * matches any characters, including /.

Example request

{
  "name": "Backend API",
  "description": "Core backend API services",
  "pathGlobs": [
    "src/api/*"
  ]
}

Response

The updated component

idstring required

namestring required

descriptionstring nullable required

pathGlobsstring[] required

Example response

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