From 0404e4fed0da6f9f78499de7de89bc01e44678eb Mon Sep 17 00:00:00 2001 From: Fabrizio Sestito Date: Tue, 12 Nov 2024 08:15:16 +0100 Subject: [PATCH] docs: add docstrings to ImageMetadata Signed-off-by: Fabrizio Sestito --- api/storage/v1alpha1/image_metadata.go | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/api/storage/v1alpha1/image_metadata.go b/api/storage/v1alpha1/image_metadata.go index 41147c1..1b191d9 100644 --- a/api/storage/v1alpha1/image_metadata.go +++ b/api/storage/v1alpha1/image_metadata.go @@ -1,11 +1,17 @@ package v1alpha1 +// ImageMetadata contains the metadata details of an image. type ImageMetadata struct { - Registry string `json:"registry"` + // Registry specifies the name of the Registry object in the same namespace where the image is stored. + Registry string `json:"registry"` + // Repository specifies the repository path of the image. Example: "rancher/sbombastic". Repository string `json:"repository"` - Tag string `json:"tag"` - Platform string `json:"platform"` - Digest string `json:"digest"` + // Tag specifies the tag of the image. Example: "latest". + Tag string `json:"tag"` + // Platform specifies the platform of the image. Example "linux/amd64". + Platform string `json:"platform"` + // Digest specifies the sha256 digest of the image. + Digest string `json:"digest"` } type ImageMetadataAccessor interface {