[Chores] Automate Document Generation from JSON Schema Files #1
Description
🏷️ Chore Type
Development Tooling
📝 Task Summary
Create a Python script to automate the generation of a single structured document (per db engine version) from multiple interlinked JSON Schema files stored in the repository. The script should resolve $ref references and combine definitions into a comprehensive output.
🎯 Motivation & Benefits
- Streamline documentation generation from existing schema files
- Enable easier consumption of schema documents for internal (AI) or external services
- Reduce manual effort and chances of error
- Maintain the current documentation structure which is maintainable
🔍 Scope & Components
No existing files will be affected.
✅ Acceptance Criteria
-
Script reads JSON Schema files from a specified directory
-
$ref references between schema files are resolved correctly
-
Output is a single, coherent document in .json (per version)
-
Basic usage instructions are documented
⚠️ Technical Considerations
No response
📚 Helpful Resources
No response
ℹ️ Additional Context
No response