Document respect-per-spec-base-path OpenAPI setting - #6765
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
Document respect-per-spec-base-path OpenAPI setting#6765devin-ai-integration[bot] wants to merge 1 commit into
devin-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-1787850377-respect-per-spec-base-path.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
Fern projects that combine several OpenAPI specs used to end up with a single API-wide base path: whichever spec's
x-fern-base-pathwon the merge got prepended to every endpoint, and the other specs' prefixes were dropped from the generated SDK. The CLI now has an opt-inrespect-per-spec-base-pathsetting that applies each document's base path to its own endpoints before the merge, so a project with, say, an OAuth spec at/and a main API at/api/v3generates an SDK whose URLs are right for both without hand-patching the client or contortingbase_url. This PR documents the setting.Implements docs for: feat(cli): add respect-per-spec-base-path setting for per-spec x-fern-base-path (fern-api/fern#17495)
Pages changed
fern/snippets/openapi-specs.mdx— newsettings.respect-per-spec-base-path<ParamField>(boolean, defaultfalse) covering the per-spec behavior, the parameterized-base-path carve-out and conflict error, the/and double-prefix no-ops, and thebase_urlmigration note for anyone who worked around the old collapsing. This snippet is the single canonical OpenAPI settings list, transcluded into both the SDKs and API Definitionsgenerators.ymlreferences.fern/products/api-def/openapi/extensions/base-path.mdx— one-sentence cross-reference from thex-fern-base-pathextension page to the new setting.Checks run:
pre-commit run --files <changed>(Vale clean) andfern check --warnings(0 errors; the 8 warnings are preexisting and unrelated).Link to Devin session: https://app.devin.ai/sessions/5349e75bd7834d8295514f562eb7c327
Open in Devin Desktop: https://app.devin.ai/desktop/session/5349e75bd7834d8295514f562eb7c327?variant=devin