refactor(cSDK): Mandatory configuration.json in configuration_form example - #616
refactor(cSDK): Mandatory configuration.json in configuration_form example#616fivetran-satvikpatil wants to merge 5 commits into
Conversation
|
Satvik Patil seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
1 similar comment
|
Satvik Patil seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
There was a problem hiding this comment.
Pull request overview
This pull request introduces a configuration.json file to the examples/quickstart/configuration_form example to satisfy the “mandatory configuration.json” requirement described in RD-1241560 (and related to PR #606).
Changes:
- Added
examples/quickstart/configuration_form/configuration.jsonas an (currently empty) configuration file.
| @@ -0,0 +1 @@ | |||
| {} No newline at end of file | |||
There was a problem hiding this comment.
@fivetran-satvikpatil Can we update readme for this?
Currently it says this :
The API fields (api_base_url, api_key) in the configuration form illustrate how a real connector would collect connection details. The configuration.json file provided contains sample values for running the connector locally.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 90691a2f03
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1 @@ | |||
| {} No newline at end of file | |||
There was a problem hiding this comment.
When users run this example from a fresh checkout with the newly provided configuration.json, the file is {} even though this connector's setup form marks api_base_url and api_key as required and update() builds the request URL from configuration.get("api_base_url", ""). The documented local debug path using configuration.json therefore sends "/posts" as the URL and fails before syncing; please include usable sample/placeholder values for the required form fields, or don't ship an empty config for this configured example.
Useful? React with 👍 / 👎.
fivetran-satvikpatil
changed the title
fivetran-chinmayichandrasekar
left a comment
fivetran-chinmayichandrasekar
left a comment
There was a problem hiding this comment.
Left a couple of suggestions. Thanks
| This example demonstrates how to define a connector setup form using `ConfigurationForm`, `form_field`, and `Test` from the Fivetran Connector SDK. It covers plain text, password, dropdown, and toggle fields, including dropdown options with labels and descriptions. It also shows how to register a connection test that Fivetran runs when the user clicks **Test Connection** during setup. | ||
|
|
||
| The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. The `configuration.json` file provided contains sample values for running the connector locally. | ||
| The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. An empty `configuration.json` file is included as a placeholder — you can populate it by running `fivetran configuration` or by providing values through the Fivetran UI after deployment. |
There was a problem hiding this comment.
{% note %}
This project includes an empty configuration.json because it is required during deployment. You can optionally populate it to test the setup form fields, then deploy with the pre-populated file so the values appear pre-filled in the setup form. {% /note %}
|
@fivetran-satvikpatil In the Getting started section, we should remove "generates" from step 1: |
Co-authored-by: fivetran-chinmayichandrasekar <chinmayi.chandrasekar@fivetran.com>
Jira ticket
Closes RD-1241560
Description of Change
Mandatory configuration.json
Related PR: #606
Testing