瀏覽代碼

Add missing definition for Node.Status

The `Node.Status`  property was only present in
the example, but not in the definition.

This patch adds definitions for `NodeStatus`
and `NodeState`, similar to what is used in the
code;

- https://github.com/moby/moby/blob/f02a5b50c407bdb087388e18e1ac619f2788dd8d/api/types/swarm/node.go#L77-L82
- https://github.com/moby/moby/blob/f02a5b50c407bdb087388e18e1ac619f2788dd8d/api/types/swarm/node.go#L103-L115

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 8 年之前
父節點
當前提交
26b247e706
共有 1 個文件被更改,包括 29 次插入0 次删除
  1. 29 0
      api/swagger.yaml

+ 29 - 0
api/swagger.yaml

@@ -2087,6 +2087,8 @@ definitions:
                       type: "string"
           TLSInfo:
             $ref: "#/definitions/TLSInfo"
+      Status:
+        $ref: "#/definitions/NodeStatus"
     example:
       ID: "24ifsmvkjbyhk"
       Version:
@@ -2208,6 +2210,33 @@ definitions:
       CertIssuerSubject: "MBMxETAPBgNVBAMTCHN3YXJtLWNh"
       CertIssuerPublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A=="
 
+  NodeStatus:
+    description: |
+      NodeStatus represents the status of a node.
+
+      It provides the current status of the node, as seen by the manager.
+    type: "object"
+    properties:
+      State:
+        $ref: "#/definitions/NodeState"
+      Message:
+        type: "string"
+        example: ""
+      Addr:
+        description: "IP address of the node."
+        type: "string"
+        example: "172.17.0.2"
+
+  NodeState:
+    description: "NodeState represents the state of a node."
+    type: "string"
+    enum:
+      - "unknown"
+      - "down"
+      - "ready"
+      - "disconnected"
+    example: "ready"
+
   SwarmSpec:
     description: "User modifiable swarm configuration."
     type: "object"