plugin_catalog

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

plugin_catalog(domain: str | None = None) → Tuple[PluginCatalogEntry, ...]

Build a live catalog from each plugin’s constructor contract.

This is the source of truth for Spec("name", {{...}}) and Registry.create("name", ...): names, required/optional parameters, and a one-line purpose come from the registered class and its constructor_signature(), not from a hand-copied table. Third-party plugins with a legacy params_model still publish rows from that schema when present.

Parameters:

domain – Optional v1 domain. Omit to enumerate every catalog domain.

Returns:

Deterministically ordered catalog rows.

Raises:

HABITAPIError – If domain is unknown.