document-api-integration

Generate qontract-api documentation by providing the integration name so the tool can inspect models, service, router, and tasks, then output a template-aligned file at docs/integrations/<name>.md referencing the standard template.

The standard template is located at docs/integrations/template.md, which defines the structure for documenting API surfaces, data models, and workflows that the generated documentation must follow for consistency.

Document API endpoints and data models by analyzing the integration codebase to extract business logic, router definitions, and model structures, ensuring the generated documentation reflects the actual code.

Yes, it supports both new integrations and migrations to qontract-api, requiring exact extraction of the API surface, data models, and workflows to produce comprehensive documentation.

The analysis inspects models, service, router, tasks, and related files, while also referencing ADRs and reconciliation clients as applicable to ensure accurate documentation generation.

Yes, the generated documentation includes dry_run-safe guidance where relevant, ensuring the documented workflows and API integration instructions reflect safe operational practices.