From 6aa76adf59ce90701f9ccbd6f07caf97228a9f50 Mon Sep 17 00:00:00 2001 From: Tonis Tiigi Date: Fri, 25 May 2018 15:18:24 -0700 Subject: [PATCH] api: update godoc Signed-off-by: Tonis Tiigi --- api/types/client.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/api/types/client.go b/api/types/client.go index a7d8ab932b..3df8d23368 100644 --- a/api/types/client.go +++ b/api/types/client.go @@ -181,8 +181,12 @@ type ImageBuildOptions struct { Target string SessionID string Platform string - Version BuilderVersion - BuildID string + // Version specifies the version of the unerlying builder to use + Version BuilderVersion + // BuildID is an optional identifier that can be passed together with the + // build request. The same identifier can be used to gracefully cancel the + // build with the cancel request. + BuildID string } // BuilderVersion sets the version of underlying builder to use