From 5425e3a895bc6c935134d7c4f4bf955b4252b97d Mon Sep 17 00:00:00 2001 From: Brian Goff Date: Mon, 15 Oct 2018 08:31:31 -0700 Subject: [PATCH] Add more API doc details on service update version. Hopefully this removes some confusion as to what this version number should be. Signed-off-by: Brian Goff (cherry picked from commit 5bdfa19b8646839f9d704307aa6589c7d686db44) Signed-off-by: Sebastiaan van Stijn Upstream-commit: 64b0c76151ceb7b26f9c7477f3044dac747d227b Component: engine --- components/engine/api/swagger.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/components/engine/api/swagger.yaml b/components/engine/api/swagger.yaml index fb8710d342..f58a64f29e 100644 --- a/components/engine/api/swagger.yaml +++ b/components/engine/api/swagger.yaml @@ -9345,7 +9345,10 @@ paths: - name: "version" in: "query" - description: "The version number of the service object being updated. This is required to avoid conflicting writes." + description: "The version number of the service object being updated. + This is required to avoid conflicting writes. + This version number should be the value as currently set on the service *before* the update. + You can find the current version by calling `GET /services/{id}`" required: true type: "integer" - name: "registryAuthFrom"