Closed robertfairhead closed 4 years ago
@UserNotFound welcome your thoughts on the naming of this field. I couldn't find any existing user-facing references, but I could very much have missed something.
/cc @joshraker @bayley-aptible if you have thoughts too
As far as anything with official documentation, we seem to just use phrases like "the domain you intend to use with your Endpoint" or "your own domain". I think the most accurate/concise term would maybe be "Common Name", since that represents the server name protected by the certificate. (virtual_host is appropriately "null" for TCP endpoints)
virtual_domain
seems consistent with the identically named decorator you'd find when using the API directly. The CLI doesn't expose this information, so no discrepancy there.
The virtual domain field contains the appropriate URL to access an endpoint.
~I decided to call it
endpoint_domain
here because that seemed clearer to me thanvirtual_domain
.~ I couldn't find any references in either the dashboard or the docs to that domain, so I made a choice. If there's something else out there that already refers to that domain, then we should change here for consistency.I changed this to be
virtual_domain
after some internal discussion. This is consistent with our API.We'll probably also want to add this to our Terraform docs.