Skip to content

Commit 086aa05

Browse files
authored
doc: improve instance images documentation (#322)
1 parent b653c34 commit 086aa05

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

api/instance/v1/instance_sdk.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1220,17 +1220,17 @@ type VolumeSummary struct {
12201220

12211221
// VolumeTemplate volume template
12221222
type VolumeTemplate struct {
1223-
// ID the volumes unique ID
1223+
// ID uUID of the volume
12241224
ID string `json:"id,omitempty"`
1225-
// Name the volumes name
1225+
// Name name of the volume
12261226
Name string `json:"name,omitempty"`
1227-
// Size the volumes disk size
1227+
// Size disk size of the volume
12281228
Size scw.Size `json:"size,omitempty"`
1229-
// VolumeType the volumes type
1229+
// VolumeType type of the volume
12301230
//
12311231
// Default value: l_ssd
12321232
VolumeType VolumeType `json:"volume_type,omitempty"`
1233-
// Organization the organization ID
1233+
// Organization organization ID of the volume
12341234
Organization string `json:"organization,omitempty"`
12351235
}
12361236

@@ -2063,21 +2063,21 @@ func (s *API) GetImage(req *GetImageRequest, opts ...scw.RequestOption) (*GetIma
20632063

20642064
type CreateImageRequest struct {
20652065
Zone scw.Zone `json:"-"`
2066-
2066+
// Name name of the image
20672067
Name string `json:"name,omitempty"`
2068-
2068+
// RootVolume uUID of the snapshot
20692069
RootVolume string `json:"root_volume,omitempty"`
2070-
// Arch
2070+
// Arch architecture of the image
20712071
//
20722072
// Default value: x86_64
20732073
Arch Arch `json:"arch"`
2074-
2074+
// DefaultBootscript default bootscript of the image
20752075
DefaultBootscript string `json:"default_bootscript,omitempty"`
2076-
2076+
// ExtraVolumes additional volumes of the image
20772077
ExtraVolumes map[string]*VolumeTemplate `json:"extra_volumes,omitempty"`
2078-
2078+
// Organization organization ID of the image
20792079
Organization string `json:"organization,omitempty"`
2080-
2080+
// Public true to create a public image
20812081
Public bool `json:"public,omitempty"`
20822082
}
20832083

0 commit comments

Comments
 (0)