Module adcp.types.domains.governance.policy_ref

Classes

class PolicyReference (**data: Any)
Expand source code 
class PolicyReference(AdCPBaseModel):
    model_config = ConfigDict(
        extra='forbid',
    )
    policy_id: Annotated[
        str,
        Field(
            description='The unique identifier of the policy in the registry (e.g., "uk_hfss", "us_coppa").'
        ),
    ]
    version: Annotated[
        str | None,
        Field(
            description='Pin a specific policy version (semver). If omitted, the current version is used.'
        ),
    ] = None
    config: Annotated[
        dict[str, Any] | None,
        Field(
            description="Brand-specific parameter overrides for configurable policies. The accepted shape depends on the policy's config_schema."
        ),
    ] = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so unknown fields from newer spec versions are silently dropped rather than causing validation errors. Generated types whose schemas set additionalProperties: true override this with extra='allow' in their own model_config.

Set ADCP_STRICT_VALIDATION=1 in the environment ("1", "true", "yes", "on" are accepted) to flip the default to extra='forbid'. Use this during spec upgrades to catch silently-dropped renamed fields in tests. See :func:_resolve_extra_policy.

Important

The env var is resolved once at module import time. Set it in your shell or CI environment before import adcp runs — mutating os.environ["ADCP_STRICT_VALIDATION"] after the first adcp import has no effect on already-imported model classes (they captured the policy at class-body evaluation).

Consumers who want per-model strict validation can override model_config on their subclass.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

Class variables

var config : dict[str, typing.Any] | None
var model_config
var policy_id : str
var version : str | None

Inherited members