Last Updated: 2026-03-02
Scope: MXA-0388 SDK exposure for foliage-pack workflows with typed run
contracts and end-to-end examples.
Purpose#
Generate and validate the canonical SDK contract artifact for foliage-pack,
confirming typed workflow run methods, client shortcuts, root exports, and
runnable direct/chain/batch examples.
Artifacts#
docs/domains/isis/remediation-v2/ISIS_V2_FOLIAGE_PACK_SDK_END_TO_END_EXAMPLES.jsondocs/domains/isis/remediation-v2/ISIS_V2_FOLIAGE_PACK_SDK_END_TO_END_EXAMPLES.md
Generator#
bash
node scripts/isis/generate-v2-foliage-pack-sdk-end-to-end-examples.mjs
Options:
--report-date=YYYY-MM-DD(default: current UTC date)
Validator#
bash
node scripts/isis/validate-v2-foliage-pack-sdk-end-to-end-examples.mjs
Source Inputs#
docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_TICKETS.jsondocs/domains/isis/remediation-v2/ISIS_V2_FOLIAGE_PACK_REQUIREMENTS_BRIEF.jsondocs/domains/isis/remediation-v2/ISIS_V2_FOLIAGE_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.jsonlibs/isis/client/src/resources/workflows.tslibs/isis/client/src/resources/workflows.foliage-pack.spec.tslibs/isis/client/src/examples/foliage-pack.tslibs/isis/client/src/examples/foliage-pack.spec.tslibs/isis/client/src/client.tslibs/isis/client/src/index.tslibs/isis/client/src/resources/index.ts
Operational Cadence#
- Regenerate whenever foliage-pack workflow IDs, required parameters, or SDK method signatures change.
- Validate before closing SDK/web parity tasks (
MXA-0388,MXA-0389) and before doc-claims reconciliation. - Keep SDK typed contracts synchronized with generation API typed contract
guarantees from
MXA-0387.
Related Artifacts#
libs/isis/client/src/resources/workflows.tslibs/isis/client/src/examples/foliage-pack.tsdocs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_BACKLOG.md