From 4700c95dc0cec35b3bdfbce4dd87fc2e9bb3871f Mon Sep 17 00:00:00 2001 From: maxi297 Date: Thu, 22 Feb 2024 09:55:59 -0500 Subject: [PATCH 1/2] Improve documentation on check command --- docs/understanding-airbyte/airbyte-protocol.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/understanding-airbyte/airbyte-protocol.md b/docs/understanding-airbyte/airbyte-protocol.md index e673ff9f3ade..eb36af416801 100644 --- a/docs/understanding-airbyte/airbyte-protocol.md +++ b/docs/understanding-airbyte/airbyte-protocol.md @@ -108,7 +108,7 @@ The `spec` command allows an actor to broadcast information about itself and how check(Config) -> AirbyteConnectionStatus ``` -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. +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 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. If it fails because of a connector issue, the `check` command should return a trace message. If an actor's `check` command succeeds, it is expected that all subsequent methods in the sync will also succeed. #### Input: From f47c543efe6a9f758bc27c21f3e0bf64141df3b2 Mon Sep 17 00:00:00 2001 From: Maxime Carbonneau-Leclerc <3360483+maxi297@users.noreply.github.com> Date: Fri, 23 Feb 2024 11:56:33 -0500 Subject: [PATCH 2/2] Update docs/understanding-airbyte/airbyte-protocol.md Co-authored-by: Ella Rohm-Ensing --- docs/understanding-airbyte/airbyte-protocol.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/understanding-airbyte/airbyte-protocol.md b/docs/understanding-airbyte/airbyte-protocol.md index eb36af416801..19f59a160b2f 100644 --- a/docs/understanding-airbyte/airbyte-protocol.md +++ b/docs/understanding-airbyte/airbyte-protocol.md @@ -108,7 +108,12 @@ The `spec` command allows an actor to broadcast information about itself and how check(Config) -> AirbyteConnectionStatus ``` -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 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. If it fails because of a connector issue, the `check` command should return a trace message. If an actor's `check` command succeeds, it is expected that all subsequent methods in the sync will also succeed. +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: +- If it can, the `check` command will return a success response. +- 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. +- 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. + +If an actor's `check` command succeeds, it is expected that all subsequent methods in the sync will also succeed. #### Input: