fix(broken-links): update 2 stale API-reference slugs after SDK method renames#270
Open
abhishekmishragithub wants to merge 1 commit into
Open
fix(broken-links): update 2 stale API-reference slugs after SDK method renames#270abhishekmishragithub wants to merge 1 commit into
abhishekmishragithub wants to merge 1 commit into
Conversation
…d renames CI link-check failed after #266 merged because two MDX files referenced the old Fern-derived URL slugs that changed when #262 added `x-fern-sdk-method-name` annotations. Fern derives the API reference URL from `x-fern-sdk-{group,method}-name` when set (falling back to summary kebab-case otherwise), so renaming the SDK method also moves the docs URL. | File | Old (404) | New (verified 200 on live) | |---|---|---| | `creating-campaigns.mdx:122` | `.../campaigns/create-a-campaign` | `.../campaigns/create` | | `websocket-sdk.mdx:121` | `.../logs/get-conversation-log-by-id` | `.../calls/get` | The second one also moved namespace (`logs` → `calls`) because the OpenAPI tag is `Logs` but `x-fern-sdk-group-name: calls` was added — Fern uses the SDK group-name for the URL not the OpenAPI tag. Both new URLs curl'd against https://docs.smallest.ai and confirmed 200 before commit. `fern check`: 0 errors. ## Followup-worthy (not in this PR) Same risk exists for any external doc / Slack message / cookbook / Notion page that linked to the old `/campaigns/create-a-campaign` etc. slugs — those are out of this repo's scope but worth a Search Console pass like @abhishekmishragithub's #269 next sprint.
|
🌿 Preview your docs: https://smallest-ai-preview-fix-api-ref-url-slugs-after-sdk-renames.docs.buildwithfern.com 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
1 participant
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.
Closes #267 — auto-opened weekly site-audit issue flagged these same 2 links.
Summary
CI link-check failed after #266 merged. The two failures are stale Fern-generated API-reference URL slugs that moved when #262 added `x-fern-sdk-method-name` annotations on those endpoints. Fern derives the API-ref URL from the SDK method name (falling back to summary kebab-case otherwise), so the slug change is a downstream effect of the SDK lockstep.
Fix
The second one also moved namespace (`logs` → `calls`) — the OpenAPI tag is `Logs` but `x-fern-sdk-group-name: calls` was added in #262, and Fern uses the SDK group-name for the URL, not the OpenAPI tag.
Verification
Follow-up worth noting
External pages (Slack messages, Notion docs, customer cookbooks) that linked to the old `/campaigns/create-a-campaign`, `/logs/get-conversation-log-by-id`, etc. slugs would also 404 now. Out of scope for this PR, but worth a Google Search Console pass similar to #269.