Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
craigbox opened this issue Oct 21, 2024 · 6 comments
Open

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

craigbox opened this issue Oct 21, 2024 · 6 comments
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@craigbox
Copy link
Contributor

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?

@craigbox craigbox added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 21, 2024
@kundan2707
Copy link
Contributor

/assign

@amitmaurya07
Copy link

Hello @kundan2707, if you are not working on this issue.
Can I take this issue @craigbox ?

@youngnick
Copy link
Contributor

/assign @amitmaurya07

Please feel free.

@amitmaurya07
Copy link

Thanks @youngnick
I'll start working on it.

@kundan2707
Copy link
Contributor

/unassign

@craigbox
Copy link
Contributor Author

@amitmaurya07 how are you going with this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

4 participants