Skip to content

Commit 0b800f9

Browse files
nemeckova-smrtnzlml
authored andcommitted
Add mode to REST API export
1 parent 26c81d3 commit 0b800f9

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/learn/export-pipeline/rest-api-export.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,14 +263,15 @@ Example configuration with status code resolver:
263263
The export object consists of the following parameters:
264264

265265
| Attribute | Type | Description |
266-
| --------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
266+
|-----------------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
267267
| `export_reference_key` | str | A unique key referencing the exported data prepared by the [Custom format templating extension](./custom-format-templating.md). |
268268
| `request` | object | Defines the REST API request (URL, method, headers, and body content). |
269269
| `auth` _(optional)_ | object | Configuration for authentication, supporting OAuth2. |
270270
| `condition` _(optional)_ | str | Reference to a `schema_id` in `annotation.content` controlling execution. When it's empty or "false" (case insensitive), this section won't be evaluated. Otherwise, it will proceed. The condition definition follows the [JSON templating](./../json-templating/index.md) syntax e.g. `"condition": "@{api_gate}"` |
271271
| `response_headers_reference_key` _(optional)_ | str | Key to store API response headers (including `status_code`). |
272272
| `response_payload_reference_key` _(optional)_ | str | Key to store the full response body from the API. |
273273
| `status_code_resolver` _(optional)_ | object | Defines status code handling. |
274+
| `mode` _(optional)_ | str | Resiliency mode for the export request. Mode "wait" is designed for slow APIs so the timeout is high. Mode "retry" is designed for fast but flaky APIs so the request is retried a few times in case it fails. Defaults to "wait". |
274275

275276
### Request Object
276277

0 commit comments

Comments
 (0)