Skip to content

OpenAPI Processing Lifecycle

States

stateDiagram-v2
    [*] --> Received
    Received --> Validating
    Validating --> Processing: ok
    Validating --> Failed: invalid
    Processing --> Writing
    Writing --> Completed
    Processing --> Failed: error
    Failed --> [*]
    Completed --> [*]

Phase detail

Phase Description
Init Parse CLI/API options; load settings/env
Validate Verify paths, formats, Content-Type, upload size
Process Run core conversion (extract_to_markdown, load_spec, swagger2_to_openapi3)
Emit Write Markdown tables/sections/assets
Package Single file, artifact directory, or ZIP
Cleanup Job TTL sweeper removes temp workspaces (API modules)

Job lifecycle (HTTP)

This module primarily uses synchronous CLI/API responses without a job store.