Skip to content

Commit 21835f3

Browse files
committed
Try to not change too many of the optional fields
1 parent 5652c3d commit 21835f3

File tree

10 files changed

+70
-50
lines changed

10 files changed

+70
-50
lines changed

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

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -802,6 +802,7 @@ definitions:
802802
description: |
803803
Health stores information about the container's healthcheck results.
804804
type: "object"
805+
# x-nullable: true
805806
properties:
806807
Status:
807808
description: |
@@ -834,6 +835,7 @@ definitions:
834835
description: |
835836
HealthcheckResult stores information about a single run of a healthcheck probe
836837
type: "object"
838+
# x-nullable: true
837839
properties:
838840
Start:
839841
description: |
@@ -1206,6 +1208,7 @@ definitions:
12061208
12071209
`{"<port>/<tcp|udp|sctp>": {}}`
12081210
type: "object"
1211+
# x-nullable: true
12091212
additionalProperties:
12101213
type: "object"
12111214
enum:
@@ -1250,6 +1253,9 @@ definitions:
12501253
ArgsEscaped:
12511254
description: "Command is already escaped (Windows only)"
12521255
type: "boolean"
1256+
# default: false
1257+
example: false
1258+
# x-nullable: true
12531259
Image:
12541260
description: |
12551261
The name (or reference) of the image to use when creating the container,
@@ -1284,13 +1290,16 @@ definitions:
12841290
NetworkDisabled:
12851291
description: "Disable networking for the container."
12861292
type: "boolean"
1293+
# x-nullable: true
12871294
MacAddress:
12881295
description: "MAC address of the container."
12891296
type: "string"
1297+
# x-nullable: true
12901298
OnBuild:
12911299
description: |
12921300
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
12931301
type: "array"
1302+
# x-nullable: true
12941303
items:
12951304
type: "string"
12961305
example: []
@@ -1307,14 +1316,18 @@ definitions:
13071316
Signal to stop a container as a string or unsigned integer.
13081317
type: "string"
13091318
default: "SIGTERM"
1319+
example: "SIGTERM"
1320+
# x-nullable: true
13101321
StopTimeout:
13111322
description: "Timeout to stop a container in seconds."
13121323
type: "integer"
13131324
default: 10
1325+
# x-nullable: true
13141326
Shell:
13151327
description: |
13161328
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
13171329
type: "array"
1330+
# x-nullable: true
13181331
items:
13191332
type: "string"
13201333
example: ["/bin/sh", "-c"]
@@ -1578,7 +1591,8 @@ definitions:
15781591
Information about the storage driver used to store the container's and
15791592
image's filesystem.
15801593
type: "object"
1581-
required: [Name, Data]
1594+
required: [Name]
1595+
# required: [Name, Data]
15821596
properties:
15831597
Name:
15841598
description: "Name of the storage driver."
@@ -1592,7 +1606,7 @@ definitions:
15921606
This information is driver-specific, and depends on the storage-driver
15931607
in use, and should be used for informational purposes only.
15941608
type: "object"
1595-
x-nullable: true
1609+
# x-nullable: false
15961610
additionalProperties:
15971611
type: "string"
15981612
example: {
@@ -1718,6 +1732,7 @@ definitions:
17181732
for Windows).
17191733
type: "string"
17201734
example: ""
1735+
# x-nullable: true
17211736
Size:
17221737
description: |
17231738
Total size of the image including all layers it is composed of.
@@ -1777,18 +1792,19 @@ definitions:
17771792
type: "string"
17781793
format: "dateTime"
17791794
example: "2022-02-28T14:40:02.623929178Z"
1795+
# x-nullable: true
17801796
ImageSummary:
17811797
type: "object"
17821798
required:
17831799
- Id
17841800
- ParentId
1785-
- RepoTags
1786-
- RepoDigests
1801+
# - RepoTags
1802+
# - RepoDigests
17871803
- Created
17881804
- Size
17891805
- SharedSize
17901806
- VirtualSize
1791-
- Labels
1807+
# - Labels
17921808
- Containers
17931809
properties:
17941810
Id:
@@ -1823,7 +1839,7 @@ definitions:
18231839
empty if no tags reference the image, in which case the image is
18241840
"untagged", in which case it can still be referenced by its ID.
18251841
type: "array"
1826-
x-nullable: true
1842+
# x-nullable: false
18271843
items:
18281844
type: "string"
18291845
example:
@@ -1841,7 +1857,7 @@ definitions:
18411857
from a registry, or if the image was pushed to a registry, which is when
18421858
the manifest is generated and its digest calculated.
18431859
type: "array"
1844-
x-nullable: true
1860+
# x-nullable: false
18451861
items:
18461862
type: "string"
18471863
example:
@@ -1890,7 +1906,7 @@ definitions:
18901906
Labels:
18911907
description: "User-defined key/value metadata."
18921908
type: "object"
1893-
x-nullable: true
1909+
# x-nullable: false
18941910
additionalProperties:
18951911
type: "string"
18961912
example:
@@ -1941,7 +1957,8 @@ definitions:
19411957

