Apache Iceberg · Schema

CompletedPlanningResult

Completed server-side planning result

ACIDAnalyticsApacheData LakeLakehouseOpen SourceTable Format
View JSON Schema on GitHub

JSON Schema

rest-catalog-open-api-completed-planning-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-iceberg/refs/heads/main/json-schema/rest-catalog-open-api-completed-planning-result-schema.json",
  "title": "CompletedPlanningResult",
  "description": "Completed server-side planning result",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/ScanTasks"
    },
    {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "$ref": "#/components/schemas/PlanStatus",
          "const": "completed"
        },
        "storage-credentials": {
          "type": "array",
          "description": "Storage credentials for accessing the files returned in the scan result.\nIf the server returns storage credentials as part of the completed scan planning response, the expectation is for the client to use these credentials to read the files returned in the FileScanTasks as part of the scan result.",
          "items": {
            "$ref": "#/components/schemas/StorageCredential"
          }
        }
      }
    }
  ]
}