-
Notifications
You must be signed in to change notification settings - Fork 4
docs(asyncapi): update retry extension docs to use x-fern-retries and mark as unsupported #2055
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
devin-ai-integration
wants to merge
3
commits into
main
Choose a base branch
from
devin/1763338730-update-asyncapi-retry-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+19
−10
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
6061d63
docs(asyncapi): update retry extension docs to use x-fern-retries and…
devin-ai-integration[bot] 9e5103f
fix(docs): escape curly braces in CLI changelog to fix MDX parse error
devin-ai-integration[bot] 106c931
Merge branch 'devin/1763338928-fix-mdx-parse-error' into devin/176333…
devin-ai-integration[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,28 @@ | ||
| --- | ||
| 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 | ||
| --- | ||
|
|
||
| Configure retry behavior for operations: | ||
| <Callout intent="warning"> | ||
| The `x-fern-retries` extension is **not supported** for AsyncAPI WebSocket channels. Retry configuration is only available for OpenAPI HTTP endpoints. If you use this extension in your AsyncAPI specification, it will be ignored and a warning will be emitted during import. | ||
| </Callout> | ||
|
|
||
| ```yaml title="asyncapi.yml" {6-10} | ||
| For retry configuration on HTTP endpoints, use the [`x-fern-retries` extension in OpenAPI](/api-definition/openapi/extensions/retries) instead. | ||
|
|
||
| ## Why retries aren't supported for AsyncAPI | ||
|
|
||
| AsyncAPI specifications define WebSocket channels, which are persistent, bidirectional connections. Unlike HTTP requests that follow a request-response pattern where retry logic is meaningful, WebSocket connections maintain a continuous connection where retry semantics don't apply in the same way. | ||
|
|
||
| ## Example (not supported) | ||
|
|
||
| The following example shows the `x-fern-retries` extension in an AsyncAPI specification. This will emit a warning during import and the extension will be ignored: | ||
|
|
||
| ```yaml title="asyncapi.yml" {6-7} | ||
| operations: | ||
| sendCriticalAlert: | ||
| action: send | ||
| channel: | ||
| $ref: '#/channels/alerts' | ||
| x-fern-retry: | ||
| max_attempts: 3 | ||
| exponential_backoff: true | ||
| initial_delay: 1000 | ||
| max_delay: 30000 | ||
| ``` | ||
| x-fern-retries: | ||
| disabled: true | ||
| ``` | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
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'.