Include expected environment variables in `--about`

[MeltyBot]

Migrated from GitLab: https://gitlab.com/meltano/sdk/-/issues/214

Originally created by @edgarrmondragon on 2021-09-07 16:47:46

---

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.

[MeltyBot]

View 1 previous comment from the original issue on GitLab

[stale[bot]]

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.

[edgarrmondragon]

Still relevant

[stale[bot]]

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.

[edgarrmondragon]

Closed by https://github.com/meltano/sdk/pull/2555