Workspace Orchestrator API: schemas
The request and response bodies of the operations in this API.
ApplyLockfileUpgradesResponseDto
| Property | Type | Required | Description |
|---|
lockfile | object | yes | The new lockfile after all dependencies have been re-resolved to latest versions. |
upgrades | array of LockfileUpgradeEntryDto | yes | Entries that were upgraded. |
ApplyLockfileUpgradesResponseDtoDataEnvelope
CreateRuntimeProfileDto
| Property | Type | Required | Description |
|---|
slug | string | yes | |
FreezeLockfileItemRequestDto
| Property | Type | Required | Description |
|---|
ref | string | yes | The dependency ref to freeze (e.g. "skill:doc-editor"). Sets pinned: true on this entry in the lockfile so it is excluded from future upgrade diffs. |
FreezeLockfileItemResponseDto
| Property | Type | Required | Description |
|---|
frozen | boolean | yes | True if the entry was found and frozen. |
lockfile | object | no | Updated lockfile after the freeze. |
ref | string | yes | |
FreezeLockfileItemResponseDtoDataEnvelope
LockfileUpgradeEntryDto
| Property | Type | Required | Description |
|---|
currentVersion | string | yes | |
latestVersion | string | yes | |
ref | string | yes | Dependency ref string, e.g. "skill:doc-editor", "agent:build", "workflow:software-dev", "biome:ubuntu-22.04", "runtimeImage:<image>". |
riskClass | one of "patch", "minor", "major" | yes | Semver distance between currentVersion and latestVersion. |
PendingLockfileUpgradesResponseDto
| Property | Type | Required | Description |
|---|
pending | array of LockfileUpgradeEntryDto | yes | Non-pinned lockfile entries whose registry-latest version differs from the version currently locked for the session. Empty when the session has no lockfile, every entry is pinned, or everything is already on the latest published version. |
PendingLockfileUpgradesResponseDtoDataEnvelope
ProblemActionableBy
Who can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed.
Type: one of "user", "org-admin", "platform", "none"
ProblemDetailsDto
RFC 9457 problem document. The declared members are the reserved core; extension members are TOP-LEVEL and OPEN, owned by the refusing plane.
| Property | Type | Required | Description |
|---|
actionableBy | ProblemActionableBy | no | Who can act on this refusal: user (correct the input, sign in), org-admin (an administrator of the organisation), platform (the operators of this installation), none (nobody — it cannot succeed). ABSENT when not known; never guessed. |
code | string | yes | SCREAMING_SNAKE_CASE. The machine-branchable refusal, and the value a policy rule, a retry predicate and a UI branch all name. |
detail | string | no | Human-readable and specific to THIS occurrence. |
errors | array of ProblemFieldIssueDto | no | Field-level issues, when the refusal is about the request body. |
instance | string | no | URI reference identifying the occurrence — a request path, a run, a row. |
params | map of string or number or boolean | no | Safe i18n interpolation values for the message keyed by code — typed and allowlisted per code by its declaration. Never server-authored copy, never internal diagnostics. |
retry | ProblemRetry | no | What a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known. |
status | number | yes | The HTTP status code, repeated in the body so a logged document is self-contained. |
title | string | yes | Short, human-readable, and STABLE for a given type. Never per-occurrence — that is detail. |
traceId | string | no | W3C trace-context trace-id, present when the caller sent a traceparent. Omitted rather than invented when it did not. |
type | string | yes | Absolute URI identifying the refusal TYPE. Derived one-to-one from code, so a caller may branch on either and can never be told two different things. Never about:blank. |
ProblemFieldIssueDto
| Property | Type | Required | Description |
|---|
code | string | no | SCREAMING_SNAKE_CASE code of THIS issue, for a frontend i18n key. Present when the issue was minted by a declared problem. |
detail | string | yes | Prose for logs and developers. A frontend localises from code + params instead. |
params | map of string or number or boolean | no | Safe i18n interpolation values for this issue's code. |
pointer | string | yes | RFC 6901 JSON Pointer into the request body. Root is "/". |
ProblemRetry
What a retry can achieve: transient (later, unchanged), after-change (only after someone changes something), never (a defect until a fixed version ships). ABSENT when not known.
Type: one of "transient", "after-change", "never"
PublishRuntimeProfileDto
| Property | Type | Required | Description |
|---|
expectedDraftId | string | yes | |
idempotencyKey | string | yes | |
PublishRuntimeProfileResponseDto
PublishRuntimeProfileResponseDtoDataEnvelope
RestoreRuntimeProfileRevisionDto
| Property | Type | Required | Description |
|---|
expectedDraftId | string or null | yes | |
RetireRuntimeProfileDto
Type: object
RollbackRuntimeProfileDto
| Property | Type | Required | Description |
|---|
priorReleaseSetId | string | yes | |
RuntimeProfileDraftResponseDto
| Property | Type | Required | Description |
|---|
baseRevisionId | string or null | no | |
content | object | yes | |
draftId | string | yes | |
resourceId | string | yes | |
restoredFromRevisionId | string or null | no | |
updatedAt | string (date-time) | yes | |
updatedBy | RuntimeProfileSubjectRefResponseDto | yes | |
RuntimeProfileDraftResponseDtoDataArrayEnvelope
RuntimeProfileDraftResponseDtoDataEnvelope
RuntimeProfileIdentityFieldsResponseDto
RuntimeProfileOwnerSpaceRefResponseDto
| Property | Type | Required | Description |
|---|
fence | one of "global", "tenant" | yes | |
orgId | string or null | no | |
space | object | yes | |
RuntimeProfilePointersResponseDto
| Property | Type | Required | Description |
|---|
draftId | string or null | no | |
resourceId | string | yes | |
RuntimeProfileReleaseHistoryResponseDto
| Property | Type | Required | Description |
|---|
actorClientId | string | yes | |
channel | one of "stable" | yes | |
channelVersion | number | yes | |
createdAt | string (date-time) | yes | |
operation | one of "promote", "rollback", "retire" | yes | |
reason | string | yes | |
releaseSetId | string | yes | |
retired | boolean | yes | |
rollbackOfReleaseSetId | string | no | |
target | RuntimeProfileReleaseTargetResponseDto | yes | |
RuntimeProfileReleaseHistoryResponseDtoDataArrayEnvelope
RuntimeProfileReleaseSelectorResponseDto
| Property | Type | Required | Description |
|---|
contentHash | string (sha256) | yes | |
kind | one of "exact" | yes | |
revisionId | string | yes | |
RuntimeProfileReleaseTargetResponseDto
RuntimeProfileResponseDto
RuntimeProfileResponseDtoDataArrayEnvelope
RuntimeProfileResponseDtoDataEnvelope
RuntimeProfileRevisionResponseDto
RuntimeProfileRevisionResponseDtoDataArrayEnvelope
RuntimeProfileRevisionResponseDtoDataEnvelope
RuntimeProfileSubjectRefResponseDto
| Property | Type | Required | Description |
|---|
id | string | yes | |
kind | string | yes | |
SaveRuntimeProfileDraftDto
| Property | Type | Required | Description |
|---|
content | object | yes | |
expectedDraftId | string or null | yes | |