feat: Generate API Error Documentation #2247
Open
Conversation
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
|
Hey, here’s your docs preview: https://clerk.com/docs/pr/2247 |
NWylynko
reviewed
May 22, 2025
NWylynko
reviewed
May 22, 2025
tmilewski
commented
May 22, 2025
| @@ -106,6 +111,7 @@ export async function createConfig(config: BuildConfigOptions) { | |||
| } | |||
| : null, | |||
|
|
|||
| skipApiErrors: config.skipApiErrors ?? false, | |||
|
With the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🔎 Previews:
What does this solve?
As-is, our API Errors documentation is very out-of-date and maintaining this information is currently done manually which is largely unmaintainable in the long-term.
ECO-646
What changed?
This PR generates API Errors pages for the Frontend and Backend APIs based on
data/api-errors.json. This file is updated automatically, as-needed, on production API deployments.Notes
/errors/overview./datahas been added.Checklist