Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: Add a guide on how to define the configuration schema for a new connector #1727

Closed
edgarrmondragon opened this issue May 23, 2023 · 1 comment · Fixed by #2449
Closed
Labels
Documentation Improvements or additions to documentation stale valuestream/SDK

Comments

@edgarrmondragon
Copy link
Collaborator

Documentation type

How-to guides

Description

It should

  • mention that a default=... means the config dict will always have a value for the setting, so it should be retrieved with square brackets: self.config["<setting name>"]
  • encourage developers to mark settings as required=True when the connector can't be executed without them. These settings should also be retrieved with self.config["<setting name>"].
Copy link

stale bot commented May 22, 2024

This has been marked as stale because it is unassigned, and has not had recent activity. It will be closed after 21 days if no further activity occurs. If this should never go stale, please add the evergreen label, or request that it be added.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Documentation Improvements or additions to documentation stale valuestream/SDK
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant