Document namespaced-errors OpenAPI setting - #6870
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
Document namespaced-errors OpenAPI setting#6870devin-ai-integration[bot] wants to merge 1 commit into
namespaced-errors OpenAPI setting#6870devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1788714403-namespaced-errors-setting.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
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
settings.namespaced-errorsis a new opt-in, per-spec OpenAPI setting ingenerators.yml(Fern CLI 5.114.0/5.114.1). By default Fern compares shared error responses across the whole API by status code, so when two specs return different bodies for the same status (e.g. two different429bodies) the shared error's body collapses tounknown/anyin generated SDKs. With the setting enabled, a response object incomponents.responsestaggedx-fern-sdk-namespace: <name>is declared in that namespace and conflict-checked only within it, so customers get typed per-namespace error classes (e.g.plants.TooManyRequestsError) while keeping the spec's endpoints and other types at the root. Only the response-object extension is honored, and the setting applies only to the spec that sets it.Implements docs for: feat(openapi): add
namespaced-errorssetting to scope errors by response/body-schema namespace (fern-api/fern#17650) — fern-api/fern#17650 and fix(openapi): scopenamespaced-errorsto its spec and only honor response-object namespace (fern-api/fern#17655) — fern-api/fern#17655Pages changed:
fern/snippets/openapi-specs.mdx— newsettings.namespaced-errorsParamField with agenerators.yml+components.responsesexample (rendered on both the SDKs generators.yml reference and the API definitions generators.yml reference).fern/products/api-def/openapi/extensions/overview.md—x-fern-sdk-namespacerow in the extensions table linking to the new setting.fern/products/api-def/pages/project-structure.mdx— one-sentence pointer from the "Add namespaces" step.No global
api.settingsentry was added: that section only documentsauto-generate-idempotency-keyand defers per-type settings to the spec-type snippets.pre-commit(Vale) andfern check --warningspass.Link to Devin session: https://app.devin.ai/sessions/912e45182fd54b008b9590a79ac6ce3b
Open in Devin Desktop: https://app.devin.ai/desktop/session/912e45182fd54b008b9590a79ac6ce3b?variant=devin