Skip to content

Conversation

@josh-pritchard
Copy link
Contributor

@josh-pritchard josh-pritchard commented Jan 9, 2026

Description

Change field names in TrafficPolicy to be more consistent before release #13254

Change Type

/kind breaking_change

Changelog

[Internal break only] `jwt` renamed to `jwtAuth`, `apiKeyAuthentication` renamed to `apiKeyAuth`

Additional Notes

resolves #13069

Signed-off-by: Joshua Pritchard <[email protected]>
Copilot AI review requested due to automatic review settings January 9, 2026 19:23
@josh-pritchard josh-pritchard requested a review from a team as a code owner January 9, 2026 19:23
@gateway-bot gateway-bot added do-not-merge/description-invalid kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none and removed do-not-merge/description-invalid labels Jan 9, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR renames fields in the TrafficPolicy API for improved consistency before the release. The changes rename jwt to jwtAuth and apiKeyAuthentication to apiKeyAuth in the TrafficPolicySpec, along with corresponding type renames from JWTAuthentication to JWTAuth and APIKeyAuthentication to APIKeyAuth.

Key changes:

  • Updated API type definitions and generated deepcopy code for renamed types
  • Modified CRD templates to reflect new field names
  • Updated plugin implementations to use renamed fields
  • Updated test data files and translator test inputs within the PR scope

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.

Show a summary per file
File Description
api/v1alpha1/kgateway/traffic_policy_types.go Updated field names from JWT to JWTAuth and APIKeyAuthentication to APIKeyAuth
api/v1alpha1/kgateway/jwt_types.go Renamed type from JWTAuthentication to JWTAuth
api/v1alpha1/kgateway/zz_generated.deepcopy.go Updated generated deepcopy methods for renamed types
pkg/kgateway/extensions2/plugins/trafficpolicy/jwt.go Updated field access from in.Spec.JWT to in.Spec.JWTAuth
pkg/kgateway/extensions2/plugins/trafficpolicy/api_key_auth.go Updated field access from spec.APIKeyAuthentication to spec.APIKeyAuth
install/helm/kgateway-crds/templates/gateway.kgateway.dev_trafficpolicies.yaml Updated CRD schema with new field names and descriptions
test/e2e/features/jwt/testdata/jwt.yaml Updated TrafficPolicy spec from jwt: to jwtAuth:
test/e2e/features/jwt/testdata/jwt-rbac.yaml Updated TrafficPolicy spec from jwt: to jwtAuth:
test/e2e/features/apikeyauth/testdata/*.yaml Updated all API key auth test files from apiKeyAuthentication: to apiKeyAuth:
pkg/kgateway/translator/gateway/testutils/inputs/traffic-policy/*.yaml Updated all traffic policy test input files with new field names
pkg/kgateway/translator/gateway/testutils/inputs/jwt/*.yaml Updated JWT test input files with new field names

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@gateway-bot gateway-bot added kind/breaking_change release-note and removed kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none labels Jan 9, 2026
@davidjumani davidjumani enabled auto-merge January 9, 2026 19:41
Signed-off-by: Joshua Pritchard <[email protected]>
auto-merge was automatically disabled January 9, 2026 19:54

Head branch was pushed to by a user without write access

Signed-off-by: Joshua Pritchard <[email protected]>
@josh-pritchard
Copy link
Contributor Author

/merge

@gateway-bot gateway-bot enabled auto-merge January 9, 2026 20:22
@gateway-bot gateway-bot added this pull request to the merge queue Jan 9, 2026
Merged via the queue into kgateway-dev:main with commit 38addc8 Jan 9, 2026
33 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

finalize auth policy API naming

6 participants