docs: document respect-operation-id-word-boundaries OpenAPI setting - #6937
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: document respect-operation-id-word-boundaries OpenAPI setting#6937devin-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>
devin-ai-integration
Bot
requested review from
devalog,
jkonrath-postman and
nerminamiller-postman
as code owners
September 12, 2026 17:06
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
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
Documents a new opt-in, per-spec OpenAPI setting,
respect-operation-id-word-boundaries, which makes Fern split operationIds containing underscores or digits on word boundaries (separators, camelCase transitions, digits) when building API Reference URL slugs, and strip the tag prefix consistently. Today an endpoint's docs URL depends on whether its operationId happens to contain a digit or separator, producing slugs like/sharing/listfoldermembersnext to/files/files-get-thumbnail-v-2. With the setting on, slugs are consistent kebab-case (/sharing/list-folder-members) without changing generated SDK method names. The trade-off is that URLs move, so customers need redirects and hardcoded-link updates in the same change.Implements docs for: feat(cli): add opt-in respect-operation-id-word-boundaries OpenAPI setting (fern-api/fern#17557)
Pages changed
fern/snippets/openapi-specs.mdx(rendered in thegenerators.ymlreference, OpenAPI spec settings): newsettings.respect-operation-id-word-boundaries<ParamField>next to the otherrespect-*settings, plus the key in the top YAML example. Links to/learn/docs/seo/redirectsfor the URL-move caveat.No changelog entry (CLI changelog is auto-generated). No natural cross-reference spot found in
fern/products/docsfor API Reference URL slugs.Validation
pre-commit run --files fern/snippets/openapi-specs.mdx: Vale passed (only pre-existing suggestions on an unrelated line).cd fern && npx --yes fern-api@5.59.0 check --warnings: 0 errors; 11 pre-existing warnings unrelated to this change.Link to Devin session: https://app.devin.ai/sessions/6c4fccec7abe4fbdbef045fe91bc55dd
Open in Devin Desktop: https://app.devin.ai/desktop/session/6c4fccec7abe4fbdbef045fe91bc55dd?variant=devin