Update package metadata

Update allowed mutable metadata or visibility without rewriting immutable version history.

PATCH /api/v1/users/{user_id}/registry/packages/{kind}/{package_id}

Update package metadata

cURL

curl --request PATCH \
  --url https://sprites-gateway.api.synthlabs.ai/api/v1/users/{user_id}/registry/packages/{kind}/{package_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "display_name": "<string>"
}
'

200

{
  "access": "owned",
  "canonical_ref": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "task",
  "mutable": true,
  "name": "<string>",
  "namespace": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "visibility": "private",
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "display_name": "<string>"
}

Authorizations

Authorization · string · header · required

Synth customer access token for the current user and organization.

Path Parameters

user_id · string<uuid> · required

kind · enum<string> · required

Available options: task, dataset

package_id · string<uuid> · required

Body

application/json

Deliberately bounded package metadata and publication mutation.

description · string | null

Maximum string length: 2000

display_name · string | null

Required string length: 1 - 255

visibility · enum<string> | null

Available options: private, org, public

Response

200

application/json

Successful Response

Safe package summary without storage, actor, or tenant identifiers.

access · enum<string> · required

Why the authenticated customer can read one package.

Available options: owned, organization, public

canonical_ref · string · required

Required string length: 3 - 511

created_at · string<date-time> · required

id · string<uuid> · required

kind · enum<string> · required

Available options: task, dataset

mutable · boolean · required

name · string · required

Required string length: 1 - 255

namespace · string · required

Required string length: 1 - 255

updated_at · string<date-time> · required

visibility · enum<string> · required

Available options: private, org, public

current_version_id · string<uuid> | null

description · string | null

Maximum string length: 2000

display_name · string | null

Maximum string length: 255