update the api comment

Signed-off-by: Zhiying Lin <[email protected]>

Author: zhiying-lin

apis/placement/v1/resourcesnapshot_types.go

@@ -53,7 +53,7 @@ import (
 //   - `SubindexOfResourceSnapshotAnnotation` to store the subindex of resource snapshot in the group.
 //
 // Snapshot may have the following annotations to indicate the time of next resourceSnapshot candidate detected by the controller:
-//   - `NextResourceSnapshotCandidateDetectionTime` to store the time of next resourceSnapshot candidate detected by the controller.
+//   - `NextResourceSnapshotCandidateDetectionTimeAnnotation` to store the time of next resourceSnapshot candidate detected by the controller.
 type ClusterResourceSnapshot struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

apis/placement/v1beta1/resourcesnapshot_types.go

@@ -122,6 +122,9 @@ type ResourceSnapshotObjList interface {
 //
 // Each snapshot (excluding the first snapshot) MUST have the following annotations:
 //   - `SubindexOfResourceSnapshotAnnotation` to store the subindex of resource snapshot in the group.
+//
+// Snapshot may have the following annotations to indicate the time of next resourceSnapshot candidate detected by the controller:
+//   - `NextResourceSnapshotCandidateDetectionTimeAnnotation` to store the time of next resourceSnapshot candidate detected by the controller.
 type ClusterResourceSnapshot struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`