feat: enhance GuestbookEntry with required and optional markers

Author: thbkrkr

test/api/v1/guestbook_types.go

@@ -124,6 +124,7 @@ type PositiveInt int
 // GuestbookEntry defines an entry in a guest book.
 type GuestbookEntry struct {
 	// Name of the guest (pipe | should be escaped)
+	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:MaxLength=80
 	// +kubebuilder:validation:Pattern=`0*[a-z0-9]*[a-z]*[0-9]`
 	Name string `json:"name,omitempty"`
@@ -146,12 +147,19 @@ type GuestbookEntry struct {
 	Comment string `json:"comment,omitempty"`
 	// Rating provided by the guest
 	Rating Rating `json:"rating,omitempty"`
+
 	// Email is the email address of the guest (required field using +required marker)
 	// +required
 	Email string `json:"email"`
-	// Location is the location of the guest (required field using +kubebuilder:validation:Required marker)
-	// +kubebuilder:validation:Required
+	// Location is the location of the guest (required field using +k8s:required marker)
+	// +k8s:required
 	Location string `json:"location"`
+	// Phone is the phone number of the guest (optional field using +optional marker)
+	// +optional
+	Phone string `json:"phone"`
+	// Company is the company of the guest (optional field using +k8s:optional marker)
+	// +k8s:optional
+	Company string `json:"company"`
 }
 
 // GuestbookStatus defines the observed state of Guestbook.

test/expected.asciidoc

@@ -162,6 +162,7 @@ GuestbookEntry defines an entry in a guest book.
 | Field | Description | Default | Validation
 | *`name`* __string__ | Name of the guest (pipe \| should be escaped) + |  | MaxLength: 80 +
 Pattern: `0\*[a-z0-9]*[a-z]*[0-9]` +
+Required: \{} +
 
 | *`tags`* __string array__ | Tags of the entry. + |  | items:Pattern: `[a-z]*` +
 
@@ -181,7 +182,11 @@ Minimum: 1 +
 
 | *`email`* __string__ | Email is the email address of the guest (required field using +required marker) + |  | Required: \{} +
 
-| *`location`* __string__ | Location is the location of the guest (required field using +kubebuilder:validation:Required marker) + |  | Required: \{} +
+| *`location`* __string__ | Location is the location of the guest (required field using +k8s:required marker) + |  | Required: \{} +
+
+| *`phone`* __string__ | Phone is the phone number of the guest (optional field using +optional marker) + |  | Optional: \{} +
+
+| *`company`* __string__ | Company is the company of the guest (optional field using +k8s:optional marker) + |  | Optional: \{} +
 
 |===
 

test/expected.md

@@ -127,13 +127,15 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `name` _string_ | Name of the guest (pipe \| should be escaped) |  | MaxLength: 80 <br />Pattern: `0*[a-z0-9]*[a-z]*[0-9]` <br /> |
+| `name` _string_ | Name of the guest (pipe \| should be escaped) |  | MaxLength: 80 <br />Pattern: `0*[a-z0-9]*[a-z]*[0-9]` <br />Required: \{\} <br /> |
 | `tags` _string array_ | Tags of the entry. |  | items:Pattern: `[a-z]*` <br /> |
 | `time` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)_ | Time of entry |  |  |
 | `comment` _string_ | Comment by guest. This can be a multi-line comment.<br />Like this one.<br />Now let's test a list:<br />* a<br />* b<br />Another isolated comment.<br />Looks good? |  | Pattern: `0*[a-z0-9]*[a-z]*[0-9]*\|\s` <br /> |
 | `rating` _[Rating](#rating)_ | Rating provided by the guest |  | Maximum: 5 <br />Minimum: 1 <br /> |
 | `email` _string_ | Email is the email address of the guest (required field using +required marker) |  | Required: \{\} <br /> |
-| `location` _string_ | Location is the location of the guest (required field using +kubebuilder:validation:Required marker) |  | Required: \{\} <br /> |
+| `location` _string_ | Location is the location of the guest (required field using +k8s:required marker) |  | Required: \{\} <br /> |
+| `phone` _string_ | Phone is the phone number of the guest (optional field using +optional marker) |  | Optional: \{\} <br /> |
+| `company` _string_ | Company is the company of the guest (optional field using +k8s:optional marker) |  | Optional: \{\} <br /> |
 
 
 #### GuestbookHeader

test/hide.md

@@ -128,11 +128,15 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `name` _string_ | Name of the guest (pipe \| should be escaped) |  | MaxLength: 80 <br />Pattern: `0*[a-z0-9]*[a-z]*[0-9]` <br /> |
+| `name` _string_ | Name of the guest (pipe \| should be escaped) |  | MaxLength: 80 <br />Pattern: `0*[a-z0-9]*[a-z]*[0-9]` <br />Required: \{\} <br /> |
 | `tags` _string array_ | Tags of the entry. |  | items:Pattern: `[a-z]*` <br /> |
 | `time` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#time-v1-meta)_ | Time of entry |  |  |
 | `comment` _string_ | Comment by guest. This can be a multi-line comment.<br />Like this one.<br />Now let's test a list:<br />* a<br />* b<br />Another isolated comment.<br />Looks good? |  | Pattern: `0*[a-z0-9]*[a-z]*[0-9]*\|\s` <br /> |
 | `rating` _[Rating](#rating)_ | Rating provided by the guest |  | Maximum: 5 <br />Minimum: 1 <br /> |
+| `email` _string_ | Email is the email address of the guest (required field using +required marker) |  | Required: \{\} <br /> |
+| `location` _string_ | Location is the location of the guest (required field using +k8s:required marker) |  | Required: \{\} <br /> |
+| `phone` _string_ | Phone is the phone number of the guest (optional field using +optional marker) |  | Optional: \{\} <br /> |
+| `company` _string_ | Company is the company of the guest (optional field using +k8s:optional marker) |  | Optional: \{\} <br /> |
 
 
 #### GuestbookHeader