Skip to content

Commit 65dced1

Browse files
committed
chore v1.44
1 parent 8684691 commit 65dced1

16 files changed

+91
-75
lines changed

api-model-v1-44/docker-engine-api-v1.44.yaml

Lines changed: 44 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -814,7 +814,7 @@ definitions:
814814
description: |
815815
Health stores information about the container's healthcheck results.
816816
type: "object"
817-
x-nullable: true
817+
# x-nullable: true
818818
properties:
819819
Status:
820820
description: |
@@ -840,13 +840,14 @@ definitions:
840840
description: |
841841
Log contains the last few results (oldest first)
842842
items:
843+
x-nullable: true
843844
$ref: "#/definitions/HealthcheckResult"
844845

845846
HealthcheckResult:
846847
description: |
847848
HealthcheckResult stores information about a single run of a healthcheck probe
848849
type: "object"
849-
x-nullable: true
850+
# x-nullable: true
850851
properties:
851852
Start:
852853
description: |
@@ -1229,7 +1230,7 @@ definitions:
12291230
12301231
`{"<port>/<tcp|udp|sctp>": {}}`
12311232
type: "object"
1232-
x-nullable: true
1233+
# x-nullable: true
12331234
additionalProperties:
12341235
type: "object"
12351236
enum:
@@ -1274,9 +1275,9 @@ definitions:
12741275
ArgsEscaped:
12751276
description: "Command is already escaped (Windows only)"
12761277
type: "boolean"
1277-
default: false
1278+
# default: false
12781279
example: false
1279-
x-nullable: true
1280+
# x-nullable: true
12801281
Image:
12811282
description: |
12821283
The name (or reference) of the image to use when creating the container,
@@ -1311,19 +1312,19 @@ definitions:
13111312
NetworkDisabled:
13121313
description: "Disable networking for the container."
13131314
type: "boolean"
1314-
x-nullable: true
1315+
# x-nullable: true
13151316
MacAddress:
13161317
description: |
13171318
MAC address of the container.
13181319
13191320
Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead.
13201321
type: "string"
1321-
x-nullable: true
1322+
# x-nullable: true
13221323
OnBuild:
13231324
description: |
13241325
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
13251326
type: "array"
1326-
x-nullable: true
1327+
# x-nullable: true
13271328
items:
13281329
type: "string"
13291330
example: []
@@ -1339,18 +1340,19 @@ definitions:
13391340
description: |
13401341
Signal to stop a container as a string or unsigned integer.
13411342
type: "string"
1343+
default: "SIGTERM"
13421344
example: "SIGTERM"
1343-
x-nullable: true
1345+
# x-nullable: true
13441346
StopTimeout:
13451347
description: "Timeout to stop a container in seconds."
13461348
type: "integer"
13471349
default: 10
1348-
x-nullable: true
1350+
# x-nullable: true
13491351
Shell:
13501352
description: |
13511353
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
13521354
type: "array"
1353-
x-nullable: true
1355+
# x-nullable: true
13541356
items:
13551357
type: "string"
13561358
example: ["/bin/sh", "-c"]
@@ -1894,7 +1896,8 @@ definitions:
18941896
Information about the storage driver used to store the container's and
18951897
image's filesystem.
18961898
type: "object"
1897-
required: [Name, Data]
1899+
required: [Name]
1900+
# required: [Name, Data]
18981901
properties:
18991902
Name:
19001903
description: "Name of the storage driver."
@@ -1908,7 +1911,7 @@ definitions:
19081911
This information is driver-specific, and depends on the storage-driver
19091912
in use, and should be used for informational purposes only.
19101913
type: "object"
1911-
x-nullable: false
1914+
# x-nullable: false
19121915
additionalProperties:
19131916
type: "string"
19141917
example: {
@@ -1943,6 +1946,7 @@ definitions:
19431946
type: "integer"
19441947
format: "uint8"
19451948
enum: [0, 1, 2]
1949+
x-enum-varnames: ["T0", "T1", "T2"]
19461950
x-nullable: false
19471951

19481952
ImageInspect:
@@ -2019,7 +2023,7 @@ definitions:
20192023
and omitted otherwise.
20202024
type: "string"
20212025
format: "dateTime"
2022-
x-nullable: true
2026+
x-nullable: false
20232027
example: "2022-02-04T21:20:12.497794809Z"
20242028
Container:
20252029
description: |
@@ -2030,6 +2034,7 @@ definitions:
20302034
**Deprecated**: this field is kept for backward compatibility, but
20312035
will be removed in API v1.45.
20322036
type: "string"
2037+
x-nullable: false
20332038
example: "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735"
20342039
ContainerConfig:
20352040
description: |
@@ -2077,7 +2082,7 @@ definitions:
20772082
for Windows).
20782083
type: "string"
20792084
example: ""
2080-
x-nullable: true
2085+
# x-nullable: true
20812086
Size:
20822087
description: |
20832088
Total size of the image including all layers it is composed of.
@@ -2120,19 +2125,19 @@ definitions:
21202125
type: "string"
21212126
format: "dateTime"
21222127
example: "2022-02-28T14:40:02.623929178Z"
2123-
x-nullable: true
2128+
# x-nullable: true
21242129
ImageSummary:
21252130
type: "object"
21262131
x-go-name: "Summary"
21272132
required:
21282133
- Id
21292134
- ParentId
2130-
- RepoTags
2131-
- RepoDigests
2135+
# - RepoTags
2136+
# - RepoDigests
21322137
- Created
21332138
- Size
21342139
- SharedSize
2135-
- Labels
2140+
# - Labels
21362141
- Containers
21372142
properties:
21382143
Id:
@@ -2167,7 +2172,7 @@ definitions:
21672172
empty if no tags reference the image, in which case the image is
21682173
"untagged", in which case it can still be referenced by its ID.
21692174
type: "array"
2170-
x-nullable: false
2175+
# x-nullable: false
21712176
items:
21722177
type: "string"
21732178
example:
@@ -2185,7 +2190,7 @@ definitions:
21852190
from a registry, or if the image was pushed to a registry, which is when
21862191
the manifest is generated and its digest calculated.
21872192
type: "array"
2188-
x-nullable: false
2193+
# x-nullable: false
21892194
items:
21902195
type: "string"
21912196
example:
@@ -2219,7 +2224,7 @@ definitions:
22192224
Labels:
22202225
description: "User-defined key/value metadata."
22212226
type: "object"
2222-
x-nullable: false
2227+
# x-nullable: false
22232228
additionalProperties:
22242229
type: "string"
22252230
example:
@@ -2274,7 +2279,8 @@ definitions:
22742279