19421958
Volume:
19431959
type: "object"
1944-
required: [Name, Driver, Mountpoint, Labels, Scope, Options]
1960+
required: [Name, Driver, Mountpoint, Options]
1961+
# required: [Name, Driver, Mountpoint, Labels, Scope, Options]
19451962
properties:
19461963
Name:
19471964
type: "string"
@@ -1979,7 +1996,7 @@ definitions:
19791996
Labels:
19801997
type: "object"
19811998
description: "User-defined key/value metadata."
1982-
x-nullable: true
1999+
# x-nullable: false
19832000
additionalProperties:
19842001
type: "string"
19852002
example:
@@ -1991,7 +2008,7 @@ definitions:
19912008
The level at which the volume exists. Either `global` for cluster-wide,
19922009
or `local` for machine level.
19932010
default: "local"
1994-
x-nullable: true
2011+
# x-nullable: false
19952012
enum: ["local", "global"]
19962013
example: "local"
19972014
Options:
@@ -4538,6 +4555,7 @@ definitions:
45384555
ContainerState stores container's running state. It's part of ContainerJSONBase
45394556
and will be returned by the "inspect" command.
45404557
type: "object"
4558+
# x-nullable: true
45414559
properties:
45424560
Status:
45434561
description: |
@@ -4603,7 +4621,8 @@ definitions:
46034621
type: "object"
46044622
x-go-name: "ContainerWaitOKBody"
46054623
title: "ContainerWaitResponse"
4606-
required: [StatusCode, Error]
4624+
required: [StatusCode]
4625+
# required: [StatusCode, Error]
46074626
properties:
46084627
StatusCode:
46094628
description: "Exit code of the container"
@@ -6067,7 +6086,8 @@ paths:
60676086
type: "object"
60686087
title: "ContainerCreateResponse"
60696088
description: "OK response to ContainerCreate operation"
6070-
required: [Id, Warnings]
6089+
required: [Id]
6090+
# required: [Id, Warnings]
60716091
properties:
60726092
Id:
60736093
description: "The ID of the created container"

api-model-v1-41/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-41/docs/ContainerWaitResponse.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
**statusCode** | **kotlin.Int** | Exit code of the container |
8-
**error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | |
8+
**error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional]
99

1010

1111

api-model-v1-41/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-41/docs/ImageSummary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Name | Type | Description | Notes
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 imagem 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 sinds 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. |
1412
**virtualSize** | **kotlin.Long** | Total size of the image including all layers it is composed of. In versions of Docker before v1.10, this field was calculated from the image itself and all of its parent images. Docker v1.10 and up store images self-contained, and no longer use a parent-chain, making this field an equivalent of the Size field. This field is kept for backward compatibility, but may be removed in a future version of the API. |
15-
**labels** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | User-defined key/value metadata. |
1613
**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. |
14+
**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]
15+
**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]
16+
**labels** | **kotlin.collections.MutableMap&lt;kotlin.String, kotlin.String&gt;** | User-defined key/value metadata. | [optional]
1717

1818

1919

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
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
**usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional]
1616

1717

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ data class ContainerCreateResponse(
3838

3939
/* Warnings encountered when creating the container */
4040
@Json(name = "Warnings")
41-
var warnings: kotlin.collections.MutableList<kotlin.String>?
41+
var warnings: kotlin.collections.MutableList<kotlin.String>? = null
4242

4343
)

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ data class GraphDriverData(
3838

3939
/* 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. */
4040
@Json(name = "Data")
41-
var `data`: kotlin.collections.MutableMap<kotlin.String, kotlin.String>?
41+
var `data`: kotlin.collections.MutableMap<kotlin.String, kotlin.String>? = null
4242

4343
)

0 commit comments

Comments
 (0)