Refs #426: Clarify authenticated attempt examples#542
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdates the Advisory Attempt Reservations API example documentation to clarify that authenticated attempt registration and release require a GitHub-authenticated browser session cookie for the same account. Unauthenticated requests return 401. Both affected curl commands are amended to include the cookie flag. ChangesAPI Example Documentation Update
Possibly related PRs
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
Baijack-star
left a comment
There was a problem hiding this comment.
Reviewed PR #542 at head c64d31e for the authenticated attempt examples slice.
Evidence checked:
- Diff is limited to docs/api-examples.md and adds the browser-session-cookie flag to the register/release attempt curl examples.
- app/auth.py require_github_login returns 401 when the mrwk_user GitHub session cookie is missing, matching the new unauthenticated-request wording.
- app/bounty_attempts.py wires both POST /api/v1/bounties/{bounty_id}/attempts and POST /api/v1/bounty-attempts/{attempt_id}/release through Depends(require_github_login), while the GET attempts list remains public.
- docs/agent-guide.md already documents the same authenticated browser session cookie for this flow, so this PR makes the API examples consistent with the agent guide.
Validation run locally on the PR branch:
- uv run --extra dev python scripts/docs_smoke.py -> docs smoke ok
- uv run --extra dev ruff check docs/api-examples.md -> All checks passed (no Python files under that path)
- git diff --check origin/main...HEAD -> clean
Assessment: no blocker found in this docs-only slice; it matches the implementation and existing agent-guide contract. No private cookies, tokens, wallet material, production mutation, payout guarantees, liquidity/exchange/off-ramp claims, or private data were used.
|
Reviewed PR #542 at Evidence checked:
Validation:
Assessment: no blocker found. The docs change is small and aligns the API examples with the existing authenticated write-route behavior. |
Summary
Refs #426
Evidence
Checks
Summary by CodeRabbit