Eve library

ISIS Audio SFX Pack Generation API Typed Request Contracts Runbook

Runbook

Revision 1

On this page

Last Updated: 2026-03-03
Scope: MXA-0531 generation API exposure for audio-sfx-pack typed request contracts.

Purpose#

Generate and validate canonical API typed-request contract artifacts for audio-sfx-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_AUDIO_SFX_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.json
  • docs/domains/isis/remediation-v2/ISIS_V2_AUDIO_SFX_PACK_GENERATION_API_TYPED_REQUEST_CONTRACTS.md

Generator#

bash
node scripts/isis/generate-v2-audio-sfx-pack-generation-api-typed-request-contracts.mjs

Options:

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

Validator#

bash
node scripts/isis/validate-v2-audio-sfx-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_AUDIO_SFX_PACK_REQUIREMENTS_BRIEF.json
  • apps/isis/generation-api/src/schemas/audio-sfx-pack.schema.ts
  • apps/isis/generation-api/src/schemas/audio-sfx-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 audio-sfx-pack workflow IDs, request parameters, or route integration logic changes.
  2. Validate before SDK and web UI parity tasks consume API contract shapes (MXA-0532, MXA-0533).
  3. Keep acceptance criteria aligned with route-level test coverage and invalid-request error signaling.
  • docs/domains/isis/remediation-v2/ISIS_V2_AUDIO_SFX_PACK_WORKFLOW_TEMPLATES_PRESETS.json
  • docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_BACKLOG.md