ResourceMetadata

The resource's identity and human-facing labels. Shared shape across all five resource kinds (blueprints, templates, schemas, assets, functions). The pair (key, version) is the canonical handle for any resource within a namespace.

  • key
    Type: string Pattern: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
    required

    Caller-supplied identifier, unique within the namespace per kind. Stable across versions — a blueprint's key doesn't change when you publish a new version. Snake_case; must start with a lowercase letter.

  • name
    Type: string
    max length:  
    200
    required

    Human-readable display name shown in Studio, list responses, and audit trails (max 200 chars).

  • version
    Type: string
    required

    Either draft (editable; only one draft per key at a time) or a semver like 1.2.0 (immutable once published). On create you choose: pass draft to iterate, or a semver to publish directly.

  • description
    Type: string
    max length:  
    1000

    Optional longer-form description. Helps both humans and AI assistants pick the right resource when browsing the catalog (max 1000 chars).

  • labels
    Type: object

    Arbitrary key/value tags for categorization and filtering — e.g. { "team": "people-ops", "env": "prod" }. Filterable on list endpoints via ?labels[key]=value.

    • propertyName
      Type: string