awx_plugins.credentials._types module

Shared interface type definitions for credential plugin schemes.

class awx_plugins.credentials._types.FieldDict

Bases: TypedDict

A single UI field schema.

choices: NotRequired[list[str]]

default: NotRequired[str | bool]

format: NotRequired[str]

help_text: NotRequired[str]

id: str

internal: NotRequired[bool]

label: str

multiline: NotRequired[bool]

secret: NotRequired[bool]

type: NotRequired[str]

class awx_plugins.credentials._types.MetadataDict

Bases: TypedDict

Schema for input metadata.

choices: NotRequired[list[str]]

default: NotRequired[str | bool]

help_text: NotRequired[str]

id: str

label: NotRequired[str]

multiline: NotRequired[bool]

type: NotRequired[str]

class awx_plugins.credentials._types.PluginInputs

Bases: TypedDict

Schema for a collection of plugin input fields.

fields: list[FieldDict]

metadata: list[MetadataDict]

required: list[str]