Skip to content

Commit 3dd71b2

Browse files
committed
Clarify API comments
Apply Jan's suggestions. Signed-off-by: Leonardo Cecchi <[email protected]>
1 parent 1c9ffa5 commit 3dd71b2

File tree

2 files changed

+10
-10
lines changed
  • client/apis/volumegroupsnapshot/v1beta2
  • vendor/github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumegroupsnapshot/v1beta2

2 files changed

+10
-10
lines changed

client/apis/volumegroupsnapshot/v1beta2/types.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -315,12 +315,11 @@ type VolumeGroupSnapshotContentSpec struct {
315315
// The VolumeSnapshotInfo struct is added in v1beta2
316316
// VolumeSnapshotInfo contains information for a snapshot
317317
type VolumeSnapshotInfo struct {
318-
// VolumeHandle is a unique id returned by the CSI driver to identify a volume
319-
// on the storage system
318+
// VolumeHandle specifies the CSI "volume_id" of the volume from which this snapshot
319+
// was taken from.
320320
VolumeHandle string `json:"volumeHandle,omitempty" protobuf:"bytes,1,opt,name=volumeHandle"`
321321

322-
// SnapshotHandle is a unique id returned by the CSI driver to identify a volume
323-
// snapshot on the storage system
322+
// SnapshotHandle is the CSI "snapshot_id" of this snapshot on the underlying storage system.
324323
SnapshotHandle string `json:"snapshotHandle,omitempty" protobuf:"bytes,2,opt,name=snapshotHandle"`
325324

326325
// creationTime is the timestamp when the point-in-time snapshot is taken
@@ -332,7 +331,8 @@ type VolumeSnapshotInfo struct {
332331
// +optional
333332
ReadyToUse *bool `json:"readyToUse,omitempty" protobuf:"varint,4,opt,name=readyToUse"`
334333

335-
// RestoreSize represents the complete size of the snapshot in bytes.
334+
// RestoreSize represents the minimum size of volume required to create a volume
335+
// from this snapshot.
336336
// +optional
337337
RestoreSize *int64 `json:"restoreSize,omitempty" protobuf:"bytes,5,opt,name=restoreSize"`
338338
}

vendor/github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumegroupsnapshot/v1beta2/types.go

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)