search

kubernetes-sigs / gateway-api

Repository for the next iteration of composite service (e.g. Ingress) and load balancing APIs.
https://gateway-api.sigs.k8s.io
Apache License 2.0
1.85k stars 480 forks source link

Published docs out of sync with comments in API definition #3401

Open craigbox opened 3 weeks ago

craigbox commented 3 weeks ago

https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParentReference states

ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with “Core” support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute.

which has not been updated for the fact that in v1, Service is a supported parent also. This is correctly set in https://github.com/kubernetes-sigs/gateway-api/blob/main/apis/v1/shared_types.go#L23-L25, so perhaps the docs just need to be rebuilt?

kundan2707 commented 3 weeks ago

/assign