pki: Add docs to some struct fields

1 files changed, 10 insertions, 2 deletions

diff --git a/modules/caddypki/crypto.go b/modules/caddypki/crypto.go
index e701c40..e1a0e35 100644
--- a/modules/caddypki/crypto.go
+++ b/modules/caddypki/crypto.go
@@ -120,9 +120,17 @@ func trusted(cert *x509.Certificate) bool {
 // KeyPair represents a public-private key pair, where the
 // public key is also called a certificate.
 type KeyPair struct {
+	// The certificate. By default, this should be the path to
+	// a PEM file unless format is something else.
 	Certificate string `json:"certificate,omitempty"`
-	PrivateKey  string `json:"private_key,omitempty"`
-	Format      string `json:"format,omitempty"`
+
+	// The private key. By default, this should be the path to
+	// a PEM file unless format is something else.
+	PrivateKey string `json:"private_key,omitempty"`
+
+	// The format in which the certificate and private
+	// key are provided. Default: pem_file
+	Format string `json:"format,omitempty"`
 }
 
 // Load loads the certificate and key.