Address code review feedback: simplify annotations and add TODOs

- Simplify shortName for TemporalConnection to just "tconn"
- Remove print column annotations and replace with TODO comments linking to k8s conventions
- Add TODO comments for unit test cases on reference types

Per code review feedback on PR #136.

Author: jlegrone

api/v1alpha1/temporalconnection_types.go

@@ -11,6 +11,7 @@ import (
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
 // SecretReference contains the name of a Secret resource in the same namespace.
+// TODO(jlegrone): Add table-driven unit test cases for this
 type SecretReference struct {
 	// Name of the Secret resource.
 	// +kubebuilder:validation:Required
@@ -51,10 +52,9 @@ type TemporalConnectionStatus struct {
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
-// +kubebuilder:resource:shortName=tc;tconn;temporalconn
-//+kubebuilder:printcolumn:name="Host",type="string",JSONPath=".spec.hostPort",description="Temporal server host and port"
-//+kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status",description="Connection readiness status"
-//+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
+// +kubebuilder:resource:shortName=tconn
+// TODO(jlegrone): Add print column annotations following Kubernetes conventions
+// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata
 
 // TemporalConnection is the Schema for the temporalconnections API
 type TemporalConnection struct {

api/v1alpha1/worker_types.go

@@ -13,6 +13,7 @@ import (
 
 // TemporalConnectionReference contains the name of a TemporalConnection resource
 // in the same namespace as the TemporalWorkerDeployment.
+// TODO(jlegrone): Add table-driven unit test cases for this
 type TemporalConnectionReference struct {
 	// Name of the TemporalConnection resource.
 	// +kubebuilder:validation:Required
@@ -336,10 +337,8 @@ type ManualRolloutStrategy struct{}
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 // +kubebuilder:resource:shortName=twd;twdeployment;tworkerdeployment
-//+kubebuilder:printcolumn:name="Current",type="string",JSONPath=".status.currentVersion.buildID",description="Current Version Build ID"
-//+kubebuilder:printcolumn:name="Target",type="string",JSONPath=".status.targetVersion.buildID",description="Build ID of the target worker (based on the pod template)"
-//+kubebuilder:printcolumn:name="Target-Ramp",type="number",JSONPath=".status.targetVersion.rampPercentageBasisPoints",description="Basis points of new workflows starting on Target Version (100 basis points = 1%)"
-//+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
+// TODO(jlegrone): Add print column annotations following Kubernetes conventions
+// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata
 
 // TemporalWorkerDeployment is the Schema for the temporalworkerdeployments API
 type TemporalWorkerDeployment struct {