Browse code

Update API plugin response examples

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2017/07/26 01:24:17
Showing 2 changed files
... ...
@@ -1393,26 +1393,33 @@ definitions:
1393 1393
       Name:
1394 1394
         type: "string"
1395 1395
         x-nullable: false
1396
+        example: "some-mount"
1396 1397
       Description:
1397 1398
         type: "string"
1398 1399
         x-nullable: false
1400
+        example: "This is a mount that's used by the plugin."
1399 1401
       Settable:
1400 1402
         type: "array"
1401 1403
         items:
1402 1404
           type: "string"
1403 1405
       Source:
1404 1406
         type: "string"
1407
+        example: "/var/lib/docker/plugins/"
1405 1408
       Destination:
1406 1409
         type: "string"
1407 1410
         x-nullable: false
1411
+        example: "/mnt/state"
1408 1412
       Type:
1409 1413
         type: "string"
1410 1414
         x-nullable: false
1415
+        example: "bind"
1411 1416
       Options:
1412 1417
         type: "array"
1413 1418
         items:
1414 1419
           type: "string"
1415
-
1420
+        example:
1421
+          - "rbind"
1422
+          - "rw"
1416 1423
   PluginDevice:
1417 1424
     type: "object"
1418 1425
     required: [Name, Description, Settable, Path]
... ...
@@ -1430,6 +1437,7 @@ definitions:
1430 1430
           type: "string"
1431 1431
       Path:
1432 1432
         type: "string"
1433
+        example: "/dev/fuse"
1433 1434
 
1434 1435
   PluginEnv:
1435 1436
     type: "object"
... ...
@@ -1471,13 +1479,16 @@ definitions:
1471 1471
     properties:
1472 1472
       Id:
1473 1473
         type: "string"
1474
+        example: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
1474 1475
       Name:
1475 1476
         type: "string"
1476 1477
         x-nullable: false
1478
+        example: "tiborvass/sample-volume-plugin"
1477 1479
       Enabled:
1478
-        description: "True when the plugin is running. False when the plugin is not running, only installed."
1480
+        description: "True if the plugin is running. False if the plugin is not running, only installed."
1479 1481
         type: "boolean"
1480 1482
         x-nullable: false
1483
+        example: true
1481 1484
       Settings:
1482 1485
         description: "Settings that can be modified by users."
1483 1486
         type: "object"
... ...
@@ -1492,6 +1503,8 @@ definitions:
1492 1492
             type: "array"
1493 1493
             items:
1494 1494
               type: "string"
1495
+            example:
1496
+              - "DEBUG=0"
1495 1497
           Args:
1496 1498
             type: "array"
1497 1499
             items:
... ...
@@ -1504,6 +1517,7 @@ definitions:
1504 1504
         description: "plugin remote reference used to push/pull the plugin"
1505 1505
         type: "string"
1506 1506
         x-nullable: false
1507
+        example: "localhost:5000/tiborvass/sample-volume-plugin:latest"
1507 1508
       Config:
1508 1509
         description: "The config of a plugin."
1509 1510
         type: "object"
... ...
@@ -1527,12 +1541,15 @@ definitions:
1527 1527
             description: "Docker Version used to create the plugin"
1528 1528
             type: "string"
1529 1529
             x-nullable: false
1530
+            example: "17.06.0-ce"
1530 1531
           Description:
1531 1532
             type: "string"
1532 1533
             x-nullable: false
1534
+            example: "A sample volume plugin for Docker"
1533 1535
           Documentation:
1534 1536
             type: "string"
1535 1537
             x-nullable: false
1538
+            example: "https://docs.docker.com/engine/extend/plugins/"
1536 1539
           Interface:
1537 1540
             description: "The interface between Docker and the plugin"
1538 1541
             x-nullable: false
... ...
@@ -1543,16 +1560,23 @@ definitions:
1543 1543
                 type: "array"
1544 1544
                 items:
1545 1545
                   $ref: "#/definitions/PluginInterfaceType"
1546
+                example:
1547
+                  - "docker.volumedriver/1.0"
1546 1548
               Socket:
1547 1549
                 type: "string"
1548 1550
                 x-nullable: false
1551
+                example: "plugins.sock"
1549 1552
           Entrypoint:
1550 1553
             type: "array"
1551 1554
             items:
1552 1555
               type: "string"
1556
+            example:
1557
+              - "/usr/bin/sample-volume-plugin"
1558
+              - "/data"
1553 1559
           WorkDir:
1554 1560
             type: "string"
1555 1561
             x-nullable: false
1562
+            example: "/bin/"
1556 1563
           User:
1557 1564
             type: "object"
1558 1565
             x-nullable: false
... ...
@@ -1560,9 +1584,11 @@ definitions:
1560 1560
               UID:
1561 1561
                 type: "integer"
1562 1562
                 format: "uint32"
1563
+                example: 1000
1563 1564
               GID:
1564 1565
                 type: "integer"
1565 1566
                 format: "uint32"
1567
+                example: 1000
1566 1568
           Network:
1567 1569
             type: "object"
1568 1570
             x-nullable: false
... ...
@@ -1571,6 +1597,7 @@ definitions:
1571 1571
               Type:
1572 1572
                 x-nullable: false
1573 1573
                 type: "string"
1574
+                example: "host"
1574 1575
           Linux:
1575 1576
             type: "object"
1576 1577
             x-nullable: false
... ...
@@ -1580,9 +1607,13 @@ definitions:
1580 1580
                 type: "array"
1581 1581
                 items:
1582 1582
                   type: "string"
1583
+                example:
1584
+                  - "CAP_SYS_ADMIN"
1585
+                  - "CAP_SYSLOG"
1583 1586
               AllowAllDevices:
