From b0f86bc007f56eed7e4ab36f851c5dd5de7cbc35 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Wed, 25 Jul 2018 12:59:04 -0400 Subject: [PATCH] Documentation: Clarify the when to implement certain interfaces (#376) --- providers/providers.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/providers/providers.go b/providers/providers.go index d1d800a03..dbebedc56 100644 --- a/providers/providers.go +++ b/providers/providers.go @@ -8,18 +8,18 @@ import ( "github.com/pkg/errors" ) -// Registrar is an interface for a domain registrar. It can return a list of needed corrections to be applied in the future. +// Registrar is an interface for a domain registrar. It can return a list of needed corrections to be applied in the future. Implement this only if the provider is a "registrar" (i.e. can update the NS records of the parent to a domain). type Registrar interface { models.Registrar } -// DNSServiceProvider is able to generate a set of corrections that need to be made to correct records for a domain +// DNSServiceProvider is able to generate a set of corrections that need to be made to correct records for a domain. Implement this only if the provider is a DNS Service Provider (can update records in a DNS zone). type DNSServiceProvider interface { models.DNSProvider } // DomainCreator should be implemented by providers that have the ability to add domains to an account. the create-domains command -// can be run to ensure all domains are present before running preview/push +// can be run to ensure all domains are present before running preview/push. Implement this only if the provider supoprts the `dnscontrol create-domain` command. type DomainCreator interface { EnsureDomainExists(domain string) error }