sterling_paramore
08/08/2022, 5:54 PMdiscovery.yml
file somewhere in my (?) project, but there are just some keyword descriptions and not a complete example.visch
08/08/2022, 5:56 PMsterling_paramore
08/08/2022, 6:24 PMjosh_lloyd
10/28/2022, 5:09 PM.yml
file in the appropriate sub-directory (e.g., hub/_data/meltano/extractors/<tap-mytap>/<maintainer-name>.yml
).
I used one of the other taps as a template. And this doc as a guide as well.
Here is the template that comes when you try to submit a pull request (can’t find it prior to that step)
All Singer definitions are stored in `/_data/meltano/extractors/` or `/_data/meltano/loaders. The minimal requirement for adding a tap or target will match the following format:
```yaml
description: General description of what the company behind the API does
entity_type: Review the JSON Schema for latest options. Currently api, file, database.
entity_url: URL of the developer documentation or website
label: Properly formatted label of the connector
name: The unique name of the connector
singer_name: The Singer specific name of the connector. Typically tap-<name> or target-<name>
type: tap or target
variants: # an array of variant types
- default: true or false
maintenance_status: "Options: active, beta, development, inactive, unknown"
meltano_sdk: true or false
name: Name of the GitHub/GitLab namespace
pip_url: git+<git_url>.git or pip instal name
repo: repo URL
capabilities:
- catalog
- discover
settings:
# Can be an empty array if unknown: []
# Describe the list of supported settings, for example:
- name: project_ids
kind: array
label: Project IDs
description: Array of project IDs.
- name: username
label: Username
description: Credentials used when for connecting to the source.
- name: password
kind: password
label: Password
description: Credentials used when for connecting to the source.
## Checklist
- [ ] Add/update the file in the appropriate folder (/taps
or /targets
). The name of the file should match the name of the tap. If there is already one, add a descriptor to the name such as -search
.
- [ ] Add/update the PNG logo image in /assets/logos/<taps or targets>
. The image name must match the YAML file name.
- [ ] Tag @tayloramurphy
or @pnadolny13
to flag it for review. Or post to the [#hub](https://meltano.slack.com/archives/C01UGBSJNG5) channel on Meltano slack.```
Be aware that I was also told by @taylor that since my tap was the first of it’s kind and the default that I had to add an entry to the default_variants.yml
file