Skip to main content
PATCH
Update Movespec

Authorizations

Authorization
string
header
required

Backend-issued machine access token for project-scoped API access.

Path Parameters

movespec_id
string<uuid>
required

Body

application/json

Patch-MoveSpec metadata request payload.

description
string | null

Updated human-readable description.

Maximum string length: 255
name
string | null

Updated display name.

Maximum string length: 255
visibility
enum<string> | null

Updated visibility setting. Only 'private' and 'public' may be set via the API. The 'delisted' visibility is moderation-only and cannot be set by external callers.

Available options:
private,
public

Response

Successful Response

Public MoveSpec resource returned to external API consumers.

Internal/first-party fields (organization_id, created_by, updated_by, caller_starred) have been moved to MoveSpecFirstPartyResource (#31).

caller_starred returns False for anonymous callers instead of None (#73). It has been moved to the first-party variant.

created_at
string<date-time>
required

Creation timestamp.

movespec_id
string<uuid>
required

MoveSpec identifier.

name
string
required

Display name for the MoveSpec.

project_id
string<uuid>
required

Owning project identifier.

updated_at
string<date-time>
required

Last metadata or release-pointer update timestamp.

visibility
enum<string>
required

Visibility setting. 'delisted' is moderation-only and cannot be set via the API.

Available options:
private,
public,
delisted
archived_at
string<date-time> | null

Archive timestamp when no longer writable.

current_released_version_id
string<uuid> | null

Current released immutable version when one exists.

description
string | null

Human-readable description.

star_count
integer
default:0

Total organization-level stars for this MoveSpec.