Answers are generated based on the documentation.

Experimental

API version Product manual Download OpenAPI specification Markdown

Schema

Sandbox

Type: object

Sandbox carries shared core state and the effective state of its selected features. uid must equal the immutable resource ID in name

core · required

Schema: SandboxCore

core is the backend-neutral sandbox view.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/SandboxCore",
  "description": "core is the backend-neutral sandbox view."
}

displayName

Type: string

display_name is the scoped label; UpdateSandbox changes it without changing identity.

All schema constraints and annotations

{
  "description": "display_name is the scoped label; UpdateSandbox changes it without changing identity.",
  "type": "string"
}

effectiveFeatures

Schema: EffectiveFeatures

effective_features is emitted only by the composition contract projection.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/EffectiveFeatures",
  "description": "effective_features is emitted only by the composition contract projection."
}

failure · response only

Schema: Error

failure is present only while status is FAILED and clears on recovery.

All schema constraints and annotations

{
  "$ref": "#/components/schemas/Error",
  "description": "failure is present only while status is FAILED and clears on recovery.",
  "readOnly": true
}

name · required

Type: string

(IDENTIFIER) name ends in the immutable backing ID and never changes with display_name.

All schema constraints and annotations

{
  "description": "(IDENTIFIER) name ends in the immutable backing ID and never changes with display_name.",
  "pattern": "^sandboxes/[^/]+$",
  "type": "string"
}

uid · required · response only

Type: string

(IMMUTABLE) uid is the existing backing ID, equal to the resource name's terminal segment.

All schema constraints and annotations

{
  "description": "(IMMUTABLE) uid is the existing backing ID, equal to the resource name's terminal segment.",
  "minLength": 1,
  "readOnly": true,
  "type": [
    "string"
  ]
}

All schema constraints and annotations

{
  "description": "Sandbox carries shared core state and the effective state of its selected features.\nuid must equal the immutable resource ID in name",
  "properties": {
    "core": {
      "$ref": "#/components/schemas/SandboxCore",
      "description": "core is the backend-neutral sandbox view."
    },
    "displayName": {
      "description": "display_name is the scoped label; UpdateSandbox changes it without changing identity.",
      "type": "string"
    },
    "effectiveFeatures": {
      "$ref": "#/components/schemas/EffectiveFeatures",
      "description": "effective_features is emitted only by the composition contract projection."
    },
    "failure": {
      "$ref": "#/components/schemas/Error",
      "description": "failure is present only while status is FAILED and clears on recovery.",
      "readOnly": true
    },
    "name": {
      "description": "(IDENTIFIER) name ends in the immutable backing ID and never changes with display_name.",
      "pattern": "^sandboxes/[^/]+$",
      "type": "string"
    },
    "uid": {
      "description": "(IMMUTABLE) uid is the existing backing ID, equal to the resource name's terminal segment.",
      "minLength": 1,
      "readOnly": true,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "core",
    "name",
    "uid"
  ],
  "title": "Sandbox",
  "type": "object"
}