Add small feedback

nginx · Jan 30, 2025 · b538622 · b538622
1 parent e28a213
commit b538622
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/apis/v1alpha1/nginxproxy_types.go b/apis/v1alpha1/nginxproxy_types.go
@@ -193,7 +193,7 @@ const (
 	IPv6 IPFamilyType = "ipv6"
 )
 
-// RewriteClientIPAddress is a struct that specifies address type and value.
+// RewriteClientIPAddress specifies the address type and value for a RewriteClientIP address.
 type RewriteClientIPAddress struct {
 	// Type specifies the type of address.
 	Type RewriteClientIPAddressType `json:"type"`
@@ -217,7 +217,7 @@ const (
 	RewriteClientIPHostnameAddressType RewriteClientIPAddressType = "Hostname"
 )
 
-// NginxPlusAllowAddress is a struct that specifies address type and value.
+// NginxPlusAllowAddress specifies the address type and value for an NginxPlus allow address.
 type NginxPlusAllowAddress struct {
 	// Type specifies the type of address.
 	Type NginxPlusAllowAddressType `json:"type"`

diff --git a/config/crd/bases/gateway.nginx.org_nginxproxies.yaml b/config/crd/bases/gateway.nginx.org_nginxproxies.yaml
@@ -90,8 +90,8 @@ spec:
                     description: AllowedAddresses specifies IPAddresses or CIDR blocks
                       to the allow list for accessing the NGINX Plus API.
                     items:
-                      description: NginxPlusAllowAddress is a struct that specifies
-                        address type and value.
+                      description: NginxPlusAllowAddress specifies the address type
+                        and value for an NginxPlus allow address.
                       properties:
                         type:
                           description: Type specifies the type of address.
@@ -147,8 +147,8 @@ spec:
                       Sets NGINX directive set_real_ip_from: https://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from
                       This field is required if mode is set.
                     items:
-                      description: RewriteClientIPAddress is a struct that specifies
-                        address type and value.
+                      description: RewriteClientIPAddress specifies the address type
+                        and value for a RewriteClientIP address.
                       properties:
                         type:
                           description: Type specifies the type of address.

diff --git a/deploy/crds.yaml b/deploy/crds.yaml
@@ -675,8 +675,8 @@ spec:
                     description: AllowedAddresses specifies IPAddresses or CIDR blocks
                       to the allow list for accessing the NGINX Plus API.
                     items:
-                      description: NginxPlusAllowAddress is a struct that specifies
-                        address type and value.
+                      description: NginxPlusAllowAddress specifies the address type
+                        and value for an NginxPlus allow address.
                       properties:
                         type:
                           description: Type specifies the type of address.
@@ -732,8 +732,8 @@ spec:
                       Sets NGINX directive set_real_ip_from: https://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from
                       This field is required if mode is set.
                     items:
-                      description: RewriteClientIPAddress is a struct that specifies
-                        address type and value.
+                      description: RewriteClientIPAddress specifies the address type
+                        and value for a RewriteClientIP address.
                       properties:
                         type:
                           description: Type specifies the type of address.

diff --git a/internal/mode/static/state/dataplane/configuration_test.go b/internal/mode/static/state/dataplane/configuration_test.go
@@ -4538,7 +4538,7 @@ func TestBuildNginxPlus(t *testing.T) {
 			expNginxPlus: defaultNginxPlus,
 		},
 		{
-			msg: "NginxProxy does not specify Nginx Plus settings",
+			msg: "NginxPlus default values are used when NginxProxy doesn't specify NginxPlus settings",
 			g: &graph.Graph{
 				NginxProxy: &graph.NginxProxy{
 					Valid: true,

diff --git a/site/content/reference/api.md b/site/content/reference/api.md
@@ -1382,7 +1382,7 @@ crit, alert, and emerg messages to be logged. <a href="https://nginx.org/en/docs
 <a href="#gateway.nginx.org/v1alpha1.NginxPlus">NginxPlus</a>)
 </p>
 <p>
-<p>NginxPlusAllowAddress is a struct that specifies address type and value.</p>
+<p>NginxPlusAllowAddress specifies the address type and value for an NginxPlus allow address.</p>
 </p>
 <table class="table table-bordered table-striped">
 <thead>
@@ -1683,7 +1683,7 @@ This field is required if mode is set.</p>
 <a href="#gateway.nginx.org/v1alpha1.RewriteClientIP">RewriteClientIP</a>)
 </p>
 <p>
-<p>RewriteClientIPAddress is a struct that specifies address type and value.</p>
+<p>RewriteClientIPAddress specifies the address type and value for a RewriteClientIP address.</p>
 </p>
 <table class="table table-bordered table-striped">
 <thead>