Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

docs(asyncapi): update retry docs to use x-fern-retries and mark unsupported

Summary

Updates the AsyncAPI retry extension documentation to align with issue #10597 option #1:

  • Changes extension name from x-fern-retry (singular) to x-fern-retries (plural) to match OpenAPI naming convention
  • Adds prominent warning that this extension is not supported for AsyncAPI WebSocket channels
  • Explains why retry semantics don't apply to persistent WebSocket connections (unlike HTTP request-response)
  • Updates example to show the extension will be ignored with a warning during import

This documentation change corresponds to the CLI implementation in fern-api/fern#10598, which adds a warning when x-fern-retries is detected in AsyncAPI specs.

Review & Testing Checklist for Human

  • Verify warning message accuracy: Check that the warning message described in the docs matches what the CLI actually emits (see fix(cli): warn on AsyncAPI x-fern-retries extension fern#10598)
  • Test the OpenAPI retries link: Verify that /api-definition/openapi/extensions/retries resolves correctly in the docs site
  • Confirm naming convention: Verify that x-fern-retries (plural) is indeed the correct naming used in OpenAPI extension docs
  • Review technical explanation: Confirm that the explanation about WebSocket vs HTTP retry semantics is accurate and clear

Notes

… mark as unsupported

Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
@devin-ai-integration
Copy link
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

---
title: Retry behavior
description: Configure retry behavior for operations using `x-fern-retry` extension
description: The `x-fern-retries` extension is not supported for AsyncAPI
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
@github-actions
Copy link
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.

1 participant