Support token and url keys without hyphens #70
Conversation
|
/easycla |
README.md
Outdated
| | `api-token` | (Required) The token for communicating with the Dynatrace service. | ||
| | Key | Value Description | | ||
| |------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `api-url`, `apiurl`, or `environment-id` | (Required) The base URL of the Dynatrace API. If not set, `environment-id` must be set. <br/> --- <br/> If neither `api-url` or `apiurl` is set, a URL is configured in the form: https://<`environment-id`>.live.dynatrace.com/api. | |
There was a problem hiding this comment.
I worry that listing both might create some consternation with users over which one to use (it could just be my brain also). Anyway, while this PR makes it technically accept either one, I think we should continue to promote using api-url in this section (i.e. no need to change this table). It's just more direct that way.
I think your **Note** at the bottom is sufficient to document that fact that we also permit the keys without dashes. The key is that for compatibility we allow it to do both. If you need it to not have the - then it'll work, but we recommend using it with the -.
There was a problem hiding this comment.
Just pushed a change - please review and resolve if that works for you.
|
Looks good, just two minor notes. |
Summary
Support token and url keys without hyphens
Use Cases
CF Java buildpack uses
apitokenandapiurlinstead ofapi-tokenandapi-url.This PR will allow using either option, preferring the existing
api-tokenandapi-urloptions.https://paketobuildpacks.slack.com/archives/C040DPFJMQV/p1689078089284269
Checklist
I have added an integration test, if necessary.