22752280
Volume:
22762281
type: "object"
2277-
required: [Name, Driver, Mountpoint, Labels, Scope, Options]
2282+
required: [Name, Driver, Mountpoint, Options]
2283+
# required: [Name, Driver, Mountpoint, Labels, Scope, Options]
22782284
properties:
22792285
Name:
22802286
type: "string"
@@ -2312,7 +2318,7 @@ definitions:
23122318
Labels:
23132319
type: "object"
23142320
description: "User-defined key/value metadata."
2315-
x-nullable: false
2321+
# x-nullable: false
23162322
additionalProperties:
23172323
type: "string"
23182324
example:
@@ -2324,13 +2330,14 @@ definitions:
23242330
The level at which the volume exists. Either `global` for cluster-wide,
23252331
or `local` for machine level.
23262332
default: "local"
2327-
x-nullable: false
2333+
# x-nullable: false
23282334
enum: ["local", "global"]
23292335
example: "local"
23302336
ClusterVolume:
23312337
$ref: "#/definitions/ClusterVolume"
23322338
Options:
23332339
type: "object"
2340+
x-nullable: true
23342341
description: |
23352342
The driver specific options used when creating the volume.
23362343
additionalProperties:
@@ -3006,6 +3013,7 @@ definitions:
30063013
the plugin.
30073014
type: "object"
30083015
x-go-name: "PluginPrivilege"
3016+
x-nullable: false
30093017
properties:
30103018
Name:
30113019
type: "string"
@@ -5105,7 +5113,7 @@ definitions:
51055113
ContainerState stores container's running state. It's part of ContainerJSONBase
51065114
and will be returned by the "inspect" command.
51075115
type: "object"
5108-
x-nullable: true
5116+
# x-nullable: true
51095117
properties:
51105118
Status:
51115119
description: |
@@ -5164,14 +5172,16 @@ definitions:
51645172
type: "string"
51655173
example: "2020-01-06T09:07:59.461876391Z"
51665174
Health:
5175+
x-nullable: true
51675176
$ref: "#/definitions/Health"
51685177

51695178
ContainerCreateResponse:
51705179
description: "OK response to ContainerCreate operation"
51715180
type: "object"
51725181
title: "ContainerCreateResponse"
51735182
x-go-name: "CreateResponse"
5174-
required: [Id, Warnings]
5183+
required: [Id]
5184+
# required: [Id, Warnings]
51755185
properties:
51765186
Id:
51775187
description: "The ID of the created container"
@@ -5181,7 +5191,7 @@ definitions:
51815191
Warnings:
51825192
description: "Warnings encountered when creating the container"
51835193
type: "array"
5184-
x-nullable: false
5194+
x-nullable: true
51855195
items:
51865196
type: "string"
51875197
example: []
@@ -5192,6 +5202,7 @@ definitions:
51925202
x-go-name: "WaitResponse"
51935203
title: "ContainerWaitResponse"
51945204
required: [StatusCode]
5205+
# required: [StatusCode, Error]
51955206
properties:
51965207
StatusCode:
51975208
description: "Exit code of the container"
@@ -5484,6 +5495,7 @@ definitions:
54845495
The version of the cgroup.
54855496
type: "string"
54865497
enum: ["1", "2"]
5498+
x-enum-varnames: ["V1", "V2"]
54875499
default: "1"
54885500
example: "1"
54895501
NEventsListener:
@@ -6938,6 +6950,7 @@ paths:
69386950
items:
69396951
type: "string"
69406952
State:
6953+
x-nullable: true
69416954
$ref: "#/definitions/ContainerState"
69426955
Image:
69436956
description: "The container's image ID"
@@ -8883,6 +8896,7 @@ paths:
88838896
type: "array"
88848897
items:
88858898
type: "string"
8899+
x-nullable: true
88868900
Size:
88878901
type: "integer"
88888902
format: "int64"
@@ -9911,6 +9925,8 @@ paths:
99119925
responses:
99129926
200:
99139927
description: "No error"
9928+
201:
9929+
description: "No error"
99149930
400:
99159931
description: "bad parameter"
99169932
schema:

