From 77162b39dad0c11f1ea60c898f2855f7fbbecf47 Mon Sep 17 00:00:00 2001 From: Harrison Turton Date: Tue, 23 Oct 2018 13:11:21 +1100 Subject: [PATCH] Update documentation for ServiceUpdate Currently, the behaviour for the version field in ServiceUpdate() is vague. Without an correct version number, users are unable to successfully run ServiceUpdate(), which is a pretty critical method for scaling services (for example). I've just added an extra sentence explaining what the version number is for, and where to find it. Signed-off-by: Harrison Turton --- client/service_update.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/client/service_update.go b/client/service_update.go index 5a7a61b01f..3c21214f60 100644 --- a/client/service_update.go +++ b/client/service_update.go @@ -10,7 +10,9 @@ import ( "github.com/docker/docker/api/types/swarm" ) -// ServiceUpdate updates a Service. +// ServiceUpdate updates a Service. The version number is required to avoid conflicting writes. +// It should be the value as set *before* the update. You can find this value in the Meta field +// of swarm.Service, which can be found using ServiceInspectWithRaw. func (cli *Client) ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options types.ServiceUpdateOptions) (types.ServiceUpdateResponse, error) { var ( query = url.Values{}