📚 doc: Key Value Expectation Notice (KeyAuth Middleware)#4183
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughAdded a one-line documentation clarification to KeyAuth middleware docs: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~1 minute Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the keyauth.md documentation to clarify that the FromAuthHeader extractor expects an RFC 7235 Token68 compliant key value. A review comment identified a typo ('complaint' instead of 'compliant') and suggested formatting the function name with backticks for consistency.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/middleware/keyauth.md (1)
172-172: Consider adding the failure-mode note called out in the PR objective.Right now this line states the format requirement, but not the consequence. Add a brief follow-up sentence that non-token68 values may bypass
Validatorand yield a less clear error response.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/middleware/keyauth.md` at line 172, The docs state FromAuthHeader expects an RFC7235 Token68 value but don't describe the failure mode; update the sentence after the token68 description to note that non-token68 values can bypass the Validator (FromAuthHeader) and result in a less clear or different error response, e.g., explicitly mention that values not matching token68 may not be validated and can produce ambiguous errors from Validator or downstream handlers.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/middleware/keyauth.md`:
- Line 172: Fix the typo and malformed RFC link in the docs: change "complaint"
to "compliant" in the sentence that references FromAuthHeader, and replace the
broken URL with a stable RFC7235 section anchor (e.g. use the RFC7235 link with
`#section-2.1` or another correct section anchor that points to token68) so the
phrase reads "FromAuthHeader expects a compliant RFC 7235 token68 key value."
Reference the FromAuthHeader mention to locate the sentence.
---
Nitpick comments:
In `@docs/middleware/keyauth.md`:
- Line 172: The docs state FromAuthHeader expects an RFC7235 Token68 value but
don't describe the failure mode; update the sentence after the token68
description to note that non-token68 values can bypass the Validator
(FromAuthHeader) and result in a less clear or different error response, e.g.,
explicitly mention that values not matching token68 may not be validated and can
produce ambiguous errors from Validator or downstream handlers.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: ba84190b-f883-4bcc-a749-41415484ae8a
📒 Files selected for processing (1)
docs/middleware/keyauth.md
gaby
changed the title
There was a problem hiding this comment.
Pull request overview
Updates the KeyAuth middleware documentation to clarify what format FromAuthHeader("Bearer") expects for the extracted key value, and provides an RFC reference to reduce debugging friction.
Changes:
- Added a documentation note that
FromAuthHeaderexpects an RFC 7235token68-style value. - Linked to the relevant RFC content for quick reference.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Added information about applying middleware to specific routes and the expected key format.
|
Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord |
Description
This fix adds a little note stating the expectations with a link to the RFC docs on it - so readers can easily see where to go.
I spent some minutes trying to debug - my hope is others dont because of it.
Fixes # (issue)
Changes introduced
Type of change
Checklist
Before you submit your pull request, please make sure you meet these requirements:
/docs/directory for Fiber's documentation.