Merge pull request #29 from iver-wharf/feature/fix-cors-config-doc

Fixed AllowAllOrigins doc comment
iver-wharf · Aug 25, 2021 · 5d78ee8 · 5d78ee8
2 parents f232659 + 49c16f2
commit 5d78ee8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,7 +21,7 @@ This project tries to follow [SemVer 2.0.0](https://semver.org/).
   `github.com/iver-wharf/wharf-core/pkg/config` together with new config models
   for configuring wharf-provider-github. See `config.go` or the reference
   documentation on the `Config` type for information on how to configure
-  wharf-provider-github. (#19)
+  wharf-provider-github. (#19, #29)
 
 - Added config for setting bind address and port. (#14, #19)
 

diff --git a/config.go b/config.go
@@ -60,7 +60,9 @@ type HTTPConfig struct {
 
 // CORSConfig holds settings for the HTTP server's CORS settings.
 type CORSConfig struct {
-	// AllowAllOrigins enables all
+	// AllowAllOrigins enables CORS and allows all hostnames and URLs in the
+	// HTTP request origins when set to true. Practically speaking, this
+	// results in the HTTP header "Access-Control-Allow-Origin" set to "*".
 	//
 	// For backward compatibility, that may be removed in the next major release
 	// (v3.0.0), the environment variable ALLOW_CORS, which was added in v0.6.0,