docs: sync failure webhooks gain errorType and errorOrigin
#55809
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -96,6 +100,8 @@ Airbyte passes both the `data` payload along with text blocks that are intended | |||
| } | |||
| ``` | |||
|
|
|||
| Note that `errorType` refers to the type of error that occurred, and may indicate the need for a followup action. For example `config_error` indicates a problem with the source or destination configuration (look to `errorOrigin`), while `transient_error` indicates a temporary issue that may resolve itself. | |||
|
|
|||
There was a problem hiding this comment.
Minor comment: it looks like these are the only two possible values, but the way the example is written, it feels like other error types might be possible. As a reader I'd feel more confident if we were firm about the possibilities here. "Two error types are possible: config_error and transient_error..." and so forth.
There was a problem hiding this comment.
Agree! I'd much rather link out to another page where we enumerate all the possible failure types... do we have that? I can't find it. There's:
- config_error
- system_error
- transient_error
- ... and others!
There was a problem hiding this comment.
Not that I can find. ChatGPT wasn't much help which tells me this has probably never been documented publicly. Maybe let's merge this for now and I'll see if Devin can put together a list quickly.
There was a problem hiding this comment.
Here's the list of failure reasons in the code for reference - https://github.com/airbytehq/airbyte-platform-internal/blob/master/oss/airbyte-config/config-models/src/main/resources/types/FailureReason.yaml#L22-L32
Docs related to https://github.com/airbytehq/airbyte-platform-internal/pull/15563