Skip to main content
Version: v5.6.1

Action

Included from Basic tier

An action is one entry of an asset's merged action catalog: stored template actions, declarative action-file actions and MintModel step trees, read together and sorted by full_path. The catalog is read-only through the API — entries change when the asset's template version, action files or MintModel change. The Ruby lane is only applicable to existing MintPress customers and those using the MintPress SDK or the packs:mintpress feature; Ruby-lane entries are annotated, never hidden. Served by the v2 ActionService (ListActions, GetAction); reads require read on the asset's node path, and a non-asset node is refused (only assets have an action catalog).

Action​

Action is one catalog entry: the identity fields typed for filtering, and the full entry document as JSON text — the opschain-core action-tree shape (action, step_name, full_path, description, children, child_execution_strategy, stage_step, ignore_failure, pre_reqs, input_arguments, mintpress_ctl_cmdline), served as the v1 endpoints serve it so the recursive open structure is never lossily retyped.

FieldTypeMeaning
actionstringThe action's invocation name (the v1 resource id).
descriptionstringFree-text description.
entitlement_requiredbooleanTrue when the entry's Ruby lane is gated behind a licence entitlement this server does not hold (packs:mintpress — visible but gated, never hidden). Invoking it refuses with ERROR_REASON_FEATURE_ENTITLEMENT_REQUIRED.
entry_jsonstringThe catalog entry as JSON text (children included per the request).
full_pathstringThe entry's slash-joined position in the action tree — the catalog's ascending sort key.
runner_requirementstring"ruby" when the entry executes through the Ruby (opschain-core / MintPress) runner lane — only applicable to existing MintPress customers and those using the MintPress SDK or the packs:mintpress feature; empty for declarative action-file entries.
step_namestringThe entry's step name within the action tree; GetAction matches the action name or the step name, case-insensitively.
summarystringThe resolved one-line summary: the entry's explicit summary, else the description's first sentence (else first line), truncated with an ellipsis at 120 characters. Lists render this; description stays the full operator detail.

ActionStage​

ActionStage selects which stage's properties pins a change/step converge reads.

Values: ACTION_STAGE_UNSPECIFIED, ACTION_STAGE_PRE, ACTION_STAGE_POST.

  • opschain docs orchestration — how actions compile and execute.
  • opschain docs resources/asset — the node kind that carries an action catalog.
  • opschain docs packs-mintpress — the Ruby-lane entitlement.