From 81910f5111b4b58751c90590fdf3dafc6e260d26 Mon Sep 17 00:00:00 2001
From: cnwaldron <72021941+cnwaldron@users.noreply.github.com>
Date: Wed, 15 Nov 2023 13:12:50 -0500
Subject: [PATCH] fix up yaml comments

---
 .../aquasecurity.github.io_exposedsecretreports.yaml     | 1 +
 .../aquasecurity.github.io_vulnerabilityreports.yaml     | 1 +
 pkg/apis/aquasecurity/v1alpha1/vulnerability_types.go    | 9 ++++-----
 3 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/deploy/helm/crds/aquasecurity.github.io_exposedsecretreports.yaml b/deploy/helm/crds/aquasecurity.github.io_exposedsecretreports.yaml
index 6b42e3973..1b77be429 100644
--- a/deploy/helm/crds/aquasecurity.github.io_exposedsecretreports.yaml
+++ b/deploy/helm/crds/aquasecurity.github.io_exposedsecretreports.yaml
@@ -206,6 +206,7 @@ spec:
                 type: string
             required:
             - artifact
+            - os
             - scanner
             - secrets
             - summary
diff --git a/deploy/helm/crds/aquasecurity.github.io_vulnerabilityreports.yaml b/deploy/helm/crds/aquasecurity.github.io_vulnerabilityreports.yaml
index 78b6f940a..fd5b3f658 100644
--- a/deploy/helm/crds/aquasecurity.github.io_vulnerabilityreports.yaml
+++ b/deploy/helm/crds/aquasecurity.github.io_vulnerabilityreports.yaml
@@ -269,6 +269,7 @@ spec:
                 type: array
             required:
             - artifact
+            - os
             - scanner
             - summary
             - updateTimestamp
diff --git a/pkg/apis/aquasecurity/v1alpha1/vulnerability_types.go b/pkg/apis/aquasecurity/v1alpha1/vulnerability_types.go
index a68a46a78..64b6fae7a 100644
--- a/pkg/apis/aquasecurity/v1alpha1/vulnerability_types.go
+++ b/pkg/apis/aquasecurity/v1alpha1/vulnerability_types.go
@@ -61,18 +61,17 @@ type Artifact struct {
 	MimeType string `json:"mimeType,omitempty"`
 }
 
-// OS represents a standalone, executable package of software that
-// includes everything needed to run an application.
+// OS is the Operating System of the Artifact
 type OS struct {
-	// Repository is the name of the repository in the Artifact registry.
+	// Family is the Operating System Family
 	// +optional
 	Family ostype.OSType `json:"family"`
 
-	// Digest is a unique and immutable identifier of an Artifact.
+	// Name is the generally the version of the OS
 	// +optional
 	Name string `json:"name,omitempty"`
 
-	// Tag is a mutable, human-readable string used to identify an Artifact.
+	// Eosl is the End of Service Life and is true if the OS version being used has reached it's end of service life
 	// +optional
 	Eosl bool `json:"eosl,omitempty"`
 }