docs: show availability SDK output with TypeScript examples#5539
Merged
Conversation
…e client reference Co-Authored-By: Devin Logan <devinannlogan@gmail.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-1779122462-availability-sdk-output.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
… SDK Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
…n caption Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
… page Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
…thub.com/fern-api/docs into devin/1779122462-availability-sdk-output
devalog
approved these changes
May 18, 2026
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
Adds documentation showing how availability extensions (
x-fern-availability) propagate into generated SDKs, with a real-world IDE screenshot from the Square TypeScript SDK.Changes
availability.mdx (extensions page):
@betaand@deprecateddoc comment tagsstatus+messageobject syntax) up to the Endpoint section since it's a general feature of the extension, not SDK-specificgenerated-sdk.mdx (SDK user features page):
.listmethod strikethrough +@deprecatedtooltip from the Square TypeScript SDKReview & Testing Checklist for Human
.liststrikethrough visible,@deprecatedtag visible in tooltip)Notes
The
messagefield in the extended syntax currently only propagates into SDK doc comments — it does not appear in the API reference UI (which only shows availability badges). The docs reflect this accurately.Link to Devin session: https://app.devin.ai/sessions/1d83bbd025714d5a9add907f12034390
Requested by: @devalog