fix: support x-displayName extension on OpenAPI tags#14130
Open
fix: support x-displayName extension on OpenAPI tags#14130
Conversation
Co-Authored-By: jon <jon@buildwithfern.com>
Contributor
🤖 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:
|
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review.
Tip: disable this comment in your organization's Code Review settings.
Contributor
🌱 Seed Test SelectorSelect languages to run seed tests for:
How to use: Click the ⋯ menu above → "Edit" → check the boxes you want → click "Update comment". Tests will run automatically and snapshots will be committed to this PR. |
Contributor
|
Closing this PR to recreate with correct title format (missing scope). New PR incoming. |
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.
Description
Refs Slack thread — Phil Freo reported that:
titleCaseprocessingx-displayNameextension on tags is not being respected in the documentation sidebarThis PR adds support for the
x-displayNameOpenAPI extension on tags, allowing users to explicitly control the display name used in Fern definitions and docs navigation.Changes Made
displayNameoptional field to the OpenAPI IRTagtype and regenerated SDK typesgenerateIr.tsto extractx-displayNamefrom OpenAPI tag objectsbuildServices.tsfallback chain:group?.summary → irTag?.displayName → irTag?.idDocsDefinitionResolver.tsto passdisplayNamethroughopenApiTagsApiReferenceNodeConverter.tsto usedisplayNamefor tag description page headingsdisplayNamefieldtag-display-namestest fixture withx-displayNameexamplesImportant Review Notes
x-displayName, but tags withoutx-displayNamewill still go throughtitleCase, which can mangle names like "WhatsApp" → "Whats App". Addressing the roottitleCasebehavior is a larger change that may warrant a separate PR.(tag as unknown as Record<string, unknown>)["x-displayName"]since the OpenAPI TS types don't expose extension properties. This is a common pattern in the codebase.displayNamefield is on the OpenAPI IR (openapi-ir), not the main Fern IR, so no IR migration is required.Testing
pnpm compilepasses for all affected packages)pnpm run check)Link to Devin session: https://app.devin.ai/sessions/83ca6010faff45f89f5ac888d9389227
Requested by: @jon-fern