more documentation to god of documentation

heyxkhoa · Aug 26, 2021 · e79f0e6 · e79f0e6
1 parent 4779096
commit e79f0e6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/internal/home/tls.go b/internal/home/tls.go
@@ -214,6 +214,8 @@ type tlsConfig struct {
 	tlsConfigSettingsExt `json:",inline"`
 }
 
+// tlsConfigSettingsExt - extra struct for encapsulate boolean flag about
+// the private key, needs for avoid changing base struct tlsConfigSettings
 type tlsConfigSettingsExt struct {
 	tlsConfigSettings `json:",inline"`
 	// If private key saved as a string, we set this flag to true

diff --git a/openapi/CHANGELOG.md b/openapi/CHANGELOG.md
@@ -9,7 +9,7 @@
 * The new field `"private_key_saved"` in `POST /control/tls/configure`,
 `POST /control/tls/validate` and `GET /control/tls/status` is true if the
 private key was previously saved as a string and now the private key omitted
-from communication between server and client due to to security issues.
+from communication between server and client due to security issues.
 
 ### The new field `"cache_optimistic"` in DNS configuration