Skip to content

Expand auth docs and add change requests page - #44

Merged
atc964 merged 1 commit into
mainfrom
docs/auth-and-change-requests
Mar 11, 2026
Merged

Expand auth docs and add change requests page#44
atc964 merged 1 commit into
mainfrom
docs/auth-and-change-requests

Conversation

@atc964

@atc964 atc964 commented Mar 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Authentication (buyer-2m7): Expanded from a half-page inbound-only doc to full coverage of both inbound and outbound auth. Now documents ApiKeyStore (add/get/remove/rotate/list), AuthMiddleware (request decoration, 401 handling), multi-seller credential management, key acquisition workflow with sequence diagram, key rotation, and DealsClient auth patterns.
  • Change Requests (buyer-n4e): New page documenting how the buyer submits post-deal modifications to seller orders. Covers severity levels (minor/material/critical), auto-classification rules, the 7-state lifecycle, validation constraints, and three buyer workflow patterns (simple, poll, batch). Notes that a typed client is planned but not yet implemented.
  • Updated mkdocs.yml nav to include the new Change Requests page under API Reference.

Test plan

  • Run mkdocs serve locally and verify both pages render correctly
  • Verify all internal links resolve (deals, bookings, authentication cross-refs)
  • Verify external links to seller docs load correctly
  • Confirm mermaid diagrams render in both pages

🤖 Generated with Claude Code

Expand authentication.md from a half-page inbound-only doc to full
coverage of both inbound and outbound auth: ApiKeyStore operations,
AuthMiddleware usage, multi-seller credential management, key
acquisition workflow, and key rotation. Add new change-requests.md
documenting how the buyer submits post-deal modifications to sellers
(severity levels, lifecycle, validation rules, workflow patterns).
Update mkdocs.yml nav to include the new page.

bead: buyer-2m7, buyer-n4e

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@atc964
atc964 merged commit 2395ab3 into main Mar 11, 2026
@atc964
atc964 deleted the docs/auth-and-change-requests branch March 11, 2026 19:40
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.

1 participant