@apivexa/workflows

Detects and documents multi-step API workflows from an OpenAPI spec.

Part of ApiVexa — AI-powered API User Guide Generator.

Install

npm install @apivexa/workflows

What it does

Analyses operation IDs, tags, and resource relationships to infer common developer workflows — sequences of API calls a consumer would typically make together.

Example detected workflow:

Authenticate → Create Customer → Create Order → Get Order Status

Inferred workflows are always labelled as AI_INFERENCE in the provenance metadata and are never presented as mandatory sequences.

Usage

import { detectWorkflows, enrichDocumentWithWorkflows } from '@apivexa/workflows';

const workflows = detectWorkflows(normalizedApi, analysis);

// Or add them directly to a DocumentIr
enrichDocumentWithWorkflows(document, workflows);

Full documentation