Include expected environment variables in `--about`
Summary
Include expected environment variables as part of the output of the --about
CLI option.
Proposed benefits
Plugin developers developers and users can see the names of the environment variables their tap/target will look for when using --config=ENV
.
This could later be used to by Meltano to set alternative names (aliases) for the plugin environment variables.
Proposal details
Include the environment variable names of settings in the JSON Schema printed out by --about
. Something like
{
"name": "my-tap",
"version": "0.0.1",
"sdk_version": "0.3.6",
"capabilities": [
"sync",
"catalog",
"state",
"discover"
],
"settings": {
"type": "object",
"properties": {
"password": {
"type": [
"string"
],
"environmentVariables": [
"MY_TAP_PASSWORD"
]
},
"base_url": {
"type": [
"string",
"null"
],
"default": "https://someapi.com",
"environmentVariables": [
"MY_TAP_BASE_URL"
]
}
}
"required": [
"password"
]
}
}
Best reasons not to build
Such a field is not part of the JSON Schema spec.