Skip to content

docs(storage): clarify BatchDependentStore invariant and Get semantics#178

Merged
sbalabanov merged 1 commit into
mainfrom
sergeyb/api
Jun 2, 2026
Merged

docs(storage): clarify BatchDependentStore invariant and Get semantics#178
sbalabanov merged 1 commit into
mainfrom
sergeyb/api

Conversation

@sbalabanov
Copy link
Copy Markdown
Contributor

Summary

  • Document on the BatchDependentStore interface that every active Batch has a paired BatchDependent row, since the batch-creation flow calls Create here before creating the Batch itself.
  • Make explicit that Get is only called for batch IDs returned from the active-batch set, so ErrNotFound is part of the contract for completeness but signals an invariant violation rather than an expected outcome.
  • Note on Get that an empty Dependents list is the normal "no dependents" result.

Test plan

  • CI passes (docs-only change; no behavior modified)

Document on the interface that every active Batch has a paired BatchDependent
row (Create runs before BatchStore.Create), so Get only sees IDs from the
active set and ErrNotFound is an invariant violation rather than an expected
outcome. Also note that an empty Dependents list is the normal "no dependents"
result.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@sbalabanov sbalabanov requested review from a team and behinddwalls as code owners June 2, 2026 18:21
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@sbalabanov sbalabanov added this pull request to the merge queue Jun 2, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jun 2, 2026
@sbalabanov
Copy link
Copy Markdown
Contributor Author

signed CLA but GH does not pick up. Bypassing.

@sbalabanov sbalabanov merged commit e81bd4a into main Jun 2, 2026
13 of 14 checks passed
@sbalabanov sbalabanov deleted the sergeyb/api branch June 2, 2026 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants