Update Repository

PATCH

/registry/v1/workspaces/{workspace}/engines/{engine}/repositories/{id}

const url = 'https://example.com/registry/v1/workspaces/example/engines/example/repositories/example';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example","visibility":"VISIBILITY_UNSPECIFIED","qibdo":{"immutable_tags":true}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/registry/v1/workspaces/example/engines/example/repositories/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "visibility": "VISIBILITY_UNSPECIFIED", "qibdo": { "immutable_tags": true } }'

Updates the visibility, description, or provider-specific attributes of a repository.

Parameters

Path Parameters

workspace

required

string

The workspace the repository belongs to.

engine

required

string

The provider: qibdo, or - to target across all providers.

required

string

The unique identifier of the repository to update.

Query Parameters

update_mask

string format: field-mask

The set of fields to update. If omitted, all mutable fields are overwritten. See AIP-134 for field mask semantics.

Request Body^required

application/json

A repository is a workspace-scoped, named collection of artifacts (e.g. nginx, ci/web-app). It is the only first-class registry resource: it carries visibility, format metadata, and is the parent scope for artifacts, deployment locks, retention policies, and scan policies. Repositories can be provisioned across different providers; the provider a repository lives on is reported by the read-only engine field.

object

The unique identifier of the repository.

stringOutput only

workspace_id

The workspace this repository belongs to.

stringOutput only

name

required

The repository name — a slash-capable OCI path (e.g. nginx, ci/web-app). Each slash-separated segment is a DNS-label-style token; the whole name is unique within the workspace and must not itself be a UUID. Slashes are carried in a single URL-encoded path segment on the wire (never a multi-segment wildcard).

string

description

An optional human-readable description of the repository.

string

visibility

Repository visibility. Defaults to PRIVATE — the workspace is the isolation boundary.

string format: enum

Allowed values: VISIBILITY_UNSPECIFIED VISIBILITY_PRIVATE VISIBILITY_PUBLIC

format

The artifact format stored in this repository. Defaults to DOCKER. Set at creation time, not updatable.

string format: enum Output only

Allowed values: REPOSITORY_FORMAT_UNSPECIFIED REPOSITORY_FORMAT_DOCKER REPOSITORY_FORMAT_HELM REPOSITORY_FORMAT_OCI

origin

How the repository came to exist: CREATED via the API, or DISCOVERED when an image was pushed to an unregistered name. Informational only — the two are indistinguishable to consumers once the repository exists.

string format: enum Output only

Allowed values: REPOSITORY_ORIGIN_UNSPECIFIED REPOSITORY_ORIGIN_CREATED REPOSITORY_ORIGIN_DISCOVERED

engine

The provider this repository is provisioned on.

string format: enum Output only

Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO

create_time

Timestamp when the repository was created.

string format: date-time Output only

update_time

Timestamp when the repository was last updated.

string format: date-time Output only

qibdo

Attributes specific to a Qibdo-managed repository.

object

immutable_tags

Whether tag immutability is enforced on this repository — the registry refuses to overwrite an existing tag on push. Kept provider-specific rather than shared at the top level.

boolean

Responses

200

application/json

Registry Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “com.qibdo.cloud.registry:repository”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: REGISTRY_OPERATION_TYPE_UNSPECIFIED REGISTRY_OPERATION_TYPE_CREATE REGISTRY_OPERATION_TYPE_UPDATE REGISTRY_OPERATION_TYPE_DELETE REGISTRY_OPERATION_TYPE_TRIGGER

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: REGISTRY_OPERATION_STATUS_UNSPECIFIED REGISTRY_OPERATION_STATUS_PENDING REGISTRY_OPERATION_STATUS_RUNNING REGISTRY_OPERATION_STATUS_DONE REGISTRY_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

reason

Reason

Machine-readable error identifier in UPPER_SNAKE form — the same dispatch key google.rpc.ErrorInfo.reason carries on the synchronous error plane.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

scope_type

Scope Type

The category of scope the operation ran in or was triggered from. REGISTRY_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.

string format: enum Output only

Allowed values: REGISTRY_SCOPE_TYPE_UNSPECIFIED REGISTRY_SCOPE_TYPE_PLATFORM REGISTRY_SCOPE_TYPE_ORGANISATION REGISTRY_SCOPE_TYPE_WORKSPACE REGISTRY_SCOPE_TYPE_GROUP

scope_id

Scope ID

The resource this operation was scoped to — for example, when scope_type is REGISTRY_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for REGISTRY_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.

stringOutput only

principal_id

Principal ID

Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.

stringOutput only

trace_id

Trace ID

W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.

stringOutput only

Example

{
  "operation_type": "REGISTRY_OPERATION_TYPE_UNSPECIFIED",
  "status": "REGISTRY_OPERATION_STATUS_UNSPECIFIED",
  "scope_type": "REGISTRY_SCOPE_TYPE_UNSPECIFIED"
}

default

Default error response

application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Update Repository

Parameters

Path Parameters

Query Parameters

Request Body required

Responses

200

Example

default

Example generated

Request Body^required

Example ^generated