Browse code

docs: API v1.40: move system version response to definitions

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit e221931ccd9498cc71fc86dd504464be30034bdb)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2020/07/20 21:13:06
Showing 1 changed files
... ...
@@ -4117,6 +4117,103 @@ definitions:
4117 4117
         x-nullable: true
4118 4118
         $ref: "#/definitions/Health"
4119 4119
 
4120
+  SystemVersion:
4121
+    type: "object"
4122
+    description: |
4123
+      Response of Engine API: GET "/version"
4124
+    properties:
4125
+      Platform:
4126
+        type: "object"
4127
+        required: [Name]
4128
+        properties:
4129
+          Name:
4130
+            type: "string"
4131
+      Components:
4132
+        type: "array"
4133
+        description: |
4134
+          Information about system components
4135
+        items:
4136
+          type: "object"
4137
+          x-go-name: ComponentVersion
4138
+          required: [Name, Version]
4139
+          properties:
4140
+            Name:
4141
+              description: |
4142
+                Name of the component
4143
+              type: "string"
4144
+              example: "Engine"
4145
+            Version:
4146
+              description: |
4147
+                Version of the component
4148
+              type: "string"
4149
+              x-nullable: false
4150
+              example: "19.03.12"
4151
+            Details:
4152
+              description: |
4153
+                Key/value pairs of strings with additional information about the
4154
+                component. These values are intended for informational purposes
4155
+                only, and their content is not defined, and not part of the API
4156
+                specification.
4157
+
4158
+                These messages can be printed by the client as information to the user.
4159
+              type: "object"
4160
+              x-nullable: true
4161
+      Version:
4162
+        description: "The version of the daemon"
4163
+        type: "string"
4164
+        example: "19.03.12"
4165
+      ApiVersion:
4166
+        description: |
4167
+          The default (and highest) API version that is supported by the daemon
4168
+        type: "string"
4169
+        example: "1.40"
4170
+      MinAPIVersion:
4171
+        description: |
4172
+          The minimum API version that is supported by the daemon
4173
+        type: "string"
4174
+        example: "1.12"
4175
+      GitCommit:
4176
+        description: |
4177
+          The Git commit of the source code that was used to build the daemon
4178
+        type: "string"
4179
+        example: "48a66213fe"
4180
+      GoVersion:
4181
+        description: |
4182
+          The version Go used to compile the daemon, and the version of the Go
4183
+          runtime in use.
4184
+        type: "string"
4185
+        example: "go1.13.14"
4186
+      Os:
4187
+        description: |
4188
+          The operating system that the daemon is running on ("linux" or "windows")
4189
+        type: "string"
4190
+        example: "linux"
4191
+      Arch:
4192
+        description: |
4193
+          The architecture that the daemon is running on
4194
+        type: "string"
4195
+        example: "amd64"
4196
+      KernelVersion:
4197
+        description: |
4198
+          The kernel version (`uname -r`) that the daemon is running on.
4199
+
4200
+          This field is omitted when empty.
4201
+        type: "string"
4202
+        example: "4.19.76-linuxkit"
4203
+      Experimental:
4204
+        description: |
4205
+          Indicates if the daemon is started with experimental features enabled.
4206
+
4207
+          This field is omitted when empty / false.
4208
+        type: "boolean"
4209
+        example: true
4210
+      BuildTime:
4211
+        description: |
4212
+          The date and time that the daemon was compiled.
4213
+        type: "string"
4214
+        example: "2020-06-22T15:49:27.000000000+00:00"
4215
+
4216
+
4120 4217
   SystemInfo:
4121 4218
     type: "object"
4122 4219
     properties:
... ...
@@ -7736,63 +7833,7 @@ paths:
7736 7736
         200:
7737 7737
           description: "no error"
7738 7738
           schema:
7739
-            type: "object"
7740
-            title: "SystemVersionResponse"
7741
-            properties:
7742
-              Platform:
7743
-                type: "object"
7744
-                required: [Name]
7745
-                properties:
7746
-                  Name:
7747
-                    type: "string"
7748
-              Components:
7749
-                type: "array"
7750
-                items:
7751
-                  type: "object"
7752
-                  x-go-name: ComponentVersion
7753
-                  required: [Name, Version]
7754
-                  properties:
7755
-                    Name:
7756
-                      type: "string"
7757
-                    Version:
7758
-                      type: "string"
7759
-                      x-nullable: false
7760
-                    Details:
7761
-                      type: "object"
7762
-                      x-nullable: true
7763
-
7764
-              Version:
7765
-                type: "string"
7766
-              ApiVersion:
7767
-                type: "string"
7768
-              MinAPIVersion:
7769
-                type: "string"
7770
-              GitCommit:
7771
-                type: "string"
7772
-              GoVersion:
7773
-                type: "string"
7774
-              Os:
7775
-                type: "string"
7776
-              Arch:
7777
-                type: "string"
7778
-              KernelVersion:
7779
-                type: "string"
7780
-              Experimental:
7781
-                type: "boolean"
7782
-              BuildTime:
7783
-                type: "string"
7784
-          examples:
7785
-            application/json:
7786
-              Version: "17.04.0"
7787
-              Os: "linux"
7788
-              KernelVersion: "3.19.0-23-generic"
7789
-              GoVersion: "go1.7.5"
7790
-              GitCommit: "deadbee"
7791
-              Arch: "amd64"
7792
-              ApiVersion: "1.27"
7793
-              MinAPIVersion: "1.12"
7794
-              BuildTime: "2016-06-14T07:09:13.444803460+00:00"
7795
-              Experimental: true
7739
+            $ref: "#/definitions/SystemVersion"
7796 7740
         500:
7797 7741
           description: "server error"
7798 7742
           schema: