PYTHON-2371 Document expected masterKey fields for new KMS providers #125
Conversation
| following fields:: | ||
|
|
||
| - `keyVaultEndpoint` (string): Host with optional port, e.g. | ||
| "example.vault.azure.net". |
There was a problem hiding this comment.
Nit: suggest moving keyVaultEndpoint to the end to be consistent with aws "endpoint" and gcp "endpoint". Also it's a bit odd that this field is named keyVaultEndpoint instead of just "endpoint". Is there a reason for that?
There was a problem hiding this comment.
I have not placed it as you have suggested because for azure this is a required field, whereas for other KMS providers it is optional (generally we list required options before listing the optional ones).
As for why the field is named keyVaultEndpoint and not endpoint, I just used the same name that we intend to pass to libmongocrypt - this is also the name for this option in the spec. @kevinAlbs should be able to shed some light on why it was so named.
There was a problem hiding this comment.
Okay, can you add "Required." for this option?
| following fields:: | ||
|
|
||
| - `keyVaultEndpoint` (string): Host with optional port, e.g. | ||
| "example.vault.azure.net". |
There was a problem hiding this comment.
Okay, can you add "Required." for this option?
I overlooked adding these in #118
@kevinAlbs I did the best I could to add a brief description for each of these fields. It would be helpful if you could give it a quick read and give your feedback.