repos

Update a repo

Patch the label or the description. name is immutable — it is the machine handle — and source_uri is fixed at create, because it is the row's identity and the unique key.

patch/registry/v1/repos/{repo_id}

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/repos/{repo_id}
  • Auth: HTTP bearer

Path parameters

repo_idstring required

Repo handle (repo_…)

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

descriptionstring nullable

Absent leaves it unchanged; null clears it.

display_namestring nullable

Human-readable name.

namestring nullable

Immutable. Present at all ⇒ 422.

Response

OK

created_atstring required

RFC 3339 strings, matching the shipped contract. Changing them to typed timestamps is the api-contract skill's call, not a side effect of a store swap.

created_bystring required

Value of the created_by field.

descriptionstring nullable

Human-readable description.

display_namestring required

Human-readable name.

idstring required

Stable identifier of this resource.

namestring required

Stable machine-readable name.

project_idstring nullable

Stable identifier of the related project resource.

repo_statusstring required

The lifecycle state. repo_status, not status — see ProjectDto::project_status; registry_model::repo::Entity likewise declares ("status", "repo_status") retired, so the response served the one name the request refused.

source_metadataobject nullable

The provenance bag as stored. Served so the write round-trips: the contributor writer reads one key out of it, and a caller that could not read back what it sent has no way to tell a dropped bag from an accepted one.

source_typestring required

Value of the source_type field.

source_uristring nullable

Value of the source_uri field.

updated_atstring required

Value of the updated_at field.

updated_bystring required

Value of the updated_by field.

workspace_idstring required

Stable identifier of the related workspace resource.

Changes

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