Browse code

Add SecretUpdate docs to api/swagger.yaml

Docker-DCO-1.1-Signed-off-by: Josh Hawn <josh.hawn@docker.com> (github: jlhawn)

(cherry picked from commit 1cd5af59bffb6ee38f3599443abdcc30359bd521)
Signed-off-by: Victor Vieux <vieux@docker.com>

Josh Hawn authored on 2016/11/30 10:33:45
Showing 1 changed files
... ...
@@ -7678,3 +7678,36 @@ paths:
7678 7678
           type: "string"
7679 7679
           description: "ID of the secret"
7680 7680
       tags: ["Secret"]
7681
+  /secrets/{id}/update:
7682
+    post:
7683
+      summary: "Update a Secret"
7684
+      operationId: "SecretUpdate"
7685
+      responses:
7686
+        200:
7687
+          description: "no error"
7688
+        404:
7689
+          description: "no such secret"
7690
+          schema:
7691
+            $ref: "#/definitions/ErrorResponse"
7692
+        500:
7693
+          description: "server error"
7694
+          schema:
7695
+            $ref: "#/definitions/ErrorResponse"
7696
+      parameters:
7697
+        - name: "id"
7698
+          in: "path"
7699
+          description: "The ID of the secret"
7700
+          type: "string"
7701
+          required: true
7702
+        - name: "body"
7703
+          in: "body"
7704
+          schema:
7705
+            $ref: "#/definitions/SecretSpec"
7706
+          description: "The spec of the secret to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the [SecretInspect endpoint](#operation/SecretInspect) response values."
7707
+        - name: "version"
7708
+          in: "query"
7709
+          description: "The version number of the secret object being updated. This is required to avoid conflicting writes."
7710
+          type: "integer"
7711
+          format: "int64"
7712
+          required: true
7713
+      tags: ["Secret"]