Merge pull request #41273 from thaJeztah/19.03_backport_swagger_fixes
[19.03 backport] Assorted swagger fixes
diff --git a/api/swagger.yaml b/api/swagger.yaml
index f21cab7..8ed0b88 100644
--- a/api/swagger.yaml
+++ b/api/swagger.yaml
@@ -1874,12 +1874,24 @@
Shared:
type: "boolean"
Size:
+ description: |
+ Amount of disk space used by the build cache (in bytes).
type: "integer"
CreatedAt:
- type: "integer"
+ description: |
+ Date and time at which the build cache was created in
+ [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+ type: "string"
+ format: "dateTime"
+ example: "2016-08-18T10:44:24.496525531Z"
LastUsedAt:
- type: "integer"
+ description: |
+ Date and time at which the build cache was last used in
+ [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+ type: "string"
+ format: "dateTime"
x-nullable: true
+ example: "2017-08-09T07:09:37.632105588Z"
UsageCount:
type: "integer"
@@ -4105,6 +4117,103 @@
x-nullable: true
$ref: "#/definitions/Health"
+ SystemVersion:
+ type: "object"
+ description: |
+ Response of Engine API: GET "/version"
+ properties:
+ Platform:
+ type: "object"
+ required: [Name]
+ properties:
+ Name:
+ type: "string"
+ Components:
+ type: "array"
+ description: |
+ Information about system components
+ items:
+ type: "object"
+ x-go-name: ComponentVersion
+ required: [Name, Version]
+ properties:
+ Name:
+ description: |
+ Name of the component
+ type: "string"
+ example: "Engine"
+ Version:
+ description: |
+ Version of the component
+ type: "string"
+ x-nullable: false
+ example: "19.03.12"
+ Details:
+ description: |
+ Key/value pairs of strings with additional information about the
+ component. These values are intended for informational purposes
+ only, and their content is not defined, and not part of the API
+ specification.
+
+ These messages can be printed by the client as information to the user.
+ type: "object"
+ x-nullable: true
+ Version:
+ description: "The version of the daemon"
+ type: "string"
+ example: "19.03.12"
+ ApiVersion:
+ description: |
+ The default (and highest) API version that is supported by the daemon
+ type: "string"
+ example: "1.40"
+ MinAPIVersion:
+ description: |
+ The minimum API version that is supported by the daemon
+ type: "string"
+ example: "1.12"
+ GitCommit:
+ description: |
+ The Git commit of the source code that was used to build the daemon
+ type: "string"
+ example: "48a66213fe"
+ GoVersion:
+ description: |
+ The version Go used to compile the daemon, and the version of the Go
+ runtime in use.
+ type: "string"
+ example: "go1.13.14"
+ Os:
+ description: |
+ The operating system that the daemon is running on ("linux" or "windows")
+ type: "string"
+ example: "linux"
+ Arch:
+ description: |
+ The architecture that the daemon is running on
+ type: "string"
+ example: "amd64"
+ KernelVersion:
+ description: |
+ The kernel version (`uname -r`) that the daemon is running on.
+
+ This field is omitted when empty.
+ type: "string"
+ example: "4.19.76-linuxkit"
+ Experimental:
+ description: |
+ Indicates if the daemon is started with experimental features enabled.
+
+ This field is omitted when empty / false.
+ type: "boolean"
+ example: true
+ BuildTime:
+ description: |
+ The date and time that the daemon was compiled.
+ type: "string"
+ example: "2020-06-22T15:49:27.000000000+00:00"
+
+
SystemInfo:
type: "object"
properties:
@@ -7724,63 +7833,7 @@
200:
description: "no error"
schema:
- type: "object"
- title: "SystemVersionResponse"
- properties:
- Platform:
- type: "object"
- required: [Name]
- properties:
- Name:
- type: "string"
- Components:
- type: "array"
- items:
- type: "object"
- x-go-name: ComponentVersion
- required: [Name, Version]
- properties:
- Name:
- type: "string"
- Version:
- type: "string"
- x-nullable: false
- Details:
- type: "object"
- x-nullable: true
-
- Version:
- type: "string"
- ApiVersion:
- type: "string"
- MinAPIVersion:
- type: "string"
- GitCommit:
- type: "string"
- GoVersion:
- type: "string"
- Os:
- type: "string"
- Arch:
- type: "string"
- KernelVersion:
- type: "string"
- Experimental:
- type: "boolean"
- BuildTime:
- type: "string"
- examples:
- application/json:
- Version: "17.04.0"
- Os: "linux"
- KernelVersion: "3.19.0-23-generic"
- GoVersion: "go1.7.5"
- GitCommit: "deadbee"
- Arch: "amd64"
- ApiVersion: "1.27"
- MinAPIVersion: "1.12"
- BuildTime: "2016-06-14T07:09:13.444803460+00:00"
- Experimental: true
+ $ref: "#/definitions/SystemVersion"
500:
description: "server error"
schema:
diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml
index 286afaf..74c295b 100644
--- a/docs/api/v1.39.yaml
+++ b/docs/api/v1.39.yaml
@@ -1815,12 +1815,24 @@
Shared:
type: "boolean"
Size:
+ description: |
+ Amount of disk space used by the build cache (in bytes).
type: "integer"
CreatedAt:
- type: "integer"
+ description: |
+ Date and time at which the build cache was created in
+ [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+ type: "string"
+ format: "dateTime"
+ example: "2016-08-18T10:44:24.496525531Z"
LastUsedAt:
- type: "integer"
+ description: |
+ Date and time at which the build cache was last used in
+ [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+ type: "string"
+ format: "dateTime"
x-nullable: true
+ example: "2017-08-09T07:09:37.632105588Z"
UsageCount:
type: "integer"
@@ -3987,6 +3999,103 @@
x-nullable: true
$ref: "#/definitions/Health"
+ SystemVersion:
+ type: "object"
+ description: |
+ Response of Engine API: GET "/version"
+ properties:
+ Platform:
+ type: "object"
+ required: [Name]
+ properties:
+ Name:
+ type: "string"
+ Components:
+ type: "array"
+ description: |
+ Information about system components
+ items:
+ type: "object"
+ x-go-name: ComponentVersion
+ required: [Name, Version]
+ properties:
+ Name:
+ description: |
+ Name of the component
+ type: "string"
+ example: "Engine"
+ Version:
+ description: |
+ Version of the component
+ type: "string"
+ x-nullable: false
+ example: "19.03.12"
+ Details:
+ description: |
+ Key/value pairs of strings with additional information about the
+ component. These values are intended for informational purposes
+ only, and their content is not defined, and not part of the API
+ specification.
+
+ These messages can be printed by the client as information to the user.
+ type: "object"
+ x-nullable: true
+ Version:
+ description: "The version of the daemon"
+ type: "string"
+ example: "19.03.12"
+ ApiVersion:
+ description: |
+ The default (and highest) API version that is supported by the daemon
+ type: "string"
+ example: "1.40"
+ MinAPIVersion:
+ description: |
+ The minimum API version that is supported by the daemon
+ type: "string"
+ example: "1.12"
+ GitCommit:
+ description: |
+ The Git commit of the source code that was used to build the daemon
+ type: "string"
+ example: "48a66213fe"
+ GoVersion:
+ description: |
+ The version Go used to compile the daemon, and the version of the Go
+ runtime in use.
+ type: "string"
+ example: "go1.13.14"
+ Os:
+ description: |
+ The operating system that the daemon is running on ("linux" or "windows")
+ type: "string"
+ example: "linux"
+ Arch:
+ description: |
+ The architecture that the daemon is running on
+ type: "string"
+ example: "amd64"
+ KernelVersion:
+ description: |
+ The kernel version (`uname -r`) that the daemon is running on.
+
+ This field is omitted when empty.
+ type: "string"
+ example: "4.19.76-linuxkit"
+ Experimental:
+ description: |
+ Indicates if the daemon is started with experimental features enabled.
+
+ This field is omitted when empty / false.
+ type: "boolean"
+ example: true
+ BuildTime:
+ description: |
+ The date and time that the daemon was compiled.
+ type: "string"
+ example: "2020-06-22T15:49:27.000000000+00:00"
+
+
SystemInfo:
type: "object"
properties:
@@ -7581,63 +7690,7 @@
200:
description: "no error"
schema:
- type: "object"
- title: "SystemVersionResponse"
- properties:
- Platform:
- type: "object"
- required: [Name]
- properties:
- Name:
- type: "string"
- Components:
- type: "array"
- items:
- type: "object"
- x-go-name: ComponentVersion
- required: [Name, Version]
- properties:
- Name:
- type: "string"
- Version:
- type: "string"
- x-nullable: false
- Details:
- type: "object"
- x-nullable: true
-
- Version:
- type: "string"
- ApiVersion:
- type: "string"
- MinAPIVersion:
- type: "string"
- GitCommit:
- type: "string"
- GoVersion:
- type: "string"
- Os:
- type: "string"
- Arch:
- type: "string"
- KernelVersion:
- type: "string"
- Experimental:
- type: "boolean"
- BuildTime:
- type: "string"
- examples:
- application/json:
- Version: "17.04.0"
- Os: "linux"
- KernelVersion: "3.19.0-23-generic"
- GoVersion: "go1.7.5"
- GitCommit: "deadbee"
- Arch: "amd64"
- ApiVersion: "1.27"
- MinAPIVersion: "1.12"
- BuildTime: "2016-06-14T07:09:13.444803460+00:00"
- Experimental: true
+ $ref: "#/definitions/SystemVersion"
500:
description: "server error"
schema:
diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml
index f21cab7..8ed0b88 100644
--- a/docs/api/v1.40.yaml
+++ b/docs/api/v1.40.yaml
@@ -1874,12 +1874,24 @@
Shared:
type: "boolean"
Size:
+ description: |
+ Amount of disk space used by the build cache (in bytes).
type: "integer"
CreatedAt:
- type: "integer"
+ description: |
+ Date and time at which the build cache was created in
+ [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+ type: "string"
+ format: "dateTime"
+ example: "2016-08-18T10:44:24.496525531Z"
LastUsedAt:
- type: "integer"
+ description: |
+ Date and time at which the build cache was last used in
+ [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+ type: "string"
+ format: "dateTime"
x-nullable: true
+ example: "2017-08-09T07:09:37.632105588Z"
UsageCount:
type: "integer"
@@ -4105,6 +4117,103 @@
x-nullable: true
$ref: "#/definitions/Health"
+ SystemVersion:
+ type: "object"
+ description: |
+ Response of Engine API: GET "/version"
+ properties:
+ Platform:
+ type: "object"
+ required: [Name]
+ properties:
+ Name:
+ type: "string"
+ Components:
+ type: "array"
+ description: |
+ Information about system components
+ items:
+ type: "object"
+ x-go-name: ComponentVersion
+ required: [Name, Version]
+ properties:
+ Name:
+ description: |
+ Name of the component
+ type: "string"
+ example: "Engine"
+ Version:
+ description: |
+ Version of the component
+ type: "string"
+ x-nullable: false
+ example: "19.03.12"
+ Details:
+ description: |
+ Key/value pairs of strings with additional information about the
+ component. These values are intended for informational purposes
+ only, and their content is not defined, and not part of the API
+ specification.
+
+ These messages can be printed by the client as information to the user.
+ type: "object"
+ x-nullable: true
+ Version:
+ description: "The version of the daemon"
+ type: "string"
+ example: "19.03.12"
+ ApiVersion:
+ description: |
+ The default (and highest) API version that is supported by the daemon
+ type: "string"
+ example: "1.40"
+ MinAPIVersion:
+ description: |
+ The minimum API version that is supported by the daemon
+ type: "string"
+ example: "1.12"
+ GitCommit:
+ description: |
+ The Git commit of the source code that was used to build the daemon
+ type: "string"
+ example: "48a66213fe"
+ GoVersion:
+ description: |
+ The version Go used to compile the daemon, and the version of the Go
+ runtime in use.
+ type: "string"
+ example: "go1.13.14"
+ Os:
+ description: |
+ The operating system that the daemon is running on ("linux" or "windows")
+ type: "string"
+ example: "linux"
+ Arch:
+ description: |
+ The architecture that the daemon is running on
+ type: "string"
+ example: "amd64"
+ KernelVersion:
+ description: |
+ The kernel version (`uname -r`) that the daemon is running on.
+
+ This field is omitted when empty.
+ type: "string"
+ example: "4.19.76-linuxkit"
+ Experimental:
+ description: |
+ Indicates if the daemon is started with experimental features enabled.
+
+ This field is omitted when empty / false.
+ type: "boolean"
+ example: true
+ BuildTime:
+ description: |
+ The date and time that the daemon was compiled.
+ type: "string"
+ example: "2020-06-22T15:49:27.000000000+00:00"
+
+
SystemInfo:
type: "object"
properties:
@@ -7724,63 +7833,7 @@
200:
description: "no error"
schema:
- type: "object"
- title: "SystemVersionResponse"
- properties:
- Platform:
- type: "object"
- required: [Name]
- properties:
- Name:
- type: "string"
- Components:
- type: "array"
- items:
- type: "object"
- x-go-name: ComponentVersion
- required: [Name, Version]
- properties:
- Name:
- type: "string"
- Version:
- type: "string"
- x-nullable: false
- Details:
- type: "object"
- x-nullable: true
-
- Version:
- type: "string"
- ApiVersion:
- type: "string"
- MinAPIVersion:
- type: "string"
- GitCommit:
- type: "string"
- GoVersion:
- type: "string"
- Os:
- type: "string"
- Arch:
- type: "string"
- KernelVersion:
- type: "string"
- Experimental:
- type: "boolean"
- BuildTime:
- type: "string"
- examples:
- application/json:
- Version: "17.04.0"
- Os: "linux"
- KernelVersion: "3.19.0-23-generic"
- GoVersion: "go1.7.5"
- GitCommit: "deadbee"
- Arch: "amd64"
- ApiVersion: "1.27"
- MinAPIVersion: "1.12"
- BuildTime: "2016-06-14T07:09:13.444803460+00:00"
- Experimental: true
+ $ref: "#/definitions/SystemVersion"
500:
description: "server error"
schema:
