docs: tighten API key and error envelope wording - #6422
Merged
Conversation
Drop the claim that 401 responses carry an error body and scope the error-envelope example to Anarlog's endpoint handlers, so the reference matches actual API behavior.
✅ Deploy Preview for old-char ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Drop the claim that 401 responses carry an error body and scope the
error-envelope example to Anarlog's endpoint handlers, so the reference
matches actual API behavior.
Note
Low Risk
Documentation-only wording changes with no runtime or API behavior impact.
Overview
Updates the local API reference so auth and error documentation match real behavior instead of overstating guarantees.
For authentication, invalid keys are described as returning
401only—the doc no longer claims those responses include the JSON error body. API key copy is slightly tightened (“shown once” without “at creation”).For errors, the JSON
{ "error": { "code", "message" } }example is explicitly scoped to responses from Anarlog’s endpoint handlers, aligning with the existing note that malformed JSON can yield a plain-text400before a handler runs.Reviewed by Cursor Bugbot for commit e30aca5. Bugbot is set up for automated code reviews on this repo. Configure here.