Module adcp.types.domains.core.warning

Classes

class Warning (**data: Any)
Expand source code
class Warning(AdCPBaseModel):
    model_config = ConfigDict(
        extra='allow',
    )
    code: warning_code.WarningCode
    message: Annotated[
        str,
        Field(
            description='Short human-readable explanation. Treat as untrusted seller text and do not require buyers to parse it for routing.',
            max_length=2000,
            min_length=1,
        ),
    ]
    affected_resource: Annotated[
        warning_resource.WarningAffectedResource,
        Field(
            description='Resource or relationship affected by this warning. Required so multi-package and multi-creative responses remain machine-joinable.'
        ),
    ]
    details: Annotated[
        dict[str, Any] | None,
        Field(
            description='Optional seller-specific structured diagnostics. AdCP 3.2 defines interoperability through code and affected_resource only; buyers MUST NOT require portable keys inside details. Seller extensions that are not direct diagnostics belong in ext.'
        ),
    ] = None
    ext: ext_1.ExtensionObject | None = 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

Subclasses

Class variables

var affected_resource : WarningAffectedResource
var code : WarningCode
var details : dict[str, typing.Any] | None
var ext : ExtensionObject | None
var message : str
var model_config

Inherited members