feat: add x-kubernetes-group-version-kind to the schema (#129)

Author: Skarlso

cmd/file_handler.go

@@ -39,5 +39,9 @@ func (h *FileHandler) CRDs() ([]*pkg.SchemaType, error) {
 		return nil, fmt.Errorf("failed to extract schema type: %w", err)
 	}
 
+	if schemaType == nil {
+		return nil, nil
+	}
+
 	return []*pkg.SchemaType{schemaType}, nil
 }

cmd/folder_handler.go

@@ -60,7 +60,9 @@ func (h *FolderHandler) CRDs() ([]*pkg.SchemaType, error) {
 			return fmt.Errorf("failed to extract schema type: %w", err)
 		}
 
-		crds = append(crds, schemaType)
+		if schemaType != nil {
+			crds = append(crds, schemaType)
+		}
 
 		return nil
 	}); err != nil {

cmd/schema.go

@@ -7,6 +7,8 @@ import (
 
 	"github.com/spf13/cobra"
 	"k8s.io/apimachinery/pkg/util/json"
+
+	"github.com/Skarlso/crd-to-sample-yaml/v1beta1"
 )
 
 // schemaCmd is a command that can generate json schemas.
@@ -22,6 +24,17 @@ type schemaCmdArgs struct {
 
 var schemaArgs = &schemaCmdArgs{}
 
+type KindVersionGroup struct {
+	Kind    string `json:"kind"`
+	Version string `json:"version"`
+	Group   string `json:"group"`
+}
+
+type Schema struct {
+	*v1beta1.JSONSchemaProps       `json:",inline"`
+	KubernetesGroupVersionKindList []KindVersionGroup `json:"x-kubernetes-group-version-kind"`
+}
+
 func init() {
 	generateCmd.AddCommand(schemaCmd)
 	f := schemaCmd.PersistentFlags()
@@ -57,7 +70,19 @@ func runGenerateSchema(_ *cobra.Command, _ []string) error {
 			if v.Schema.Schema == "" {
 				v.Schema.Schema = "https://json-schema.org/draft/2020-12/schema"
 			}
-			content, err := json.Marshal(v.Schema)
+
+			schema := Schema{
+				JSONSchemaProps: v.Schema,
+				KubernetesGroupVersionKindList: []KindVersionGroup{
+					{
+						Kind:    crd.Kind,
+						Group:   crd.Group,
+						Version: v.Name,
+					},
+				},
+			}
+
+			content, err := json.Marshal(schema)
 			if err != nil {
 				return fmt.Errorf("failed to marshal schema: %w", err)
 			}

cmd/url_handler.go

@@ -46,5 +46,9 @@ func (h *URLHandler) CRDs() ([]*pkg.SchemaType, error) {
 		return nil, fmt.Errorf("failed to extract schema type: %w", err)
 	}
 
+	if schemaType == nil {
+		return nil, nil
+	}
+
 	return []*pkg.SchemaType{schemaType}, nil
 }

pkg/extract_schematype.go

@@ -34,6 +34,14 @@ func ExtractSchemaType(obj *unstructured.Unstructured) (*SchemaType, error) {
 
 	versions, ok := specMap["versions"]
 	if !ok {
+		if _, ok := specMap["validation"]; !ok {
+			// we aren't dealing with a valid resource
+			// we might want to skip it if we are going through a
+			// list of YAML files in a folder, and we want to skip
+			// invalid ones.
+			return nil, nil
+		}
+
 		return extractValidation(obj, specMap)
 	}