Browse code

api: update godoc

Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>

Tonis Tiigi authored on 2018/05/26 07:18:24
Showing 1 changed files
... ...
@@ -181,8 +181,12 @@ type ImageBuildOptions struct {
181 181
 	Target      string
182 182
 	SessionID   string
183 183
 	Platform    string
184
-	Version     BuilderVersion
185
-	BuildID     string
184
+	// Version specifies the version of the unerlying builder to use
185
+	Version BuilderVersion
186
+	// BuildID is an optional identifier that can be passed together with the
187
+	// build request. The same identifier can be used to gracefully cancel the
188
+	// build with the cancel request.
189
+	BuildID string
186 190
 }
187 191
 
188 192
 // BuilderVersion sets the version of underlying builder to use