Skip to content

docs: show availability SDK output with TypeScript examples#5539

Merged
devalog merged 14 commits into
mainfrom
devin/1779122462-availability-sdk-output
May 18, 2026
Merged

docs: show availability SDK output with TypeScript examples#5539
devalog merged 14 commits into
mainfrom
devin/1779122462-availability-sdk-output

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented May 18, 2026

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):

  • Added "SDK output" section with OpenAPI → TypeScript SDK code examples showing @beta and @deprecated doc comment tags
  • Moved "Custom message" (status + message object syntax) up to the Endpoint section since it's a general feature of the extension, not SDK-specific

generated-sdk.mdx (SDK user features page):

  • Added "Availability" section with explanation of how availability propagates as doc comments
  • Includes a 2x high-DPI IDE screenshot showing .list method strikethrough + @deprecated tooltip from the Square TypeScript SDK
  • Caption links to the Square SDK source

Review & Testing Checklist for Human

  • Verify the screenshot renders crisp and readable at its display size on the SDK user features page (no right-side clipping, .list strikethrough visible, @deprecated tag visible in tooltip)
  • Confirm the "Custom message" subsection reads naturally under the Endpoint heading on the availability extensions page
  • Check that cross-page link from generated-sdk.mdx to the availability extension page resolves correctly

Notes

The message field 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

…e client reference

Co-Authored-By: Devin Logan <devinannlogan@gmail.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 and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 18, 2026

devin-ai-integration Bot and others added 13 commits May 18, 2026 16:54
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>
@devalog devalog merged commit 234a9f4 into main May 18, 2026
4 checks passed
@devalog devalog deleted the devin/1779122462-availability-sdk-output branch May 18, 2026 19:16
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.

1 participant