Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 009eca4

Browse files
committed
docs: API v1.39: move system version response to definitions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit f2cc755f66640ef2a1ef2d1c5635eb2620f75ce1) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Upstream-commit: 9eade7d03c8173637bbd200d71334e47c59220cc Component: engine
1 parent 4f25b9e commit 009eca4

1 file changed

Lines changed: 98 additions & 57 deletions

File tree

components/engine/docs/api/v1.39.yaml

Lines changed: 98 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -3999,6 +3999,103 @@ definitions:
39993999
x-nullable: true
40004000
$ref: "#/definitions/Health"
40014001

4002+
SystemVersion:
4003+
type: "object"
4004+
description: |
4005+
Response of Engine API: GET "/version"
4006+
properties:
4007+
Platform:
4008+
type: "object"
4009+
required: [Name]
4010+
properties:
4011+
Name:
4012+
type: "string"
4013+
Components:
4014+
type: "array"
4015+
description: |
4016+
Information about system components
4017+
items:
4018+
type: "object"
4019+
x-go-name: ComponentVersion
4020+
required: [Name, Version]
4021+
properties:
4022+
Name:
4023+
description: |
4024+
Name of the component
4025+
type: "string"
4026+
example: "Engine"
4027+
Version:
4028+
description: |
4029+
Version of the component
4030+
type: "string"
4031+
x-nullable: false
4032+
example: "19.03.12"
4033+
Details:
4034+
description: |
4035+
Key/value pairs of strings with additional information about the
4036+
component. These values are intended for informational purposes
4037+
only, and their content is not defined, and not part of the API
4038+
specification.
4039+
4040+
These messages can be printed by the client as information to the user.
4041+
type: "object"
4042+
x-nullable: true
4043+
Version:
4044+
description: "The version of the daemon"
4045+
type: "string"
4046+
example: "19.03.12"
4047+
ApiVersion:
4048+
description: |
4049+
The default (and highest) API version that is supported by the daemon
4050+
type: "string"
4051+
example: "1.40"
4052+
MinAPIVersion:
4053+
description: |
4054+
The minimum API version that is supported by the daemon
4055+
type: "string"
4056+
example: "1.12"
4057+
GitCommit:
4058+
description: |
4059+
The Git commit of the source code that was used to build the daemon
4060+
type: "string"
4061+
example: "48a66213fe"
4062+
GoVersion:
4063+
description: |
4064+
The version Go used to compile the daemon, and the version of the Go
4065+
runtime in use.
4066+
type: "string"
4067+
example: "go1.13.14"
4068+
Os:
4069+
description: |
4070+
The operating system that the daemon is running on ("linux" or "windows")
4071+
type: "string"
4072+
example: "linux"
4073+
Arch:
4074+
description: |
4075+
The architecture that the daemon is running on
4076+
type: "string"
4077+
example: "amd64"
4078+
KernelVersion:
4079+
description: |
4080+
The kernel version (`uname -r`) that the daemon is running on.
4081+
4082+
This field is omitted when empty.
4083+
type: "string"
4084+
example: "4.19.76-linuxkit"
4085+
Experimental:
4086+
description: |
4087+
Indicates if the daemon is started with experimental features enabled.
4088+
4089+
This field is omitted when empty / false.
4090+
type: "boolean"
4091+
example: true
4092+
BuildTime:
4093+
description: |
4094+
The date and time that the daemon was compiled.
4095+
type: "string"
4096+
example: "2020-06-22T15:49:27.000000000+00:00"
4097+
4098+
40024099
SystemInfo:
40034100
type: "object"
40044101
properties:
@@ -7593,63 +7690,7 @@ paths:
75937690
200:
75947691
description: "no error"
75957692
schema:
7596-
type: "object"
7597-
title: "SystemVersionResponse"
7598-
properties:
7599-
Platform:
7600-
type: "object"
7601-
required: [Name]
7602-
properties:
7603-
Name:
7604-
type: "string"
7605-
Components:
7606-
type: "array"
7607-
items:
7608-
type: "object"
7609-
x-go-name: ComponentVersion
7610-
required: [Name, Version]
7611-
properties:
7612-
Name:
7613-
type: "string"
7614-
Version:
7615-
type: "string"
7616-
x-nullable: false
7617-
Details:
7618-
type: "object"
7619-
x-nullable: true
7620-
7621-
Version:
7622-
type: "string"
7623-
ApiVersion:
7624-
type: "string"
7625-
MinAPIVersion:
7626-
type: "string"
7627-
GitCommit:
7628-
type: "string"
7629-
GoVersion:
7630-
type: "string"
7631-
Os:
7632-
type: "string"
7633-
Arch:
7634-
type: "string"
7635-
KernelVersion:
7636-
type: "string"
7637-
Experimental:
7638-
type: "boolean"
7639-
BuildTime:
7640-
type: "string"
7641-
examples:
7642-
application/json:
7643-
Version: "17.04.0"
7644-
Os: "linux"
7645-
KernelVersion: "3.19.0-23-generic"
7646-
GoVersion: "go1.7.5"
7647-
GitCommit: "deadbee"
7648-
Arch: "amd64"
7649-
ApiVersion: "1.27"
7650-
MinAPIVersion: "1.12"
7651-
BuildTime: "2016-06-14T07:09:13.444803460+00:00"
7652-
Experimental: true
7693+
$ref: "#/definitions/SystemVersion"
76537694
500:
76547695
description: "server error"
76557696
schema:

0 commit comments

Comments
 (0)