Skip to main content

Config Repository

This article refers to SDK version v0.5.0. The current SDK version is N/A.

Mounted at client.configs. Reusable, named configuration documents — typed application or global — that a workload's own App Config or a node's/cluster's own Global Config can reference by id, rather than being one itself: useful when the same document needs to be attached to many nodes, clusters, or workloads without duplicating it in every call. See the Overview for narrative examples, and Application configuration types for the equivalent Panel concept.

Concept

Config Repository. A library in Barbara Panel of reusable JSON documents an operator writes once and attaches to many nodes, clusters, or workloads, instead of pasting the same configuration into each one by hand.

Learn more

ConfigsResource​

ConfigsResource(client: BarbaraClient)

list​

list() -> List[Config]

get​

get(config_id: str) -> Config

create​

create(
    name: str,
    description: str,
    config: Dict[str, Any],
    *,
    is_global: bool = False,
) -> Config

update​

update(
    config_id: str,
    *,
    name: Optional[str] = None,
    description: Optional[str] = None,
    config: Optional[Dict[str, Any]] = None,
    is_global: Optional[bool] = None,
) -> Config

delete​

delete(config_id: str) -> None

AsyncConfigsResource​

AsyncConfigsResource(client: AsyncBarbaraClient)

list​

list() -> List[Config]

get​

get(config_id: str) -> Config

create​

create(
    name: str,
    description: str,
    config: Dict[str, Any],
    *,
    is_global: bool = False,
) -> Config

update​

update(
    config_id: str,
    *,
    name: Optional[str] = None,
    description: Optional[str] = None,
    config: Optional[Dict[str, Any]] = None,
    is_global: Optional[bool] = None,
) -> Config

delete​

delete(config_id: str) -> None

Signatures above are generated from barbara-api-sdk 0.5.0 docstrings. If a new SDK release changes one, this page needs a re-sync — the surrounding prose does not update itself.