You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`ResolveRecipeFromSnapshotWithOptions(ctx, *Criteria, *Snapshot, opts...)`|`recipe --snapshot`, `query --snapshot` — with `WithSnapshotCriteriaRelaxation(stated...)` for the derived-criteria retry |
Copy file name to clipboardExpand all lines: docs/integrator/public-api.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ unrelated exports in their evolving packages remain free to change.
70
70
|`aicr.Phase`, `aicr.PhaseDeployment` / `PhasePerformance` / `PhaseConformance`| string consts |**Facade-owned**. Values match `pkg/validator/v1` constants verbatim for byte-identical wire round-trip. |
71
71
|`aicr.ReportSummary`|`pkg/validator/ctrf.Summary`|**Facade-owned struct** with the CTRF count fields. |
72
72
|`aicr.ValidateOption`|`pkg/validator.Option`|**Facade-owned** functional-option type that captures into an internal struct and translates at call time. |
73
-
|`aicr.RecipeResult`|`pkg/recipe.RecipeResult`|**Facade-owned struct** exposing `Name`, `Version`, `TranslatedAt`, `SelectedProfile` (the recorded ADR-015 selection, nil for unprofiled recipes), and `Components` (enabled/deployable components only — disabled refs remain visible via `Resolved().ComponentRefs`). Call `Resolved()` for the full upstream `*pkg/recipe.RecipeResult` (constraints, deployment order, validation config, metadata). The previous `aicr.Recipe` alias was removed in #1115; `ResolveRecipeFromCriteria` and `ResolveRecipeFromSnapshot` now return `*RecipeResult`. |
73
+
|`aicr.RecipeResult`|`pkg/recipe.RecipeResult`|**Facade-owned struct** exposing `Name`, `Version`, `TranslatedAt`, `SelectedProfile` (the recorded ADR-015 selection, nil for unprofiled recipes), `Components` (enabled/deployable components only — disabled refs remain visible via `Resolved().ComponentRefs`), and `RelaxedDimensions` (criteria dimensions cleared by `WithSnapshotCriteriaRelaxation`; non-empty only when that option was passed, the first attempt failed the coverage post-condition on derived dimensions, **and** the retry succeeded — a refused or failed retry returns `nil, error` with no `RecipeResult`, so this field never signals failure). Call `Resolved()` for the full upstream `*pkg/recipe.RecipeResult` (constraints, deployment order, validation config, metadata). The previous `aicr.Recipe` alias was removed in #1115; `ResolveRecipeFromCriteria` and `ResolveRecipeFromSnapshot` now return `*RecipeResult`. |
74
74
|`aicr.AllowLists`|`pkg/recipe.AllowLists`|**Facade-owned struct** with `[]string` fields (Accelerators / Services / Intents / OSTypes). Use `aicr.WrapAllowLists` to lift a `*pkg/recipe.AllowLists`. |
75
75
|`aicr.Criteria`|`pkg/recipe.Criteria`|**Facade-owned struct** whose enum-typed fields (Service / Accelerator / Intent / OS / Platform) project to plain strings; Nodes stays an `int` per the facade's string/int contract. Use `aicr.WrapCriteria` to lift a `*pkg/recipe.Criteria`. |
76
76
|`aicr.BundleConfig`|`pkg/bundler/config.Config`| Deliberate transparent alias. It keeps the facade compatible with `config.NewConfig` and its functional options instead of duplicating the bundler's configuration builder. |
0 commit comments