Merge pull request #101627 from rikatz/fix-ingress-doc

Change ingress api doc to reflect the correct path validation

api/openapi-spec/swagger.json

@@ -12417,7 +12417,7 @@
           "description": "Backend defines the referenced service endpoint to which the traffic will be forwarded to."
         },
         "path": {
-          "description": "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.",
+          "description": "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value \"Exact\" or \"Prefix\".",
           "type": "string"
         },
         "pathType": {
@@ -12943,7 +12943,7 @@
           "description": "Backend defines the referenced service endpoint to which the traffic will be forwarded to."
         },
         "path": {
-          "description": "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.",
+          "description": "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value \"Exact\" or \"Prefix\".",
           "type": "string"
         },
         "pathType": {

pkg/apis/networking/types.go

@@ -492,8 +492,8 @@ const (
 type HTTPIngressPath struct {
 	// Path is matched against the path of an incoming request. Currently it can
 	// contain characters disallowed from the conventional "path" part of a URL
-	// as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
+	// as defined by RFC 3986. Paths must begin with a '/' and must be present
-	// all paths from incoming requests are matched.
+	// when using PathType with value "Exact" or "Prefix".
 	// +optional
 	Path string
 

staging/src/k8s.io/api/networking/v1/generated.proto

@@ -35,8 +35,8 @@ option go_package = "v1";
 message HTTPIngressPath {
   // Path is matched against the path of an incoming request. Currently it can
   // contain characters disallowed from the conventional "path" part of a URL
-  // as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
+  // as defined by RFC 3986. Paths must begin with a '/' and must be present
-  // all paths from incoming requests are matched.
+  // when using PathType with value "Exact" or "Prefix".
   // +optional
   optional string path = 1;
 

staging/src/k8s.io/api/networking/v1/types.go

@@ -407,8 +407,8 @@ const (
 type HTTPIngressPath struct {
 	// Path is matched against the path of an incoming request. Currently it can
 	// contain characters disallowed from the conventional "path" part of a URL
-	// as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
+	// as defined by RFC 3986. Paths must begin with a '/' and must be present
-	// all paths from incoming requests are matched.
+	// when using PathType with value "Exact" or "Prefix".
 	// +optional
 	Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"`
 

staging/src/k8s.io/api/networking/v1/types_swagger_doc_generated.go

@@ -29,7 +29,7 @@ package v1
 // AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT.
 var map_HTTPIngressPath = map[string]string{
 	"":         "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.",
-	"path":     "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.",
+	"path":     "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value \"Exact\" or \"Prefix\".",
 	"pathType": "PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is\n  done on a path element by element basis. A path element refers is the\n  list of labels in the path split by the '/' separator. A request is a\n  match for path p if every p is an element-wise prefix of p of the\n  request path. Note that if the last element of the path is a substring\n  of the last element in request path, it is not a match (e.g. /foo/bar\n  matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n  the IngressClass. Implementations can treat this as a separate PathType\n  or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.",
 	"backend":  "Backend defines the referenced service endpoint to which the traffic will be forwarded to.",
 }

staging/src/k8s.io/api/networking/v1beta1/generated.proto

@@ -35,8 +35,8 @@ option go_package = "v1beta1";
 message HTTPIngressPath {
   // Path is matched against the path of an incoming request. Currently it can
   // contain characters disallowed from the conventional "path" part of a URL
-  // as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
+  // as defined by RFC 3986. Paths must begin with a '/' and must be present
-  // all paths from incoming requests are matched.
+  // when using PathType with value "Exact" or "Prefix".
   // +optional
   optional string path = 1;
 

staging/src/k8s.io/api/networking/v1beta1/types.go

@@ -228,8 +228,8 @@ const (
 type HTTPIngressPath struct {
 	// Path is matched against the path of an incoming request. Currently it can
 	// contain characters disallowed from the conventional "path" part of a URL
-	// as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
+	// as defined by RFC 3986. Paths must begin with a '/' and must be present
-	// all paths from incoming requests are matched.
+	// when using PathType with value "Exact" or "Prefix".
 	// +optional
 	Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"`
 

staging/src/k8s.io/api/networking/v1beta1/types_swagger_doc_generated.go

@@ -29,7 +29,7 @@ package v1beta1
 // AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT.
 var map_HTTPIngressPath = map[string]string{
 	"":         "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.",
-	"path":     "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.",
+	"path":     "Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value \"Exact\" or \"Prefix\".",
 	"pathType": "PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is\n  done on a path element by element basis. A path element refers is the\n  list of labels in the path split by the '/' separator. A request is a\n  match for path p if every p is an element-wise prefix of p of the\n  request path. Note that if the last element of the path is a substring\n  of the last element in request path, it is not a match (e.g. /foo/bar\n  matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n  the IngressClass. Implementations can treat this as a separate PathType\n  or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types. Defaults to ImplementationSpecific.",
 	"backend":  "Backend defines the referenced service endpoint to which the traffic will be forwarded to.",
 }