Skip to content

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

Closed
@craigbox

Description

@craigbox

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/documentationCategorizes issue or PR as related to documentation.triage/needs-informationIndicates an issue needs more information in order to work on it.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions