Skip to content
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.

Sign up for GitHub

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

Improve documentation on check command #35542

Merged
merged 2 commits into from
Feb 23, 2024
Merged

Improve documentation on check command #35542

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4700c95
Improve documentation on check command
maxi297 Feb 22, 2024
f47c543
Update docs/understanding-airbyte/airbyte-protocol.md
maxi297 Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/understanding-airbyte/airbyte-protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
maxi297 marked this conversation as resolved.
Show resolved Hide resolved

#### Input:

Expand Down
Loading