document NamedAddress

kubernetes-sigs · Oct 7, 2020 · 766c6f6 · 766c6f6
1 parent 9c92ae4
commit 766c6f6
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/apis/v1alpha1/gateway_types.go b/apis/v1alpha1/gateway_types.go
@@ -527,8 +527,10 @@ type GatewayAddress struct {
 // AddressType defines how a network address is represented as a text string.
 // Valid AddressType values are:
 //
-// * "IPAddress"
-// * "NamedAddress"
+// * "IPAddress": an IPv4 or IPv6 address
+// * "NamedAddress": an opaque identifier, controller-dependent
+//
+// A NamedAddress might be a cloud-dependent ID for a "static" or "elastic" IP
 //
 // +kubebuilder:validation:Enum=IPAddress;NamedAddress
 type AddressType string

diff --git a/docs-src/spec.md b/docs-src/spec.md
diff --git a/docs/spec/index.html b/docs/spec/index.html