docs!: Audit and document the v1 public API - #244
Merged
Conversation
marandaneto
marked this pull request as ready for review
September 1, 2026 09:22
Prompt To Fix All With AI### Issue 1
docs/migration-0.x-to-1.0.md:43
**Durability check accepts unsent events**
When a client is disabled or `before_send` filters the entire batch, `all_persisted()` returns true despite no events being submitted, so following this guidance can advance durable state without delivering the intended events. Callers must also verify that `submitted()` equals the intended event count.
```suggestion
`CaptureSummary::not_persisted()` and `CaptureSummary::all_persisted()` now use those per-event results. In the V0 path they reported a successful `2xx` as fully persisted without per-event confirmation. Applications that advance durable state after `capture_immediate` should check both that `submitted()` equals the number of intended events and that `all_persisted()` is true, because disabled clients and fully `before_send`-filtered batches submit no events but still report `all_persisted()` as true.
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs!: audit and document the v1 public ..." | Re-trigger Greptile |
dustinbyrne
approved these changes
Sep 1, 2026
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.
💡 Motivation and Context
Issue #207 needs an upgrade guide, current v1 documentation, and an explicit review of the public API before it becomes stable.
This adds a 0.x to 1.0 migration guide covering the removed capture feature and V0 path, capture result changes, removed feature flag methods,
secret_key, and response type renames. It removes stale V0 wording from current API documentation.The public API audit makes server response types non-exhaustive before 1.0 so minor releases can represent new backend fields and variants.
LocalEvaluationResponse::newpreserves a supported way to create offline definitions. The generated snapshot records these API stability decisions.The final package-name snapshot review remains gated on #183, and TLS remains gated on the unresolved work from #201.
Part of #207.
💚 How did you test it?
cargo fmt --all -- --checkscripts/check-public-api.shcargo check --examplescargo test --workspacecargo test --no-default-features5263925📝 Checklist
If releasing new changes
sampo addto generate a changeset file