Skip to content

fix: add OpenAPIModelName for PackageManifest to fix oc explain #3755

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.

Sign up for GitHub

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

Merged
openshift-merge-bot merged 1 commit into from
Feb 4, 2026
+152 −120
Merged

fix: add OpenAPIModelName for PackageManifest to fix oc explain #3755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions pkg/package-server/apis/operators/v1/model_name.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
Copyright Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1

// OpenAPIModelName returns the OpenAPI model name for this type.
// This is used by openapi-gen to register the GVK extension.
// The format matches what k8s.io/apimachinery/pkg/runtime.Scheme.ToOpenAPIDefinitionName would generate.
func (PackageManifest) OpenAPIModelName() string {
return "com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators.v1.PackageManifest"
}

// OpenAPIModelName returns the OpenAPI model name for this type.
// This is used by openapi-gen to register the GVK extension.
// The format matches what k8s.io/apimachinery/pkg/runtime.Scheme.ToOpenAPIDefinitionName would generate.
func (PackageManifestList) OpenAPIModelName() string {
Copy link
Contributor

@tmshort tmshort Feb 2, 2026

Choose a reason for hiding this comment

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

Is there a reason this is only done for these two resources? I see k8s now has functions as well, with similar returns, but many of our types are still using the domain/path model, rather than the reverse.domain.path model

Copy link
Member Author

@jianzhangbjz jianzhangbjz Feb 3, 2026

Choose a reason for hiding this comment

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

Good question! The reason this is only done for PackageManifest and PackageManifestList is that these are the only resources served by the package-server aggregated API, rather than being actual CRDs. All other OLM types (Subscription, ClusterServiceVersion, CatalogSource, etc.) are true CRDs under operators.coreos.com. For CRDs, Kubernetes automatically handles the OpenAPI schema generation and adds the x-kubernetes-group-version-kind extension through its CRD controller.

jiazha-mac:~ jiazha$ oc get apiservice |grep package
v1.packages.operators.coreos.com              openshift-operator-lifecycle-manager/packageserver-service   True        65m
jiazha-mac:~ jiazha$ oc get crd |grep operators.coreos.com
catalogsources.operators.coreos.com                               2026-02-03T02:47:35Z
clusterserviceversions.operators.coreos.com                       2026-02-03T02:47:37Z
installplans.operators.coreos.com                                 2026-02-03T02:47:39Z
olmconfigs.operators.coreos.com                                   2026-02-03T02:47:43Z
operatorconditions.operators.coreos.com                           2026-02-03T02:47:45Z
operatorgroups.operators.coreos.com                               2026-02-03T02:47:46Z
operators.operators.coreos.com                                    2026-02-03T02:47:47Z
subscriptions.operators.coreos.com                                2026-02-03T02:47:57Z

Regarding the reverse.domain.path format (com.github.operator-framework...) - this matches what k8s.io/apimachinery/pkg/runtime.Scheme.ToOpenAPIDefinitionName() generates, which is required for the name lookup to succeed. The other OLM types don't need this because the CRD mechanism handles it automatically.

Why did the test start failing now?

After upgrading to kube-openapi v0.0.0-20250910181357 in PR #3707, the mix of types with and without OpenAPIModelName() caused the model name lookup to fail for PackageManifest, preventing the GVK extension from being added to its OpenAPI schema.

return "com.github.operator-framework.operator-lifecycle-manager.pkg.package-server.apis.operators.v1.PackageManifestList"
}
Loading