Update comments used by generated docs

This change updates the comments for the HCP Packer data sources to
match the recently corrected documentation text.
pull/11929/head
Wilken Rivera 4 years ago committed by Wilken Rivera
parent 70b3d0b2b9
commit 23cd26617b

@ -109,11 +109,11 @@ type DatasourceOutput struct {
ComponentType string `mapstructure:"component_type"`
// The date and time at which the image was created.
CreatedAt string `mapstructure:"created_at"`
// The id of the build that created the image. This is a ULID, which is a
// The ID of the build that created the image. This is a ULID, which is a
// unique identifier similar to a UUID. It is created by the HCP Packer
// Registry when an build is first created, and is unique to this build.
BuildID string `mapstructure:"build_id"`
// The iteration id. This is a ULID, which is a unique identifier similar
// The iteration ID. This is a ULID, which is a unique identifier similar
// to a UUID. It is created by the HCP Packer Registry when an iteration is
// first created, and is unique to this iteration.
IterationID string `mapstructure:"iteration_id"`

@ -76,7 +76,7 @@ type DatasourceOutput struct {
// The fingerprint of the build; this could be a git sha or other unique
// identifier as set by the Packer build that created this iteration.
Fingerprint string `mapstructure:"fingerprint"`
// The iteration id. This is a ULID, which is a unique identifier similar
// The iteration ID. This is a ULID, which is a unique identifier similar
// to a UUID. It is created by the HCP Packer Registry when an iteration is
// first created, and is unique to this iteration.
ID string `mapstructure:"id"`

@ -71,14 +71,14 @@ type ParBuild struct {
ComponentType string `mapstructure:"component_type"`
// The date and time at which the build was run.
CreatedAt string `mapstructure:"created_at"`
// The build id. This is a ULID, which is a unique identifier similar
// The build ID. This is a ULID, which is a unique identifier similar
// to a UUID. It is created by the HCP Packer Registry when an build is
// first created, and is unique to this build.
ID string `mapstructure:"id"`
// A list of images as stored in the HCP Packer registry. See the ParImage
// docs for more information.
Images []ParImage `mapstructure:"images"`
// The iteration id. This is a ULID, which is a unique identifier similar
// The iteration ID. This is a ULID, which is a unique identifier similar
// to a UUID. It is created by the HCP Packer Registry when an iteration is
// first created, and is unique to this iteration.
IterationID string `mapstructure:"iteration_id"`
@ -99,7 +99,7 @@ type ParBuild struct {
type ParImage struct {
// The date and time at which the build was last updated.
CreatedAt string `mapstructure:"created_at,omitempty"`
// The iteration id. This is a ULID, which is a unique identifier similar
// The iteration ID. This is a ULID, which is a unique identifier similar
// to a UUID. It is created by the HCP Packer Registry when an iteration is
// first created, and is unique to this iteration.
ID string `mapstructure:"id,omitempty"`
@ -112,7 +112,7 @@ type ParImage struct {
}
type DatasourceOutput struct {
// The iteration id. This is a ULID, which is a unique identifier similar
// The iteration ID. This is a ULID, which is a unique identifier similar
// to a UUID. It is created by the HCP Packer Registry when an iteration is
// first created, and is unique to this iteration.
Id string `mapstructure:"Id"`
@ -125,7 +125,7 @@ type DatasourceOutput struct {
// The date the iteration was created.
CreatedAt string `mapstructure:"created_at"`
// A list of builds that are stored in the iteration. These builds can be
// parsed using HCL to find individual image ids for specific providers.
// parsed using HCL to find individual image IDs for specific providers.
Builds []ParBuild `mapstructure:"builds"`
}

Loading…
Cancel
Save