Skip to content

Commit 7b6e81e

Browse files
maxi297erohmensing
authored andcommitted
Improve documentation on check command (airbytehq#35542)
Co-authored-by: Ella Rohm-Ensing <[email protected]>
1 parent 87a326e commit 7b6e81e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/understanding-airbyte/airbyte-protocol.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,12 @@ The `spec` command allows an actor to broadcast information about itself and how
108108
check(Config) -> AirbyteConnectionStatus
109109
```
110110

111-
The `check` command validates that, given a configuration, that the Actor is able to connect and access all resources that it needs in order to operate. e.g. Given some Postgres credentials, it determines whether it can connect to the Postgres database. If it can, it will return a success response. If it fails (perhaps the password is incorrect), it will return a failed response and (when possible) a helpful error message. If an actor's `check` command succeeds, it is expected that all subsequent methods in the sync will also succeed.
111+
The `check` command validates that, given a configuration, that the Actor is able to connect and access all resources that it needs in order to operate. e.g. Given some Postgres credentials, it determines whether it can connect to the Postgres database. The output will be as follows:
112+
- If it can, the `check` command will return a success response.
113+
- If `check` fails because of a configuration issue (perhaps the password is incorrect), it will return a failed response and (when possible) a helpful error message. A failed response will be considered as a config error, i.e. user error. Outputting a trace message detailing the config error is optional, but allows for more detailed debugging of the error.
114+
- If it fails because of a connector issue, the `check` command should output a trace message detailing the failure. It is not expected to receive an `AirbyteConnectionStatus` in this failure case.
115+
116+
If an actor's `check` command succeeds, it is expected that all subsequent methods in the sync will also succeed.
112117

113118
#### Input:
114119

0 commit comments

Comments
 (0)