@archastro/sdk
    Preparing search index...

    Interface SolutionUpgradeResult

    The outcome of a solution upgrade operation, including the computed diff and conflict status.

    interface SolutionUpgradeResult {
        changes: SolutionDiffEntry[];
        code?: string;
        dry_run: boolean;
        existing_solution_version?: string;
        incoming_solution_version?: string;
        message?: string;
        review_fingerprint?: string;
        status: string;
        summary: SolutionDiffSummary;
        version_change: string;
    }
    Index

    Properties

    changes code? dry_run existing_solution_version? incoming_solution_version? message? review_fingerprint? status summary version_change

    Properties

    changes: SolutionDiffEntry[]

    Ordered list of individual config change entries representing every add, update, noop, orphan, and delete in the diff.

    code?: string

    Machine-readable conflict code when status is "conflict", e.g. "review_required". null when there is no conflict.

    dry_run: boolean

    true when the upgrade was computed without writing any changes; false when changes were committed.

    existing_solution_version?: string

    Version string of the currently installed solution, as declared in its manifest. null if no prior version is installed.

    incoming_solution_version?: string

    Version string of the incoming solution to be installed, as declared in its manifest. null if the incoming manifest omits a version.

    message?: string

    Human-readable description of the conflict or error. null when there is no conflict.

    review_fingerprint?: string

    Opaque fingerprint that uniquely identifies this diff. Pass this value as review_fingerprint on a subsequent non-dry-run upgrade call to confirm you have reviewed the diff. null if not applicable.

    status: string

    Overall result of the upgrade. "ready" means the upgrade can proceed; "conflict" means a blocking issue was detected and the upgrade was not applied.

    summary: SolutionDiffSummary

    Aggregate counts of each action type across all diff entries.

    version_change: string

    Describes the nature of the version transition. One of "upgrade", "downgrade", "same", or "unknown".

    Settings

    Member Visibility

    On This Page

    Properties