Skip to content

Commit

Permalink
add apireference:kic:include for KongLicense and KongCustomEntity (#151)
Browse files Browse the repository at this point in the history
  • Loading branch information
randmonkey authored Nov 7, 2024
1 parent 3f8c399 commit 05d5f58
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
5 changes: 3 additions & 2 deletions api/configuration/v1alpha1/kong_custom_entity_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ const (
// KongEntityScope defines the scope of the Kong entity.
type KongEntityScope string

// KongCustomEntity defines a "custom" Kong entity that KIC cannot support the entity type directly.
//
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:object:root=true
Expand All @@ -24,8 +26,7 @@ type KongEntityScope string
// +kubebuilder:printcolumn:name="Programmed",type=string,JSONPath=`.status.conditions[?(@.type=="Programmed")].status`
// +kubebuilder:validation:XValidation:rule="self.spec.type == oldSelf.spec.type",message="The spec.type field is immutable"
// +kubebuilder:validation:XValidation:rule="!(self.spec.type in ['services','routes','upstreams','targets','plugins','consumers','consumer_groups'])",message="The spec.type field cannot be known Kong entity types"

// KongCustomEntity defines a "custom" Kong entity that KIC cannot support the entity type directly.
// +apireference:kic:include
type KongCustomEntity struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down
1 change: 1 addition & 0 deletions api/configuration/v1alpha1/kong_license_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,description="Age"
// +kubebuilder:printcolumn:name="Enabled",type=boolean,JSONPath=`.enabled`,description="Enabled to configure on Kong gateway instances"
// +apireference:kic:include
// +apireference:kgo:include
type KongLicense struct {
metav1.TypeMeta `json:",inline"`
Expand Down

0 comments on commit 05d5f58

Please sign in to comment.