Catalog

Partially update a catalog entity

JSON merge patch: only the properties present in the body change. An explicit null clears a nullable property (namespace, repository). fieldValues merges into the existing values key by key, and a null value removes that field. Read-only properties (id, kindId, createdAt, updatedAt, organizationId) are ignored.

patch/api/rest/v1/catalog/{id}

Request

  • Base URL: https://app.componecat.ai
  • URL: https://app.componecat.ai/api/rest/v1/catalog/{id}
  • Auth: none required

Path parameters

idstring uuid required

The entity ID.

Request body

displayNamestring nullable

Human-readable name (1–250 characters).

namestring nullable

URL-safe identifier (lowercase slug, max 250 characters). Must stay unique per kind + namespace.

namespacestring nullable

Namespace: lowercase alphanumeric with hyphens, max 100 characters. null removes the namespace.

ownerIdstring uuid nullable

ID of the new owning team (see /teams).

lifecycle'EXPERIMENTAL' | 'DEVELOPMENT' | 'PRODUCTION' | 'DEPRECATED' | 'RETIRED' nullable

Lifecycle stage.

descriptionstring nullable

Human-readable description (1–500 characters).

tagsstring[] nullable

Replaces the full tag list.

repositorystring nullable

Source repository URL (HTTPS GitHub, GitLab or Bitbucket). null or an empty string unlinks the repository. Only accepted for kinds with repositories enabled.

fieldValuesobject nullable

Kind-specific custom field values, as a JSON object keyed by each field definition's key (not an array). Send every value in its native JSON type matching the field's type: string (Text, Date, Url, Select, User, Team), number (Number), boolean (Boolean), array of strings (MultiSelect, Tag), or any JSON value (Json). Keys must resolve to field definitions assigned to the entity's kind; unknown keys are rejected. Supplied keys merge into the existing values; a null value removes that field.

Example request

{
  "fieldValues": {
    "costCenter": "CC-100",
    "tier": 1,
    "isPublic": true,
    "environments": [
      "prod",
      "staging"
    ]
  }
}

Response

OK

Example response

{
  "data": {
    "fields": {
      "costCenter": "CC-100",
      "tier": 1,
      "isPublic": true,
      "environments": [
        "prod",
        "staging"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.