Skip to content

docs: document respect-operation-id-word-boundaries OpenAPI setting - #6937

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1789232770-respect-operation-id-word-boundaries
Open

docs: document respect-operation-id-word-boundaries OpenAPI setting#6937
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1789232770-respect-operation-id-word-boundaries

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

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/listfoldermembers next 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 the generators.yml reference, OpenAPI spec settings): new settings.respect-operation-id-word-boundaries <ParamField> next to the other respect-* settings, plus the key in the top YAML example. Links to /learn/docs/seo/redirects for the URL-move caveat.

No changelog entry (CLI changelog is auto-generated). No natural cross-reference spot found in fern/products/docs for 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

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants