All notable changes to this project will be documented in this file. The format is based on Keep a Changelog.
- CI: GitHub Actions quality-check workflow (
.github/workflows/code-quality.yaml) — LinkML schema linting,ruffPython linting, model/docs generation with sync verification, and PR comment posting ([ERS1-103]) lintandlint-schemaMake targets ([ERS1-103])- data model:
proposed_cluster_idsfield onEntityMentionResolutionRequest— allows the caller to suggest candidate clusters; the ERE has no obligation to honour the proposal ([ERS1-119]) - data model:
similarity_scorefield onClusterReference— a 0–1 pairwise score between an entity mention and a cluster representative ([ERS1-119]) - Schema docs:
EREErrorResponse.md,EREMessage.md,EntityMentionResolutionResponse.md,proposed_cluster_ids.md,similarity_score.md([ERS1-119])
- data model: revised semantics of
excluded_cluster_ids— ERE has no obligation to honour exclusions, and it remains the ultimate resolution authority ([ERS1-119]) - data model: clarified
ere_request_id— notification responses originating inside the ERE (without a prior request) use the prefixereNotification:([ERS1-119]) - Removed
FullRebuildRequest/FullRebuildResponseclasses from ERE schema and docs ([ERS1-119]) - Renamed
entityType.md→EntityType.mdin schema docs ([ERS1-119]) - Gherkin tests updated to reflect the V4 ERE Contract — simplified idempotent-resolution scenarios, added full-rebuild stub, aligned unhappy-path tests ([ERS1-120])
- README updated: added
lint/lint-schematargets to the Makefile overview ([ERS1-103])
- Architecture diagram PNGs under
docs/architecture/diagrams/ - Mermaid sequence diagrams under
docs/architecture/sequence_diagrams/
- data model changed according to recent
- Terminology cleaned (eg, "cluster reference" in place of "alignment option")
- Simplifications (eg, alignment set removed)
- Entity mention ID based on
requestID+sourceID+entityType
- Terminology cleaned (eg, "cluster reference" in place of "alignment option")
- Documentation updates, eg, sequence diagram
- Gherkin tests updated according to the cases described in the new ERE Technical Contract
- README updated: added Documentation Overview with links to schema docs (
docs/schema/README.md), architecture diagrams (docs/architecture/diagrams/), Mermaid sequences (docs/architecture/sequence_diagrams/), and an informative ERS–ERE interface note (docs/ere-interface-seq-diag.md)
- data model: Support for rejected canonical identifiers
- data model: Support for a full rebuild
- Updated and refined data model
- Updated ERS-ERE examples
- Initial release, fulfilling Project's Delivery 1 (ERE Technical Contract and related code).
- LinkML schema to specify the interaction with the ERE service.
- Includes auto-generated navigable documents, a class diagram and a sequence diagram.
- Gherkin Tests, based on collected test data, possible test cases
