Eve library

ISIS Prop Pack General Generation API Typed Request Contracts Runbook

Runbook

Revision 1

On this page

Last Updated: 2026-02-28
Scope: MXA-0225 generation API exposure for prop-pack-general typed request contracts.

Purpose#

Generate and validate the canonical API typed-request contract artifacts for prop-pack-general, 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_PROP_PACK_GENERAL_GENERATION_API_TYPED_REQUEST_CONTRACTS.json
  • docs/domains/isis/remediation-v2/ISIS_V2_PROP_PACK_GENERAL_GENERATION_API_TYPED_REQUEST_CONTRACTS.md

Generator#

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

Options:

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

Validator#

bash
node scripts/isis/validate-v2-prop-pack-general-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_PROP_PACK_GENERAL_REQUIREMENTS_BRIEF.json
  • apps/isis/generation-api/src/schemas/prop-pack-general.schema.ts
  • apps/isis/generation-api/src/schemas/prop-pack-general.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 prop 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-0226, MXA-0227).
  3. Keep acceptance criteria aligned with route-level test coverage and invalid-request error signaling.
  • docs/domains/isis/remediation-v2/ISIS_V2_PROP_PACK_GENERAL_WORKFLOW_TEMPLATES_PRESETS.json
  • docs/domains/isis/remediation-v2/ISIS_REMEDIATION_V2_BACKLOG.md