search

airbytehq / airbyte

The leading data integration platform for ETL / ELT data pipelines from APIs, databases & files to data warehouses, data lakes & data lakehouses. Both self-hosted and Cloud-hosted.
https://airbyte.com
Other
15.91k stars 4.09k forks source link

Give an example of JSON input for BigQuery source #7259

Open nataliekwong opened 2 years ago

nataliekwong commented 2 years ago

Tell us about the problem you're trying to solve

While entering in the JSON for authentication to BigQuery, I am not sure how much of the JSON to paste into the text box. Without instructions, I may only paste the key instead of the entire file.

Describe the solution you’d like

I would like more directions on what part of the JSON file to paste in. I would like to see, in the documentation or UI, explicitly what needs to be pasted in, ideally with an example in the documentation.

Describe the alternative you’ve considered or used

Other solutions that require similar JSON inputs use a file upload instead. This could reduce error as the user would not typically edit their file before uploading it.

avaidyanatha commented 2 years ago

@nataliekwong I'd argue that we should make this clear in the UI, not the docs - but this is a very good point.

nataliekwong commented 11 months ago

Same feedback from a user here: https://airbytehq-team.slack.com/archives/C02U6CXJQFN/p1698445368573419

I was confused because the text box for that line of the sign up was only a single line but the json file is several lines of code. Since you asked, I would recommend in the tooltip on that stage of the integration to include a sample of the full text that should be input into that field. The single line threw me off when configuring the integration. The name of the field on Airbyte is Service Account Key JSON, but within the service account file there's also a "private_key" field, so i wasn't sure if i included the full file or just that line. Without the JSON file the connection check with bigquery worked but when I tried to connect with shopify there was an unknown error which i determined was the authentication error on the big query side.