Skip to content

Commit

Permalink
docs: add docstrings to ImageMetadata
Browse files Browse the repository at this point in the history
Signed-off-by: Fabrizio Sestito <[email protected]>
  • Loading branch information
fabriziosestito committed Nov 12, 2024
1 parent b97cccb commit 0404e4f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions api/storage/v1alpha1/image_metadata.go
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down

0 comments on commit 0404e4f

Please sign in to comment.