# ISIS VFX Element Pack Generation API Typed Request Contracts Runbook

Last Updated: 2026-03-02  
Scope: `MXA-0423` generation API exposure for `vfx-element-pack` typed request
contracts.

## Purpose

Generate and validate the canonical API typed-request contract artifacts for
`vfx-element-pack`, including route coverage, workflow ID coverage, parameter
requirements per variant, and route-level invalid-request guard signals.

## Artifacts

- `docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.json`
- `docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.md`

## Generator

```bash
node scripts/isis/generate-v2-vfx-element-pack-generation-api-typed-request-contracts.mjs
```

Options:

- `--report-date=YYYY-MM-DD` (default: current UTC date)

## Validator

```bash
node scripts/isis/validate-v2-vfx-element-pack-generation-api-typed-request-contracts.mjs
```

## Source Inputs

- `docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_TICKETS.json`
- `docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_REQUIREMENTS_BRIEF.json`
- `apps/isis/generation-api/src/schemas/vfx-element-pack.schema.ts`
- `apps/isis/generation-api/src/schemas/vfx-element-pack.schema.spec.ts`
- `apps/isis/generation-api/src/routes/workflows.ts`
- `apps/isis/generation-api/src/routes/workflows.spec.ts`

## Operational Cadence

1. Regenerate when vfx-element-pack typed workflow IDs, request parameters, or
   route integration logic changes.
2. Validate before SDK and web UI parity tasks consume the API contract shape
   (`MXA-0424`, `MXA-0425`, `MXA-0426`).
3. Keep acceptance criteria aligned with route-level test coverage and
   invalid-request error signaling.

## Related Artifacts

- `docs/domains/isis/remediation-v2/ISIS_V2_VFX_ELEMENT_PACK_WORKFLOW_TEMPLATES_PRESETS.json`
- `docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_BACKLOG.md`