api-model-v1-44/docs/ChangeType.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
## Enum
55

66

7-
* `_0` (value: `0`)
7+
* `T0` (value: `0`)
88

9-
* `_1` (value: `1`)
9+
* `T1` (value: `1`)
1010

11-
* `_2` (value: `2`)
11+
* `T2` (value: `2`)
1212

1313

1414

api-model-v1-44/docs/ContainerCreateResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Name | Type | Description | Notes |
66
| ------------ | ------------- | ------------- | ------------- |
77
| **id** | **kotlin.String** | The ID of the created container | |
8-
| **warnings** | **kotlin.collections.MutableList&lt;kotlin.String&gt;** | Warnings encountered when creating the container | |
8+
| **warnings** | **kotlin.collections.MutableList&lt;kotlin.String&gt;** | Warnings encountered when creating the container | [optional] |
99

1010

1111

api-model-v1-44/docs/GraphDriverData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Name | Type | Description | Notes |
66
| ------------ | ------------- | ------------- | ------------- |
77
| **name** | **kotlin.String** | Name of the storage driver. | |
8-
| **&#x60;data&#x60;** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | |
8+
| **&#x60;data&#x60;** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] |
99

1010

1111

api-model-v1-44/docs/ImageSummary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
| ------------ | ------------- | ------------- | ------------- |
77
| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image&#39;s configuration (which includes the digests of layers used by the image). Note that this digest differs from the &#x60;RepoDigests&#x60; below, which holds digests of image manifests that reference the image. | |
88
| **parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | |
9-
| **repoTags** | **kotlin.collections.MutableList&lt;kotlin.String&gt;** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \&quot;untagged\&quot;, in which case it can still be referenced by its ID. | |
10-
| **repoDigests** | **kotlin.collections.MutableList&lt;kotlin.String&gt;** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | |
119
| **created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). | |
1210
| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | |
1311
| **sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. &#x60;-1&#x60; indicates that the value has not been set / calculated. | |
14-
| **labels** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | User-defined key/value metadata. | |
1512
| **containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. &#x60;-1&#x60; indicates that the value has not been set / calculated. | |
13+
| **repoTags** | **kotlin.collections.MutableList&lt;kotlin.String&gt;** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \&quot;untagged\&quot;, in which case it can still be referenced by its ID. | [optional] |
14+
| **repoDigests** | **kotlin.collections.MutableList&lt;kotlin.String&gt;** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] |
15+
| **labels** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | User-defined key/value metadata. | [optional] |
1616

1717

1818

api-model-v1-44/docs/Volume.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
| **name** | **kotlin.String** | Name of the volume. | |
88
| **driver** | **kotlin.String** | Name of the volume driver used by the volume. | |
99
| **mountpoint** | **kotlin.String** | Mount path of the volume on the host. | |
10-
| **labels** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | User-defined key/value metadata. | |
11-
| **scope** | [**inline**](#Scope) | The level at which the volume exists. Either &#x60;global&#x60; for cluster-wide, or &#x60;local&#x60; for machine level. | |
1210
| **options** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | The driver specific options used when creating the volume. | |
1311
| **createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] |
1412
| **status** | [**kotlin.collections.MutableMap&lt;kotlin.String, kotlin.Any&gt;**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: &#x60;{\&quot;key\&quot;:\&quot;value\&quot;,\&quot;key2\&quot;:\&quot;value2\&quot;}&#x60;. The &#x60;Status&#x60; field is optional, and is omitted if the volume driver does not support this feature. | [optional] |
13+
| **labels** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | User-defined key/value metadata. | [optional] |
14+
| **scope** | [**inline**](#Scope) | The level at which the volume exists. Either &#x60;global&#x60; for cluster-wide, or &#x60;local&#x60; for machine level. | [optional] |
1515
| **clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] |
1616
| **usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] |
1717

api-model-v1-44/openapi-generator-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
inputSpec: https://docs.docker.com/engine/api/v1.44/
1+
inputSpec: https://docs.docker.com/reference/api/engine/version/v1.44/
22
additionalProperties:
33
hideGenerationTimestamp: true
44
generatorName: kotlin

0 commit comments

Comments
 (0)