sync-service-docs

To auto-generate API documentation from OpenAPI specs, run a sync command targeting a service name to create missing docs or update existing sections based on git diffs. It reads OpenAPI files and source code to produce modular, structured documentation files.

Git diff documentation synchronization works by comparing repository history to identify changes in API definitions and source code. It then updates only the affected documentation sections, refreshing metadata like last updated time and repository code hashes.

Yes, you can update documentation across multiple microservices by defining them in a service configuration table. The tool processes each specified service individually, reading its OpenAPI schemas and source code to generate or update its modular file outputs.

Yes, the documentation structure is enforced strictly from OpenAPI schemas. This ensures generated docs accurately reflect API endpoints, request parameters, and response payloads without manual structural intervention or custom formatting overrides.

The best way to track code changes for incremental documentation updates is using git history diffing. This approach detects modified API definitions, triggers stepwise doc generation for affected sections, and updates code hashes to maintain synchronization.

Last updated times and code hashes are tracked to maintain documentation accuracy and auditability. These metadata fields verify that docs reflect the latest source code state and help identify when incremental updates occur during git diff synchronization.