Backstage · Schema

Task

Task schema from Backstage scaffolder API

Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

Properties

Name Type Description
id string The unique identifier of the task.
spec object
status string The current status of the task.
createdAt string
lastHeartbeatAt string
completedAt string
createdBy string The user who created the task.
View JSON Schema on GitHub

JSON Schema

scaffolder-task-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-schema/scaffolder-task-schema.json",
  "title": "Task",
  "description": "Task schema from Backstage scaffolder API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the task."
    },
    "spec": {
      "type": "object",
      "properties": {
        "apiVersion": {
          "type": "string"
        },
        "templateInfo": {
          "type": "object",
          "properties": {
            "entityRef": {
              "type": "string",
              "description": "Reference to the template entity."
            }
          }
        },
        "steps": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "action": {
                "type": "string"
              },
              "input": {
                "type": "object"
              }
            }
          }
        },
        "output": {
          "type": "object",
          "additionalProperties": true
        },
        "parameters": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "status": {
      "type": "string",
      "description": "The current status of the task.",
      "enum": [
        "open",
        "processing",
        "completed",
        "failed",
        "cancelled"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "lastHeartbeatAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "type": "string",
      "description": "The user who created the task."
    }
  }
}