1584 1587
                 type: "boolean"
1585 1588
                 x-nullable: false
1589
+                example: false
1586 1590
               Devices:
1587 1591
                 type: "array"
1588 1592
                 items:
... ...
@@ -1590,12 +1621,15 @@ definitions:
1590 1590
           PropagatedMount:
1591 1591
             type: "string"
1592 1592
             x-nullable: false
1593
+            example: "/mnt/volumes"
1593 1594
           IpcHost:
1594 1595
             type: "boolean"
1595 1596
             x-nullable: false
1597
+            example: false
1596 1598
           PidHost:
1597 1599
             type: "boolean"
1598 1600
             x-nullable: false
1601
+            example: false
1599 1602
           Mounts:
1600 1603
             type: "array"
1601 1604
             items:
... ...
@@ -1604,6 +1638,11 @@ definitions:
1604 1604
             type: "array"
1605 1605
             items:
1606 1606
               $ref: "#/definitions/PluginEnv"
1607
+            example:
1608
+              - Name: "DEBUG"
1609
+                Description: "If set, prints debug messages"
1610
+                Settable: null
1611
+                Value: "0"
1607 1612
           Args:
1608 1613
             type: "object"
1609 1614
             x-nullable: false
... ...
@@ -1612,9 +1651,11 @@ definitions:
1612 1612
               Name:
1613 1613
                 x-nullable: false
1614 1614
                 type: "string"
1615
+                example: "args"
1615 1616
               Description:
1616 1617
                 x-nullable: false
1617 1618
                 type: "string"
1619
+                example: "command line arguments"
1618 1620
               Settable:
1619 1621
                 type: "array"
1620 1622
                 items:
... ...
@@ -1628,50 +1669,14 @@ definitions:
1628 1628
             properties:
1629 1629
               type:
1630 1630
                 type: "string"
1631
+                example: "layers"
1631 1632
               diff_ids:
1632 1633
                 type: "array"
1633 1634
                 items:
1634 1635
                   type: "string"
1635
-    example:
1636
-      Id: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
1637
-      Name: "tiborvass/sample-volume-plugin"
1638
-      Tag: "latest"
1639
-      Active: true
1640
-      Settings:
1641
-        Env:
1642
-          - "DEBUG=0"
1643
-        Args: null
1644
-        Devices: null
1645
-      Config:
1646
-        Description: "A sample volume plugin for Docker"
1647
-        Documentation: "https://docs.docker.com/engine/extend/plugins/"
1648
-        Interface:
1649
-          Types:
1650
-            - "docker.volumedriver/1.0"
1651
-          Socket: "plugins.sock"
1652
-        Entrypoint:
1653
-          - "/usr/bin/sample-volume-plugin"
1654
-          - "/data"
1655
-        WorkDir: ""
1656
-        User: {}
1657
-        Network:
1658
-          Type: ""
1659
-        Linux:
1660
-          Capabilities: null
1661
-          AllowAllDevices: false
1662
-          Devices: null
1663
-        Mounts: null
1664
-        PropagatedMount: "/data"
1665
-        Env:
1666
-          - Name: "DEBUG"
1667
-            Description: "If set, prints debug messages"
1668
-            Settable: null
1669
-            Value: "0"
1670
-        Args:
1671
-          Name: "args"
1672
-          Description: "command line arguments"
1673
-          Settable: null
1674
-          Value: []
1636
+                example:
1637
+                  - "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887"
1638
+                  - "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
1675 1639
 
1676 1640
   ObjectVersion:
1677 1641
     description: |
... ...
@@ -6931,46 +6936,6 @@ paths:
6931 6931
             type: "array"
6932 6932
             items:
6933 6933
               $ref: "#/definitions/Plugin"
6934
-            example:
6935
-              - Id: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
6936
-                Name: "tiborvass/sample-volume-plugin"
6937
-                Tag: "latest"
6938
-                Active: true
6939
-                Settings:
6940
-                  Env:
6941
-                    - "DEBUG=0"
6942
-                  Args: null
6943
-                  Devices: null
6944
-                Config:
6945
-                  Description: "A sample volume plugin for Docker"
6946
-                  Documentation: "https://docs.docker.com/engine/extend/plugins/"
6947
-                  Interface:
6948
-                    Types:
6949
-                      - "docker.volumedriver/1.0"
6950
-                    Socket: "plugins.sock"
6951
-                  Entrypoint:
6952
-                    - "/usr/bin/sample-volume-plugin"
6953
-                    - "/data"
6954
-                  WorkDir: ""
6955
-                  User: {}
6956
-                  Network:
6957
-                    Type: ""
6958
-                  Linux:
6959
-                    Capabilities: null
6960
-                    AllowAllDevices: false
6961
-                    Devices: null
6962
-                  Mounts: null
6963
-                  PropagatedMount: "/data"
6964
-                  Env:
6965
-                    - Name: "DEBUG"
6966
-                      Description: "If set, prints debug messages"
6967
-                      Settable: null
6968
-                      Value: "0"
6969
-                  Args:
6970
-                    Name: "args"
6971
-                    Description: "command line arguments"
6972
-                    Settable: null
6973
-                    Value: []
6974 6934
         500:
6975 6935
           description: "Server error"
6976 6936
           schema:
... ...
@@ -11,7 +11,7 @@ type Plugin struct {
11 11
 	// Required: true
12 12
 	Config PluginConfig `json:"Config"`
13 13
 
14
-	// True when the plugin is running. False when the plugin is not running, only installed.
14
+	// True if the plugin is running. False if the plugin is not running, only installed.
15 15
 	// Required: true
16 16
 	Enabled bool `json:"Enabled"`
17 17