BOS Settings feedback UX server contract #16

Merged
Breadway merged 3 commits from feature/bug-25-feedback-contract into main 2026-10-12 09:53:24 +08:00
Owner

Part of BUG-EP1, implements breadboard issue BUG-25 (feedback UX server contract). Stacked on the BUG-24 branch.

Adds docs/feedback-api.md (endpoints, examples, errors, client flow, privacy) plus manual and request fixtures validated by a contract test. README points at the contract, threat model notes follow and notice handling. No server behavior changes.

Verified: cargo test (all suites green, 3 new tests), cargo clippy with -D warnings clean, cargo fmt clean.

Closes BUG-25

Part of BUG-EP1, implements breadboard issue BUG-25 (feedback UX server contract). Stacked on the BUG-24 branch. Adds docs/feedback-api.md (endpoints, examples, errors, client flow, privacy) plus manual and request fixtures validated by a contract test. README points at the contract, threat model notes follow and notice handling. No server behavior changes. Verified: cargo test (all suites green, 3 new tests), cargo clippy with -D warnings clean, cargo fmt clean. Closes BUG-25
docs: BOS Settings feedback contract with fixtures
All checks were successful
check / check (push) Successful in 1m15s
b481990f1d
Add docs/feedback-api.md: the full client contract for reporting,
following, progress, releases and notifications with examples, error
cases, a step by step client flow and privacy rules. Add manual and
request fixtures validated by a contract test covering submit, follow,
status shape and validation. Point the README at the contract and note
the follow and notice threats in the threat model.
docs: complete the feedback contract and its fixtures
All checks were successful
check / check (push) Successful in 59s
44a5050d38
Address review on the feedback contract slice:
- add response fixtures for follow, status and notifications (fixed, beta,
  stable) under tests/fixtures, and validate all three shapes in
  tests/feedback_contract.rs, including the progress stage set and the
  notification events
- document the reporter deletion-token follow flow, the token rotation on a
  retry, the consent and reference fields, and the complete error cases
- replace the drain-on-read wording with the actual delivery contract: a
  non-destructive peek with stable ids, an ack endpoint, and the wait
  endpoint as the no-client-poll channel
- reconcile the progress description with the real stages, including the
  unpromoted fixed, declined and deferred cases, and update the client flow
docs: threat model says reads are a peek, not deliver-on-read
All checks were successful
check / check (push) Successful in 1m5s
4af4c9f833
Breadway force-pushed feature/bug-25-feedback-contract from f949d3dcce
All checks were successful
check / check (push) Successful in 1m8s
to 5eb4e92bcc
All checks were successful
check / check (push) Successful in 1m5s
2026-10-12 09:21:57 +08:00
Compare
Breadway changed target branch from feature/bug-24-notices to main 2026-10-12 09:53:23 +08:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Breadway/breadbug-server!16
No description provided.