docs(#685): create API error codes reference#957
Open
jerrymusaga wants to merge 1 commit into
Open
Conversation
Adds docs/api/error-codes.md covering all HTTP status codes, error response JSON schema, application-level error messages (auth, validation, conflict, rate-limit, external service, server), per-error examples, and a client-side handling guide with TypeScript snippets.
|
@jerrymusaga Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Summary
Closes #685.
docs/api/error-codes.md— the first centralised reference for all HTTP status codes and error responses in the LearnVault APIdetailsarray shape for validation errors and thestackfield in non-production)200–503) with a table explaining when each is returnedRetry-Afterdocs/openapi.yamlanddocs/request-tracing.mdTest plan
docs/api/error-codes.mdand verify it renders correctly on GitHubserver/src/middleware/error.middleware.ts,server/src/middleware/rate-limit.middleware.ts, representative controllers)