fix(crd): missing shortname and printcolumn#2435
Merged
AlinsRan merged 1 commit intoapache:masterfrom Jun 27, 2025
Merged
Conversation
Signed-off-by: ashing <axingfly@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR addresses missing shortName and printColumn definitions for various Apisix CRD resources.
- Adds shortNames for ApisixUpstreams, ApisixRoutes, ApisixPluginConfigs, ApisixGlobalRules, and ApisixConsumers in CRD YAML files.
- Introduces additional printer columns for ApisixTls and ApisixRoute CRDs.
- Updates corresponding kubebuilder annotations in the Go type definitions.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| config/crd/bases/apisix.apache.org_apisixupstreams.yaml | Adds shortNames for ApisixUpstream (au). |
| config/crd/bases/apisix.apache.org_apisixtlses.yaml | Adds additional printer columns for ApisixTls but omits a shortNames field. |
| config/crd/bases/apisix.apache.org_apisixroutes.yaml | Adds shortNames (ar) and additional printer columns for ApisixRoute. |
| config/crd/bases/apisix.apache.org_apisixpluginconfigs.yaml | Adds shortNames (apc) for ApisixPluginConfig. |
| config/crd/bases/apisix.apache.org_apisixglobalrules.yaml | Adds shortNames (agr) for ApisixGlobalRule. |
| config/crd/bases/apisix.apache.org_apisixconsumers.yaml | Adds shortNames (ac) for ApisixConsumer. |
| api/v2/apisixupstream_types.go | Introduces shortName via a kubebuilder resource annotation for ApisixUpstream. |
| api/v2/apisixtls_types.go | Updates kubebuilder annotations to include printColumns for ApisixTls. |
| api/v2/apisixroute_types.go | Updates kubebuilder annotations to include shortName and printColumns for ApisixRoute. |
| api/v2/apisixpluginconfig_types.go | Introduces shortName via a kubebuilder resource annotation for ApisixPluginConfig. |
| api/v2/apisixglobalrule_types.go | Introduces shortName via a kubebuilder resource annotation for ApisixGlobalRule. |
| api/v2/apisixconsumer_types.go | Introduces shortName via a kubebuilder resource annotation for ApisixConsumer. |
Comments suppressed due to low confidence (1)
config/crd/bases/apisix.apache.org_apisixtlses.yaml:16
- The ApisixTls CRD in this file includes additionalPrinterColumns but does not define a shortNames field, which is inconsistent with other CRD definitions and the kubebuilder annotation in apisixtls_types.go. Consider adding a shortNames field (e.g., 'shortNames:\n- atls') for consistency.
singular: apisixtls
AlinsRan
approved these changes
Jun 27, 2025
nic-6443
approved these changes
Jun 27, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type of change:
What this PR does / why we need it:
Pre-submission checklist: