Conversation
* refactor: Move all files located in the root to a dedicated folder * chore: Setup development tools and packages * refactor/fix: Remove redundant metadata and fix reference from .json documents - Removed `$schema` and `$id` from nested .json documents - Fixed the reference inside the oneOf block for PSQL v15.0 in the file `specs.json` to point to the correct `spec.json` * feat: implement database schema specification generator with conditional resolution Implement a comprehensive database schema specification generator that processes JSON Schema files with conditional oneOf logic for different database engines and versions. ### Core Features **Schema Resolution System:** - Add JSONRefResolver for handling $ref references with circular detection - Implement ConditionalMerger for oneOf conditional logic resolution - Support both if/then and direct property constraint formats - Add VariantExtractor for database variant discovery from oneOf blocks **Validation Framework:** - Add SchemaValidator with JSON Schema Draft 7 compliance checking - Implement custom validation rules for project-specific requirements - Include validation for required fields and schema structure **Logging Infrastructure:** - Add centralized logging configuration with JSON-based setup - Support both console and file handlers with detailed formatting - Include queue-based logging for performance **CLI Generator:** - Implement SchemaGenerator for end-to-end schema processing - Support multiple database variants (PostgreSQL, MySQL) - Generate resolved schemas without oneOf conditionals * feat: Add generation of all available files in .json format to `output/vmap.json` - Introduced new functionality to generate a .json file that maps all available engines and their corresponndiing versions to an url. The map is saved in the output folder in a singleton file. - Introduced a new configuration module to manage application settings. - Added support for loading configuration from a .env file. - Updated the schema generator and output manager to utilize the new config. - Created example .env file and updated README with configuration instructions. - Implemented tests for configuration handling and output manager functionality. * feat: Add CI workflow and setup actions for Python and uv
* fix: enforce required environment variables in configuration & pass them into generated schemas dynamically * fix: reorder top-level keys in generated schemas to prioritize $id and $schema fields * fix: moved description field from snapshot to schema definition * fix: enable overriding of environment variables when loading .env file * feat: add Dockerfile, .dockerignore for schema generation and workflow to create images * feat: added workflow to create production images & cleaned workflow to create staging images * refactor(config): Remove unecessary python-dotenv dependency - Removed python-dotenv dependency and lines utilizing it. The pydantic_settings managed the environment and should fail on missing dependencies. * refactor(Dockerfile): Pin UV version and simplify building stage - Refactiored the dockerfile to have a pinned version of UV for consistent builds. - Simplified dockerfile by utilizing UV's prebuilt image * refactor(config): Remove leftover comments --------- Co-authored-by: Matheus-OAMK <t2fema00@students.oamk.fi>
…and removing staging image workflow (#9) * feat: consolidate CI/CD workflows by creating service version images and removing staging image workflow * feat: remove staging branch from CI workflow triggers
…djusted the schema spec generation logic * Feat/automate unified doc creation (#3) * refactor: Move all files located in the root to a dedicated folder * chore: Setup development tools and packages * refactor/fix: Remove redundant metadata and fix reference from .json documents - Removed `$schema` and `$id` from nested .json documents - Fixed the reference inside the oneOf block for PSQL v15.0 in the file `specs.json` to point to the correct `spec.json` * feat: implement database schema specification generator with conditional resolution Implement a comprehensive database schema specification generator that processes JSON Schema files with conditional oneOf logic for different database engines and versions. ### Core Features **Schema Resolution System:** - Add JSONRefResolver for handling $ref references with circular detection - Implement ConditionalMerger for oneOf conditional logic resolution - Support both if/then and direct property constraint formats - Add VariantExtractor for database variant discovery from oneOf blocks **Validation Framework:** - Add SchemaValidator with JSON Schema Draft 7 compliance checking - Implement custom validation rules for project-specific requirements - Include validation for required fields and schema structure **Logging Infrastructure:** - Add centralized logging configuration with JSON-based setup - Support both console and file handlers with detailed formatting - Include queue-based logging for performance **CLI Generator:** - Implement SchemaGenerator for end-to-end schema processing - Support multiple database variants (PostgreSQL, MySQL) - Generate resolved schemas without oneOf conditionals * feat: Add generation of all available files in .json format to `output/vmap.json` - Introduced new functionality to generate a .json file that maps all available engines and their corresponndiing versions to an url. The map is saved in the output folder in a singleton file. - Introduced a new configuration module to manage application settings. - Added support for loading configuration from a .env file. - Updated the schema generator and output manager to utilize the new config. - Created example .env file and updated README with configuration instructions. - Implemented tests for configuration handling and output manager functionality. * feat: Add CI workflow and setup actions for Python and uv * Feature/versioned releases (#6) * fix: enforce required environment variables in configuration & pass them into generated schemas dynamically * fix: reorder top-level keys in generated schemas to prioritize $id and $schema fields * fix: moved description field from snapshot to schema definition * fix: enable overriding of environment variables when loading .env file * feat: add Dockerfile, .dockerignore for schema generation and workflow to create images * feat: added workflow to create production images & cleaned workflow to create staging images * refactor(config): Remove unecessary python-dotenv dependency - Removed python-dotenv dependency and lines utilizing it. The pydantic_settings managed the environment and should fail on missing dependencies. * refactor(Dockerfile): Pin UV version and simplify building stage - Refactiored the dockerfile to have a pinned version of UV for consistent builds. - Simplified dockerfile by utilizing UV's prebuilt image * refactor(config): Remove leftover comments --------- * feat: consolidate CI/CD workflows by creating service version images and removing staging image workflow (#9) * feat: consolidate CI/CD workflows by creating service version images and removing staging image workflow * feat: remove staging branch from CI workflow triggers --------- Co-authored-by: Matheus Oliveira <t2fema00@students.oamk.fi>
RepoRover
added
documentation
There was a problem hiding this comment.
Pull request overview
This is a major v0.2.0 release that refactors the project structure and introduces a new architectural approach. The PR transitions from a monolithic JSON schema with conditional logic (oneOf blocks) to a modular architecture with separate project schemas, engine-specific specs, and a registry-based variant discovery system.
Key Changes:
- Removed conditional merger logic (oneOf resolution) in favor of self-contained engine-specific spec files
- Introduced new project schemas for configuration (base + engine-specific) and manifest tracking
- Renamed version map to schema map with enhanced structure including project-level schemas
- Updated file naming conventions (specs.json → registry.json, vmap.json → smap.json)
Reviewed changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_resolver.py | Removed unused line and added type ignore comment for method assignment |
| tests/test_output_manager.py | Renamed test methods and variables from version_map to engine_map/schema_map, added tests for config directory exclusion |
| tests/test_integration_production.py | Updated paths to include 'v' prefix for versions, added project schema validation, updated registry file references |
| tests/test_conditional_merger*.py | Deleted conditional merger test files (feature removed) |
| tests/conftest.py | Restructured fixtures to match new architecture with registry.json and project schemas |
| database_schema_spec/resolution/* | Removed ConditionalMerger class and oneOf resolution logic from resolver |
| database_schema_spec/io/output_manager.py | Renamed methods, added project schema writing, restructured schema map with project and engines sections |
| database_schema_spec/core/config.py | Updated file name configuration constants |
| database_schema_spec/cli/generator.py | Refactored to generate project schemas and use engine-specific specs directly |
| docs/* | Major restructuring: deleted old files, added new project schemas, registry.json, YAML examples, and comprehensive ARCHITECTURE.md |
| README.md | Updated to reflect new project structure and schema map format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request refactors the schema generation process to simplify variant resolution and enhance the organization of input and output schema files. It removes the conditional merging logic, introduces a registry-based variant extraction, and adds support for generating project schemas and a unified schema map. The documentation and configuration have been updated to reflect these changes.
Major refactor of schema generation and output organization:
ConditionalMergerfrom the codebase and imports. The generator now resolves references and generates final schemas for each engine/version using a registry file. [1] [2] [3] [4]_registry_.json), engine/version-specific spec files, and organized project schemas. The README now describes the new structure and the role of the schema map (smap.json). [1] [2] [3]Project schema and schema map generation:
$idfields, and output them in a standardized structure. [1] [2]smap.json) that indexes all generated schemas for discovery, replacing the previous version map. The schema map includes URLs for project schemas and engine specs. [1] [2]Output manager and config improvements:
OutputManagerto accept both output and docs directories, and added methods for writing project schemas and the schema map, with robust error handling and key ordering for$idand$schema. [1] [2] [3] [4]