Skip to content

Commit

Permalink
Update 4-connection-checking.md (#13812)
Browse files Browse the repository at this point in the history
* Update 4-connection-checking.md

As discussed in https://airbytehq-team.slack.com/archives/C02UQ9MJ4GG/p1655312684160609 - this example is misleading, as it does not actually connect to any API to validate connectivity.

* Update 4-connection-checking.md

Added a link to OneSignal check_connection, and move the "Note" to below the example
  • Loading branch information
alexander-marquardt authored Jun 15, 2022
1 parent 649f7ad commit 6a78aec
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Following the docstring instructions, we'll change the implementation to verify
return True, None
```

Note: in a real implementation you should write code to connect to the API to validate connectivity and not just validate inputs - for an example see `check_connection` in the [OneSignal source connector implementation](https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-onesignal/source_onesignal/source.py)

Let's test out this implementation by creating two objects: a valid and an invalid config and attempt to give them as input to the connector. For this section, you will need to take the API access key generated earlier and add it to both configs. Because these configs contain secrets, we recommend storing configs which contain secrets in `secrets/config.json` because the `secrets` directory is gitignored by default.

```text
Expand Down

0 comments on commit 6a78aec

Please sign in to comment.