registry-schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/GoCodeAlone/workflow-registry/schema/registry-schema.json",
  "title": "Plugin Manifest",
  "description": "Schema for workflow engine plugin manifests in the GoCodeAlone/workflow-registry",
  "type": "object",
  "required": ["name", "version", "author", "description", "type", "tier", "license"],
  "properties": {
    "name": {
      "type": "string",
      "description": "Unique plugin name (e.g. http, messaging, my-custom-plugin)"
    },
    "version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+",
      "description": "Semantic version (e.g. 1.0.0)"
    },
    "author": {
      "type": "string",
      "description": "Author or organization name"
    },
    "description": {
      "type": "string",
      "description": "Short description of what this plugin provides"
    },
    "source": {
      "type": "string",
      "description": "Source repository (Go module path or URL)"
    },
    "path": {
      "type": "string",
      "description": "Path within the source repository to the plugin package"
    },
    "type": {
      "type": "string",
      "enum": ["builtin", "external", "ui"],
      "description": "Plugin type: builtin (shipped with engine), external (community/third-party), ui (frontend extension)"
    },
    "tier": {
      "type": "string",
      "enum": ["core", "community", "premium"],
      "description": "Plugin tier: core (maintained by GoCodeAlone), community (third-party), premium (paid)"
    },
    "license": {
      "type": "string",
      "description": "SPDX license identifier (e.g. MIT, Apache-2.0)"
    },
    "capabilities": {
      "type": "object",
      "description": "Capability declarations for the plugin",
      "properties": {
        "moduleTypes": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Module type identifiers this plugin registers (e.g. http.server, messaging.broker)"
        },
        "stepTypes": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Pipeline step type identifiers this plugin registers (e.g. step.validate, step.http_call)"
        },
        "triggerTypes": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Trigger type identifiers this plugin registers (e.g. http, schedule, event)"
        },
        "workflowHandlers": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Workflow handler type identifiers this plugin registers (e.g. http, pipeline, statemachine)"
        },
        "wiringHooks": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Post-init wiring hook names this plugin provides"
        },
        "iacProvider": {
          "type": "object",
          "description": "IaC provider declaration — name and supported resource types",
          "properties": {
            "name": {
              "type": "string",
              "description": "Canonical provider name used for discovery (e.g. \"digitalocean\", \"aws\", \"gcp\")"
            },
            "resourceTypes": {
              "type": "array",
              "items": { "type": "string" },
              "description": "Resource types this provider's drivers can manage (e.g. infra.container_service, infra.k8s_cluster)"
            },
            "supportedCanonicalKeys": {
              "type": "array",
              "items": { "type": "string" },
              "description": "Canonical config keys this provider's drivers can map (e.g. name, region, image, env_vars)"
            }
          },
          "required": ["name"],
          "additionalProperties": false
        },
        "migrationDrivers": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Migration driver names this plugin provides (e.g. golang-migrate, goose)"
        },
        "cliCommands": {
          "type": "array",
          "description": "Dynamic wfctl CLI subcommand registrations (workflow v0.18.x+)",
          "items": {
            "type": "object",
            "required": ["name"],
            "properties": {
              "name": {
                "type": "string",
                "description": "Top-level command name registered with wfctl"
              },
              "description": {
                "type": "string"
              },
              "flags_passthrough": {
                "type": "boolean",
                "description": "When true, wfctl passes all flags through to the plugin binary"
              },
              "subcommands": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": ["name"],
                  "properties": {
                    "name": { "type": "string" },
                    "description": { "type": "string" }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          }
        },
        "buildHooks": {
          "type": "array",
          "description": "Build-pipeline hook registrations (workflow v0.18.x+)",
          "items": {
            "type": "object",
            "required": ["event", "priority"],
            "properties": {
              "event": {
                "type": "string",
                "description": "Hook event name (e.g. post_container_build, install_verify)"
              },
              "priority": {
                "type": "integer",
                "description": "Execution priority; lower numbers run first"
              },
              "on_hook_failure": {
                "type": "string",
                "enum": ["fail", "warn", "skip"],
                "description": "How wfctl handles hook failures"
              },
              "description": {
                "type": "string",
                "description": "Human-readable description of what this hook does"
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    },
    "checksums": {
      "type": "object",
      "description": "SHA-256 checksums keyed by version string for integrity verification",
      "additionalProperties": { "type": "string" }
    },
    "minEngineVersion": {
      "type": "string",
      "description": "Minimum workflow engine version required (semver)"
    },
    "keywords": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Search keywords for discovery"
    },
    "homepage": {
      "type": "string",
      "description": "Plugin documentation or homepage URL"
    },
    "repository": {
      "type": "string",
      "description": "Source code repository URL"
    },
    "private": {
      "type": "boolean",
      "description": "Whether this plugin is proprietary / not publicly available"
    },
    "downloads": {
      "type": "array",
      "description": "Binary download artifacts for this plugin version",
      "items": {
        "type": "object",
        "required": ["os", "arch", "url"],
        "properties": {
          "os": {
            "type": "string",
            "enum": ["linux", "darwin", "windows"],
            "description": "Target operating system"
          },
          "arch": {
            "type": "string",
            "enum": ["amd64", "arm64"],
            "description": "Target CPU architecture"
          },
          "url": {
            "type": "string",
            "description": "Download URL for the binary archive"
          },
          "sha256": {
            "type": "string",
            "description": "SHA-256 checksum of the archive"
          }
        },
        "additionalProperties": false
      }
    },
    "assets": {
      "type": "object",
      "description": "Asset capabilities provided by this plugin",
      "properties": {
        "ui": {
          "type": "boolean",
          "description": "Plugin includes an embedded UI"
        },
        "config": {
          "type": "boolean",
          "description": "Plugin provides config fragments via ConfigProvider"
        }
      },
      "additionalProperties": false
    },
    "dependencies": {
      "type": "array",
      "description": "Other plugins that must be installed before this plugin can function",
      "items": {
        "type": "object",
        "required": ["name"],
        "properties": {
          "name": {
            "type": "string",
            "description": "Plugin name as it appears in the registry"
          },
          "minVersion": {
            "type": "string",
            "pattern": "^\\d+\\.\\d+\\.\\d+",
            "description": "Minimum required plugin version (inclusive)"
          },
          "maxVersion": {
            "type": "string",
            "pattern": "^\\d+\\.\\d+\\.\\d+",
            "description": "Maximum allowed plugin version (inclusive)"
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}