Browse code

Update swagger spec for plugin upgrade

This was added in 03c694973968f63743ed53cef83d0b7455695081 but spec was
not updated.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
(cherry picked from commit ae48cd04dacddbab50839be620b1f659ca322b7c)
Signed-off-by: Victor Vieux <victorvieux@gmail.com>

Brian Goff authored on 2017/02/07 01:15:06
Showing 1 changed files
... ...
@@ -6590,6 +6590,69 @@ paths:
6590 6590
           required: true
6591 6591
           type: "string"
6592 6592
       tags: ["Plugin"]
6593
+  /plugins/{name}/upgrade:
6594
+    post:
6595
+      summary: "Upgrade a plugin"
6596
+      operationId: "PluginUpgrade"
6597
+      responses:
6598
+        204:
6599
+          description: "no error"
6600
+        404:
6601
+          description: "plugin not installed"
6602
+          schema:
6603
+            $ref: "#/definitions/ErrorResponse"
6604
+        500:
6605
+          description: "server error"
6606
+          schema:
6607
+            $ref: "#/definitions/ErrorResponse"
6608
+      parameters:
6609
+        - name: "name"
6610
+          in: "path"
6611
+          description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted."
6612
+          required: true
6613
+          type: "string"
6614
+        - name: "remote"
6615
+          in: "query"
6616
+          description: |
6617
+            Remote reference to upgrade to.
6618
+
6619
+            The `:latest` tag is optional, and is used as the default if omitted.
6620
+          required: true
6621
+          type: "string"
6622
+        - name: "X-Registry-Auth"
6623
+          in: "header"
6624
+          description: "A base64-encoded auth configuration to use when pulling a plugin from a registry. [See the authentication section for details.](#section/Authentication)"
6625
+          type: "string"
6626
+        - name: "body"
6627
+          in: "body"
6628
+          schema:
6629
+            type: "array"
6630
+            items:
6631
+              description: "Describes a permission accepted by the user upon installing the plugin."
6632
+              type: "object"
6633
+              properties:
6634
+                Name:
6635
+                  type: "string"
6636
+                Description:
6637
+                  type: "string"
6638
+                Value:
6639
+                  type: "array"
6640
+                  items:
6641
+                    type: "string"
6642
+            example:
6643
+              - Name: "network"
6644
+                Description: ""
6645
+                Value:
6646
+                  - "host"
6647
+              - Name: "mount"
6648
+                Description: ""
6649
+                Value:
6650
+                  - "/data"
6651
+              - Name: "device"
6652
+                Description: ""
6653
+                Value:
6654
+                  - "/dev/cpu_dma_latency"
6655
+      tags: ["Plugin"]
6593 6656
   /plugins/create:
6594 6657
     post:
6595 6658
       summary: "Create a plugin"