Add x-fern-retries OpenAPI extension documentation #1824
Merged
+53
−0
Conversation
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
- Add x-fern-retries to extensions overview table - Create dedicated retries.mdx page with examples - Add retry behavior page to navigation - Document Python SDK-only support for retry configuration Co-Authored-By: adi@buildwithfern.com <aditya.arolkar@berkeley.edu>
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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| --- | ||
|
|
||
| <Callout intent="info"> | ||
| The `x-fern-retries` extension is currently supported in Python SDKs only. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
| type: string | ||
| ``` | ||
|
|
||
| When retries are disabled at the endpoint level, the generated SDK will not retry failed requests to that endpoint, regardless of the end user's SDK configuration. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'won't' instead of 'will not'.
|
|
||
| ## Example: Disable retries for a POST endpoint | ||
|
|
||
| In this example, we disable retries for a plant creation endpoint to prevent duplicate entries: |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.We] Try to avoid using first-person plural like 'we'.
Contributor
- Remove 'currently' (time-relative term) - Use 'won't' instead of 'will not' (contractions) - Remove 'we' (first-person plural) Co-Authored-By: adi@buildwithfern.com <aditya.arolkar@berkeley.edu>
Contributor
Contributor
Contributor
Contributor
devalog
approved these changes
Nov 6, 2025
Contributor
aditya-arolkar-swe
deleted the
devin/1762458647-add-x-fern-retries-extension-docs
branch
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.
Add x-fern-retries OpenAPI extension documentation
Summary
This PR documents the new
x-fern-retriesOpenAPI extension that allows configuring retry behavior at the endpoint level for Python SDKs. The documentation includes:x-fern-retriesto the extensions overview table with a note that it's Python SDK only/learn/api-definitions/openapi/extensions/retrieswith:disabled: trueReview & Testing Checklist for Human
disabled: trueconfiguration and behavior description match the actual implementation. Check if there are other configuration options (retry count, backoff strategy, etc.) that should be documented.Notes
Link to Devin run: https://app.devin.ai/sessions/5ae3523f039b4955a258c627a4fbcb61
Requested by: adi@buildwithfern.com (@aditya-arolkar-swe)