Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarrmondragon committed Oct 9, 2024
1 parent 9895a52 commit 3b2934a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/guides/config-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Explanation of the configuration schema defined above:
- The `th.StringType`, `th.DateTimeType`, etc. helpers are used to define the type of the property.
- The `required` attribute is used to mark a property as required. The tap will throw an error if the user does not provide a value for a required property.
- The `default` attribute is used to provide a default value for a property. The tap will use this if the user does not provide a value, so this can be accessed in the tap or streams with square bracket syntax, i.e. `self.config["base_url"]`.
- The `title` attribute is used to provide a human-readable title for the property.
- The `to_dict()` method is used to convert the JSON object to a Python dictionary.

See the full reference for the [typing module](../typing.rst) for more information on how to define a configuration schema.

0 comments on commit 3b2934a

Please sign in to comment.