Skip to content

Return upgrade readiness for the active artifact, working source, and installed offline toolchain.

GET
/api/workspace/admin/ui-project/upgrade-readiness
curl --request GET \
--url https://example.com/api/workspace/admin/ui-project/upgrade-readiness \
--header 'Authorization: Bearer <token>'
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json
object
Data

Upgrade readiness for the singleton Workspace UI project.

object
Status
integer format: int32
Allowed values: 0 1 2 3 4 5 6
NeedsValidation

Whether the working source still requires validation with the installed toolchain.

boolean
IsRuntimeCompatible

Whether the active artifact can run against the installed browser host contract.

boolean
IsSourceValidatedWithCurrentToolchain

Whether the working revision has a successful check or build against the installed toolchain and host contract.

boolean
IsBuildToolchainReady

Whether the packaged offline toolchain passed its readiness probe.

boolean
IsRuntimeContractReady

Whether packaged runtime-contract metadata is valid.

boolean
WorkingRevisionId

Working source revision identifier.

string
nullable
ActiveArtifactId

Active artifact identifier.

string
nullable
ActiveArtifactHostContractVersion

Host contract version recorded by the active artifact.

integer format: int32
nullable
ActiveArtifactToolchainFingerprint

Toolchain fingerprint recorded by the active artifact.

string
nullable
IsActiveArtifactBuiltWithCurrentToolchain

Whether the active artifact was built with the installed toolchain fingerprint.

boolean
HostContractVersion

Installed host contract version.

integer format: int32
nullable
HostContractFingerprint

Installed host contract fingerprint.

string
nullable
ToolchainFingerprint

Installed offline toolchain fingerprint.

string
nullable
NextActionCode

Stable operator next-action code.

string
nullable
ProjectRowVersion

Current project concurrency token.

string format: uuid
nullable
Diagnostics

Bounded localized diagnostics without deployment paths.

Array<object>
nullable

One safe Workspace UI compatibility diagnostic.

object
Code

Stable diagnostic code without deployment details.

string
nullable
Message

Localized operator-facing message.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Status": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}