Add comprehensive History and versioning concept documentation#99
Open
josejulio wants to merge 1 commit into
Open
Add comprehensive History and versioning concept documentation#99josejulio wants to merge 1 commit into
josejulio wants to merge 1 commit into
Conversation
Document Kessel's four-level versioning hierarchy: Version (reporter representation), Generation (lifecycle tracking), CommonVersion (shared attributes), and ReporterVersion (reporter-supplied metadata). Includes three Mermaid flowcharts visualizing version increment logic: - ReportResource flow (tombstone check, version/generation increment) - DeleteResource flow (tombstone marking) - Change detection flow (created/updated/deleted event determination) Explains why versioning matters (audit trail, change detection, lifecycle tracking) and how immutable version history enables accurate event publishing. Written as pure Diataxis explanation focused on understanding the versioning system. All technical claims verified against source code (inventory-api model implementations, version increment logic). Generation numbers corrected to start at 0 (not 1) per source code. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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
1 participant
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.
Document Kessel's four-level versioning hierarchy: Version (reporter representation), Generation (lifecycle tracking), CommonVersion (shared attributes), and ReporterVersion (reporter-supplied metadata).
Includes three Mermaid flowcharts visualizing version increment logic:
Explains why versioning matters (audit trail, change detection, lifecycle tracking) and how immutable version history enables accurate event publishing.
Written as pure Diataxis explanation focused on understanding the versioning system. All technical claims verified against source code (inventory-api model implementations, version increment logic).
Generation numbers corrected to start at 0 (not 1) per source code.