docs: Add multi-phase ESPI schema compliance plan and reference diagrams#49
Merged
Merged
Conversation
Addresses Issue #28 This commit adds a comprehensive 26-phase plan to review and update all Usage and Customer domain entities to ensure compliance with NAESB ESPI 4.0 schema (espi.xsd and customer.xsd) element sequences. Added files: - MULTI_PHASE_SCHEMA_COMPLIANCE_PLAN.md: Detailed 26-phase implementation plan with tasks for entities, DTOs, mappers, repositories, services, Flyway migrations, and tests - ESPI Usage.pdf: Atom link relationship diagram for espi.xsd main resources - ESPI Usage Summary Classes.pdf: Atom link diagram for summary classes - Retail Customer Resource Atom Link Usage.pdf: Atom link relationships for customer.xsd resources The plan processes entities in dependency order: - Phases 1-16: Usage domain entities (espi.xsd) - Phases 17-26: Customer domain entities (customer.xsd) Each phase includes: 1. Entity field order verification against XSD 2. DTO updates with JAXB annotations 3. Bidirectional MapStruct mapper updates 4. Repository query optimization 5. Service method compliance review 6. Flyway migration script updates 7. Comprehensive testing with XML marshalling/unmarshalling 8. Git workflow (branch, commit, push, PR) Key corrections applied: - MeterReading has no child elements, only Atom links - ServiceLocation references UsagePoint via cross-stream href URL - Bidirectional Atom link relationships properly documented - Customer domain entity relationships corrected per schema diagrams
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
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.
Summary
Adds a comprehensive 26-phase plan to address Issue #28 by reviewing and updating all Usage and Customer domain entities to ensure compliance with NAESB ESPI 4.0 schema (espi.xsd and customer.xsd) element sequences.
Closes
Addresses #28
Files Added
Plan Structure
The plan processes entities in dependency order (parents before children):
Usage Domain (Phases 1-16)
Customer Domain (Phases 17-26)
Each Phase Includes
Key Corrections Applied
Branch Strategy
Each phase will use a separate feature branch:
feature/schema-compliance-phase-{number}-{entity-name}Test Requirements
Next Steps
After this PR is merged:
feature/schema-compliance-phase-1-time-configuration