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

Closed
craigbox opened this issue Oct 21, 2024 · 10 comments
Closed

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

craigbox opened this issue Oct 21, 2024 · 10 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. triage/needs-information Indicates an issue needs more information in order to work on it.

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?

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 12, 2025
@shaneutt shaneutt added triage/needs-information Indicates an issue needs more information in order to work on it. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 12, 2025
@shaneutt shaneutt moved this to Triage in Gateway API Pipeline Mar 12, 2025
@craigbox
Copy link
Contributor Author

FWIW #3400 made a change to shared_types.go recently and that change is reflected in the docs.

@youngnick
Copy link
Contributor

Yes, checking the current docs, they correctly reflect that Service is also a supported parent. https://gateway-api.sigs.k8s.io/reference/spec/#parentreference

I think we can close this one. @craigbox please comment if you don't agree and I'll reopen.

/close

@k8s-ci-robot
Copy link
Contributor

@youngnick: Closing this issue.

In response to this:

Yes, checking the current docs, they correctly reflect that Service is also a supported parent. https://gateway-api.sigs.k8s.io/reference/spec/#parentreference

I think we can close this one. @craigbox please comment if you don't agree and I'll reopen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@github-project-automation github-project-automation bot moved this from Triage to Done in Gateway API Pipeline Mar 25, 2025
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. triage/needs-information Indicates an issue needs more information in order to work on it.
Projects
Development

No branches or pull requests

7 participants