Share feedback
Answers are generated based on the documentation.

Experimental

Schema

CreateImageRequest

Type: object

CreateImageRequest creates a managed image.
All constraints apply
description

Type: string

description is caller-supplied text.
All schema constraints and annotations
{
  "description": "description is caller-supplied text.",
  "type": "string"
}
displayName

Type: string

display_name is a scoped label; the backend assigns the immutable resource ID.
All schema constraints and annotations
{
  "description": "display_name is a scoped label; the backend assigns the immutable resource ID.",
  "minLength": 1,
  "not": {
    "enum": [
      ".",
      ".."
    ],
    "type": "string"
  },
  "pattern": "^[^/]+$",
  "type": "string"
}
readyCmd

Type: array

ready_cmd is used to determine readiness for raw image sandboxes.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "ready_cmd is used to determine readiness for raw image sandboxes.",
  "items": {
    "type": "string"
  },
  "type": "array"
}
startCmd

Type: array

start_cmd is used when the image is launched as a raw image sandbox.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "start_cmd is used when the image is launched as a raw image sandbox.",
  "items": {
    "type": "string"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "properties": {
    "description": {
      "description": "description is caller-supplied text.",
      "type": "string"
    },
    "displayName": {
      "description": "display_name is a scoped label; the backend assigns the immutable resource ID.",
      "minLength": 1,
      "not": {
        "enum": [
          ".",
          ".."
        ],
        "type": "string"
      },
      "pattern": "^[^/]+$",
      "type": "string"
    },
    "readyCmd": {
      "description": "ready_cmd is used to determine readiness for raw image sandboxes.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "startCmd": {
      "description": "start_cmd is used when the image is launched as a raw image sandbox.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  }
}
Exactly one alternative must match

Type: object

fromImage · required

Schema: ImageFromImage

from_image registers an entry that will receive pushed OCI content.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/ImageFromImage",
  "description": "from_image registers an entry that will receive pushed OCI content."
}
All schema constraints and annotations
{
  "properties": {
    "fromImage": {
      "$ref": "#/components/schemas/ImageFromImage",
      "description": "from_image registers an entry that will receive pushed OCI content."
    }
  },
  "required": [
    "fromImage"
  ],
  "title": "from_image",
  "type": "object"
}
All schema constraints and annotations
{
  "oneOf": [
    {
      "properties": {
        "fromImage": {
          "$ref": "#/components/schemas/ImageFromImage",
          "description": "from_image registers an entry that will receive pushed OCI content."
        }
      },
      "required": [
        "fromImage"
      ],
      "title": "from_image",
      "type": "object"
    }
  ]
}
All schema constraints and annotations
{
  "allOf": [
    {
      "properties": {
        "description": {
          "description": "description is caller-supplied text.",
          "type": "string"
        },
        "displayName": {
          "description": "display_name is a scoped label; the backend assigns the immutable resource ID.",
          "minLength": 1,
          "not": {
            "enum": [
              ".",
              ".."
            ],
            "type": "string"
          },
          "pattern": "^[^/]+$",
          "type": "string"
        },
        "readyCmd": {
          "description": "ready_cmd is used to determine readiness for raw image sandboxes.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "startCmd": {
          "description": "start_cmd is used when the image is launched as a raw image sandbox.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      }
    },
    {
      "oneOf": [
        {
          "properties": {
            "fromImage": {
              "$ref": "#/components/schemas/ImageFromImage",
              "description": "from_image registers an entry that will receive pushed OCI content."
            }
          },
          "required": [
            "fromImage"
          ],
          "title": "from_image",
          "type": "object"
        }
      ]
    }
  ],
  "description": "CreateImageRequest creates a managed image.",
  "required": [
    "displayName"
  ],
  "title": "CreateImageRequest",
  "type": "object",
  "unevaluatedProperties": false
}