Skip to content

Incorrect KubernetesContainerSpec reference in docs #1718

@sqaisar

Description

@sqaisar

Description

The generated documentation links to an incorrect API spec for KubernetesContainerSpec.

This type is referenced in GatewayConfig, and the generated docs link it to the wrong API reference.

Currently, the docs point to the Envoy AI Gateway API reference:
https://aigateway.envoyproxy.io/docs/api/#kubernetescontainerspec
it's being created by this https://github.com/envoyproxy/ai-gateway/blob/main/api/v1alpha1/gateway_config.go#L67

However, this type originates from Envoy Gateway extension types, and the correct reference should be:
https://gateway.envoyproxy.io/docs/api/extension_types/#kubernetescontainerspec

The documentation should link to the Envoy Gateway extension API instead of the Envoy AI Gateway API.

Repro steps

  1. Open the generated documentation.
  2. Navigate to GatewayConfig.
  3. Locate the KubernetesContainerSpec reference.
  4. Click the API spec link.
  5. Observe that it redirects to the Envoy AI Gateway docs instead of Envoy Gateway extension types.

Environment

  • Gateway: Envoy AI Gateway
  • Docs source: Auto-generated API documentation
  • Envoy Gateway version: N/A (documentation/linking issue)

Logs

N/A (documentation issue, no runtime logs involved)

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions