Backstage · JSON Structure

Scaffolder Action Structure

Action schema from Backstage scaffolder API

Type: object Properties: 3
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

Action is a JSON Structure definition published by Backstage, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id description schema

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-structure/scaffolder-action-structure.json",
  "name": "Action",
  "description": "Action schema from Backstage scaffolder API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the action.",
      "example": "fetch:plain"
    },
    "description": {
      "type": "string",
      "description": "A human-readable description of the action."
    },
    "schema": {
      "type": "object",
      "properties": {
        "input": {
          "type": "object",
          "description": "JSON Schema for the action input."
        },
        "output": {
          "type": "object",
          "description": "JSON Schema for the action output."
        }
      }
    }
  }
}