From 9f500ca04c217a5f60513dd7012db2c806777ebb Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Sun, 3 Oct 2021 17:43:42 +0200 Subject: [PATCH] apply improvements from the upstream moby project relates to https://github.com/docker-client/docker-engine/issues/62 --- api-model/.openapi-generator/FILES | 62 +- api-model/README.md | 31 +- api-model/docker-engine-api-v1.41.yaml | 544 ++++++++++-------- api-model/docs/ContainerApi.md | 8 +- api-model/docs/ContainerSummary.md | 24 + api-model/docs/ContainerSummaryHostConfig.md | 10 + .../docs/ContainerSummaryNetworkSettings.md | 10 + api-model/docs/ContainerWaitResponse.md | 2 +- api-model/docs/DistributionApi.md | 6 +- api-model/docs/DistributionInspect.md | 11 + api-model/docs/EventActor.md | 11 + api-model/docs/EventMessage.md | 29 + api-model/docs/ExecApi.md | 8 +- api-model/docs/ExecConfig.md | 19 + api-model/docs/ExecStartConfig.md | 11 + api-model/docs/ImageApi.md | 12 +- api-model/docs/NetworkApi.md | 12 +- api-model/docs/NetworkConnectRequest.md | 11 + api-model/docs/NetworkCreateRequest.md | 19 + api-model/docs/NetworkDisconnectRequest.md | 11 + api-model/docs/NetworkSettings.md | 2 +- api-model/docs/OCIDescriptor.md | 12 + api-model/docs/OCIPlatform.md | 14 + api-model/docs/PluginApi.md | 14 +- api-model/docs/PluginPrivilege.md | 12 + api-model/docs/RestartPolicy.md | 4 +- api-model/docs/SwarmApi.md | 12 +- api-model/docs/SwarmInitRequest.md | 17 + api-model/docs/SwarmJoinRequest.md | 14 + api-model/docs/SwarmUnlockRequest.md | 10 + api-model/docs/SystemApi.md | 6 +- api-model/docs/SystemDataUsageResponse.md | 2 +- api-model/docs/SystemInfo.md | 2 +- api-model/docs/TaskSpecPluginSpec.md | 2 +- .../docker/engine/model/ContainerSummary.kt | 79 +++ ...bject.kt => ContainerSummaryHostConfig.kt} | 16 +- .../model/ContainerSummaryNetworkSettings.kt | 25 + .../engine/model/ContainerWaitResponse.kt | 2 +- ...pectResponse.kt => DistributionInspect.kt} | 8 +- ...emEventsResponseActor.kt => EventActor.kt} | 8 +- ...ystemEventsResponse.kt => EventMessage.kt} | 43 +- .../docker/engine/model/ExecConfig.kt | 62 ++ .../{InlineObject1.kt => ExecStartConfig.kt} | 2 +- .../engine/model/HistoryResponseItem.kt | 2 +- .../docker/engine/model/ImageSummary.kt | 6 +- ...ineObject3.kt => NetworkConnectRequest.kt} | 2 +- ...lineObject2.kt => NetworkCreateRequest.kt} | 2 +- ...Object4.kt => NetworkDisconnectRequest.kt} | 2 +- .../docker/engine/model/NetworkSettings.kt | 4 +- ...ResponseDescriptor.kt => OCIDescriptor.kt} | 24 +- ...ectResponsePlatforms.kt => OCIPlatform.kt} | 36 +- ...ginPrivilegeItem.kt => PluginPrivilege.kt} | 2 +- .../docker/engine/model/RestartPolicy.kt | 9 +- .../{InlineObject5.kt => SwarmInitRequest.kt} | 2 +- .../{InlineObject6.kt => SwarmJoinRequest.kt} | 6 +- ...InlineObject7.kt => SwarmUnlockRequest.kt} | 2 +- .../engine/model/SystemDataUsageResponse.kt | 2 +- .../docker/engine/model/SystemInfo.kt | 4 +- .../docker/engine/model/TaskSpecPluginSpec.kt | 2 +- .../de/gesellix/docker/engine/model/Volume.kt | 6 +- .../docker/engine/model/VolumeListResponse.kt | 2 +- 61 files changed, 928 insertions(+), 406 deletions(-) create mode 100644 api-model/docs/ContainerSummary.md create mode 100644 api-model/docs/ContainerSummaryHostConfig.md create mode 100644 api-model/docs/ContainerSummaryNetworkSettings.md create mode 100644 api-model/docs/DistributionInspect.md create mode 100644 api-model/docs/EventActor.md create mode 100644 api-model/docs/EventMessage.md create mode 100644 api-model/docs/ExecConfig.md create mode 100644 api-model/docs/ExecStartConfig.md create mode 100644 api-model/docs/NetworkConnectRequest.md create mode 100644 api-model/docs/NetworkCreateRequest.md create mode 100644 api-model/docs/NetworkDisconnectRequest.md create mode 100644 api-model/docs/OCIDescriptor.md create mode 100644 api-model/docs/OCIPlatform.md create mode 100644 api-model/docs/PluginPrivilege.md create mode 100644 api-model/docs/SwarmInitRequest.md create mode 100644 api-model/docs/SwarmJoinRequest.md create mode 100644 api-model/docs/SwarmUnlockRequest.md create mode 100644 api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummary.kt rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject.kt => ContainerSummaryHostConfig.kt} (88%) create mode 100644 api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryNetworkSettings.kt rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{DistributionInspectResponse.kt => DistributionInspect.kt} (93%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{SystemEventsResponseActor.kt => EventActor.kt} (95%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{SystemEventsResponse.kt => EventMessage.kt} (70%) create mode 100644 api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecConfig.kt rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject1.kt => ExecStartConfig.kt} (99%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject3.kt => NetworkConnectRequest.kt} (98%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject2.kt => NetworkCreateRequest.kt} (99%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject4.kt => NetworkDisconnectRequest.kt} (98%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{DistributionInspectResponseDescriptor.kt => OCIDescriptor.kt} (82%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{DistributionInspectResponsePlatforms.kt => OCIPlatform.kt} (68%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{PluginPrivilegeItem.kt => PluginPrivilege.kt} (99%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject5.kt => SwarmInitRequest.kt} (99%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject6.kt => SwarmJoinRequest.kt} (87%) rename api-model/src/main/kotlin/de/gesellix/docker/engine/model/{InlineObject7.kt => SwarmUnlockRequest.kt} (98%) diff --git a/api-model/.openapi-generator/FILES b/api-model/.openapi-generator/FILES index 6f5e8bc7..d2875545 100644 --- a/api-model/.openapi-generator/FILES +++ b/api-model/.openapi-generator/FILES @@ -17,6 +17,9 @@ docs/ContainerCreateResponse.md docs/ContainerInspectResponse.md docs/ContainerPruneResponse.md docs/ContainerState.md +docs/ContainerSummary.md +docs/ContainerSummaryHostConfig.md +docs/ContainerSummaryNetworkSettings.md docs/ContainerTopResponse.md docs/ContainerUpdateResponse.md docs/ContainerWaitResponse.md @@ -25,9 +28,7 @@ docs/CreateImageInfo.md docs/DeviceMapping.md docs/DeviceRequest.md docs/DistributionApi.md -docs/DistributionInspectResponse.md -docs/DistributionInspectResponseDescriptor.md -docs/DistributionInspectResponsePlatforms.md +docs/DistributionInspect.md docs/Driver.md docs/EndpointIPAMConfig.md docs/EndpointPortConfig.md @@ -37,8 +38,12 @@ docs/EngineDescription.md docs/EngineDescriptionPlugins.md docs/ErrorDetail.md docs/ErrorResponse.md +docs/EventActor.md +docs/EventMessage.md docs/ExecApi.md +docs/ExecConfig.md docs/ExecInspectResponse.md +docs/ExecStartConfig.md docs/GraphDriverData.md docs/Health.md docs/HealthConfig.md @@ -59,14 +64,6 @@ docs/ImageRootFS.md docs/ImageSearchResponseItem.md docs/ImageSummary.md docs/IndexInfo.md -docs/InlineObject.md -docs/InlineObject1.md -docs/InlineObject2.md -docs/InlineObject3.md -docs/InlineObject4.md -docs/InlineObject5.md -docs/InlineObject6.md -docs/InlineObject7.md docs/InlineResponse400.md docs/JoinTokens.md docs/Limit.md @@ -81,8 +78,11 @@ docs/MountVolumeOptionsDriverConfig.md docs/Network.md docs/NetworkApi.md docs/NetworkAttachmentConfig.md +docs/NetworkConnectRequest.md docs/NetworkContainer.md +docs/NetworkCreateRequest.md docs/NetworkCreateResponse.md +docs/NetworkDisconnectRequest.md docs/NetworkPruneResponse.md docs/NetworkSettings.md docs/NetworkingConfig.md @@ -92,6 +92,8 @@ docs/NodeDescription.md docs/NodeSpec.md docs/NodeState.md docs/NodeStatus.md +docs/OCIDescriptor.md +docs/OCIPlatform.md docs/ObjectVersion.md docs/PeerNode.md docs/Platform.md @@ -108,7 +110,7 @@ docs/PluginDevice.md docs/PluginEnv.md docs/PluginInterfaceType.md docs/PluginMount.md -docs/PluginPrivilegeItem.md +docs/PluginPrivilege.md docs/PluginSettings.md docs/PluginsInfo.md docs/Port.md @@ -147,6 +149,8 @@ docs/Swarm.md docs/SwarmAllOf.md docs/SwarmApi.md docs/SwarmInfo.md +docs/SwarmInitRequest.md +docs/SwarmJoinRequest.md docs/SwarmSpec.md docs/SwarmSpecCAConfig.md docs/SwarmSpecCAConfigExternalCAs.md @@ -156,11 +160,10 @@ docs/SwarmSpecOrchestration.md docs/SwarmSpecRaft.md docs/SwarmSpecTaskDefaults.md docs/SwarmSpecTaskDefaultsLogDriver.md +docs/SwarmUnlockRequest.md docs/SystemApi.md docs/SystemAuthResponse.md docs/SystemDataUsageResponse.md -docs/SystemEventsResponse.md -docs/SystemEventsResponseActor.md docs/SystemInfo.md docs/SystemInfoDefaultAddressPools.md docs/SystemVersion.md @@ -249,6 +252,9 @@ src/main/kotlin/de/gesellix/docker/engine/model/ContainerCreateResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/ContainerInspectResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/ContainerPruneResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/ContainerState.kt +src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummary.kt +src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryHostConfig.kt +src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryNetworkSettings.kt src/main/kotlin/de/gesellix/docker/engine/model/ContainerTopResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/ContainerUpdateResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponse.kt @@ -256,9 +262,7 @@ src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponseError.kt src/main/kotlin/de/gesellix/docker/engine/model/CreateImageInfo.kt src/main/kotlin/de/gesellix/docker/engine/model/DeviceMapping.kt src/main/kotlin/de/gesellix/docker/engine/model/DeviceRequest.kt -src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponse.kt -src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponseDescriptor.kt -src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponsePlatforms.kt +src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspect.kt src/main/kotlin/de/gesellix/docker/engine/model/Driver.kt src/main/kotlin/de/gesellix/docker/engine/model/EndpointIPAMConfig.kt src/main/kotlin/de/gesellix/docker/engine/model/EndpointPortConfig.kt @@ -268,7 +272,11 @@ src/main/kotlin/de/gesellix/docker/engine/model/EngineDescription.kt src/main/kotlin/de/gesellix/docker/engine/model/EngineDescriptionPlugins.kt src/main/kotlin/de/gesellix/docker/engine/model/ErrorDetail.kt src/main/kotlin/de/gesellix/docker/engine/model/ErrorResponse.kt +src/main/kotlin/de/gesellix/docker/engine/model/EventActor.kt +src/main/kotlin/de/gesellix/docker/engine/model/EventMessage.kt +src/main/kotlin/de/gesellix/docker/engine/model/ExecConfig.kt src/main/kotlin/de/gesellix/docker/engine/model/ExecInspectResponse.kt +src/main/kotlin/de/gesellix/docker/engine/model/ExecStartConfig.kt src/main/kotlin/de/gesellix/docker/engine/model/GraphDriverData.kt src/main/kotlin/de/gesellix/docker/engine/model/Health.kt src/main/kotlin/de/gesellix/docker/engine/model/HealthConfig.kt @@ -288,14 +296,6 @@ src/main/kotlin/de/gesellix/docker/engine/model/ImageRootFS.kt src/main/kotlin/de/gesellix/docker/engine/model/ImageSearchResponseItem.kt src/main/kotlin/de/gesellix/docker/engine/model/ImageSummary.kt src/main/kotlin/de/gesellix/docker/engine/model/IndexInfo.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject1.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject2.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject3.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject4.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject5.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject6.kt -src/main/kotlin/de/gesellix/docker/engine/model/InlineObject7.kt src/main/kotlin/de/gesellix/docker/engine/model/InlineResponse400.kt src/main/kotlin/de/gesellix/docker/engine/model/JoinTokens.kt src/main/kotlin/de/gesellix/docker/engine/model/Limit.kt @@ -309,8 +309,11 @@ src/main/kotlin/de/gesellix/docker/engine/model/MountVolumeOptions.kt src/main/kotlin/de/gesellix/docker/engine/model/MountVolumeOptionsDriverConfig.kt src/main/kotlin/de/gesellix/docker/engine/model/Network.kt src/main/kotlin/de/gesellix/docker/engine/model/NetworkAttachmentConfig.kt +src/main/kotlin/de/gesellix/docker/engine/model/NetworkConnectRequest.kt src/main/kotlin/de/gesellix/docker/engine/model/NetworkContainer.kt +src/main/kotlin/de/gesellix/docker/engine/model/NetworkCreateRequest.kt src/main/kotlin/de/gesellix/docker/engine/model/NetworkCreateResponse.kt +src/main/kotlin/de/gesellix/docker/engine/model/NetworkDisconnectRequest.kt src/main/kotlin/de/gesellix/docker/engine/model/NetworkPruneResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/NetworkSettings.kt src/main/kotlin/de/gesellix/docker/engine/model/NetworkingConfig.kt @@ -319,6 +322,8 @@ src/main/kotlin/de/gesellix/docker/engine/model/NodeDescription.kt src/main/kotlin/de/gesellix/docker/engine/model/NodeSpec.kt src/main/kotlin/de/gesellix/docker/engine/model/NodeState.kt src/main/kotlin/de/gesellix/docker/engine/model/NodeStatus.kt +src/main/kotlin/de/gesellix/docker/engine/model/OCIDescriptor.kt +src/main/kotlin/de/gesellix/docker/engine/model/OCIPlatform.kt src/main/kotlin/de/gesellix/docker/engine/model/ObjectVersion.kt src/main/kotlin/de/gesellix/docker/engine/model/PeerNode.kt src/main/kotlin/de/gesellix/docker/engine/model/Platform.kt @@ -334,7 +339,7 @@ src/main/kotlin/de/gesellix/docker/engine/model/PluginDevice.kt src/main/kotlin/de/gesellix/docker/engine/model/PluginEnv.kt src/main/kotlin/de/gesellix/docker/engine/model/PluginInterfaceType.kt src/main/kotlin/de/gesellix/docker/engine/model/PluginMount.kt -src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilegeItem.kt +src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilege.kt src/main/kotlin/de/gesellix/docker/engine/model/PluginSettings.kt src/main/kotlin/de/gesellix/docker/engine/model/PluginsInfo.kt src/main/kotlin/de/gesellix/docker/engine/model/Port.kt @@ -369,6 +374,8 @@ src/main/kotlin/de/gesellix/docker/engine/model/ServiceUpdateStatus.kt src/main/kotlin/de/gesellix/docker/engine/model/Swarm.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmAllOf.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmInfo.kt +src/main/kotlin/de/gesellix/docker/engine/model/SwarmInitRequest.kt +src/main/kotlin/de/gesellix/docker/engine/model/SwarmJoinRequest.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpec.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpecCAConfig.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpecCAConfigExternalCAs.kt @@ -378,10 +385,9 @@ src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpecOrchestration.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpecRaft.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpecTaskDefaults.kt src/main/kotlin/de/gesellix/docker/engine/model/SwarmSpecTaskDefaultsLogDriver.kt +src/main/kotlin/de/gesellix/docker/engine/model/SwarmUnlockRequest.kt src/main/kotlin/de/gesellix/docker/engine/model/SystemAuthResponse.kt src/main/kotlin/de/gesellix/docker/engine/model/SystemDataUsageResponse.kt -src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponse.kt -src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponseActor.kt src/main/kotlin/de/gesellix/docker/engine/model/SystemInfo.kt src/main/kotlin/de/gesellix/docker/engine/model/SystemInfoDefaultAddressPools.kt src/main/kotlin/de/gesellix/docker/engine/model/SystemVersion.kt diff --git a/api-model/README.md b/api-model/README.md index 502a3c25..09b934ed 100644 --- a/api-model/README.md +++ b/api-model/README.md @@ -163,6 +163,9 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.ContainerInspectResponse](docs/ContainerInspectResponse.md) - [de.gesellix.docker.engine.model.ContainerPruneResponse](docs/ContainerPruneResponse.md) - [de.gesellix.docker.engine.model.ContainerState](docs/ContainerState.md) + - [de.gesellix.docker.engine.model.ContainerSummary](docs/ContainerSummary.md) + - [de.gesellix.docker.engine.model.ContainerSummaryHostConfig](docs/ContainerSummaryHostConfig.md) + - [de.gesellix.docker.engine.model.ContainerSummaryNetworkSettings](docs/ContainerSummaryNetworkSettings.md) - [de.gesellix.docker.engine.model.ContainerTopResponse](docs/ContainerTopResponse.md) - [de.gesellix.docker.engine.model.ContainerUpdateResponse](docs/ContainerUpdateResponse.md) - [de.gesellix.docker.engine.model.ContainerWaitResponse](docs/ContainerWaitResponse.md) @@ -170,9 +173,7 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.CreateImageInfo](docs/CreateImageInfo.md) - [de.gesellix.docker.engine.model.DeviceMapping](docs/DeviceMapping.md) - [de.gesellix.docker.engine.model.DeviceRequest](docs/DeviceRequest.md) - - [de.gesellix.docker.engine.model.DistributionInspectResponse](docs/DistributionInspectResponse.md) - - [de.gesellix.docker.engine.model.DistributionInspectResponseDescriptor](docs/DistributionInspectResponseDescriptor.md) - - [de.gesellix.docker.engine.model.DistributionInspectResponsePlatforms](docs/DistributionInspectResponsePlatforms.md) + - [de.gesellix.docker.engine.model.DistributionInspect](docs/DistributionInspect.md) - [de.gesellix.docker.engine.model.Driver](docs/Driver.md) - [de.gesellix.docker.engine.model.EndpointIPAMConfig](docs/EndpointIPAMConfig.md) - [de.gesellix.docker.engine.model.EndpointPortConfig](docs/EndpointPortConfig.md) @@ -182,7 +183,11 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.EngineDescriptionPlugins](docs/EngineDescriptionPlugins.md) - [de.gesellix.docker.engine.model.ErrorDetail](docs/ErrorDetail.md) - [de.gesellix.docker.engine.model.ErrorResponse](docs/ErrorResponse.md) + - [de.gesellix.docker.engine.model.EventActor](docs/EventActor.md) + - [de.gesellix.docker.engine.model.EventMessage](docs/EventMessage.md) + - [de.gesellix.docker.engine.model.ExecConfig](docs/ExecConfig.md) - [de.gesellix.docker.engine.model.ExecInspectResponse](docs/ExecInspectResponse.md) + - [de.gesellix.docker.engine.model.ExecStartConfig](docs/ExecStartConfig.md) - [de.gesellix.docker.engine.model.GraphDriverData](docs/GraphDriverData.md) - [de.gesellix.docker.engine.model.Health](docs/Health.md) - [de.gesellix.docker.engine.model.HealthConfig](docs/HealthConfig.md) @@ -202,14 +207,6 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.ImageSearchResponseItem](docs/ImageSearchResponseItem.md) - [de.gesellix.docker.engine.model.ImageSummary](docs/ImageSummary.md) - [de.gesellix.docker.engine.model.IndexInfo](docs/IndexInfo.md) - - [de.gesellix.docker.engine.model.InlineObject](docs/InlineObject.md) - - [de.gesellix.docker.engine.model.InlineObject1](docs/InlineObject1.md) - - [de.gesellix.docker.engine.model.InlineObject2](docs/InlineObject2.md) - - [de.gesellix.docker.engine.model.InlineObject3](docs/InlineObject3.md) - - [de.gesellix.docker.engine.model.InlineObject4](docs/InlineObject4.md) - - [de.gesellix.docker.engine.model.InlineObject5](docs/InlineObject5.md) - - [de.gesellix.docker.engine.model.InlineObject6](docs/InlineObject6.md) - - [de.gesellix.docker.engine.model.InlineObject7](docs/InlineObject7.md) - [de.gesellix.docker.engine.model.InlineResponse400](docs/InlineResponse400.md) - [de.gesellix.docker.engine.model.JoinTokens](docs/JoinTokens.md) - [de.gesellix.docker.engine.model.Limit](docs/Limit.md) @@ -223,8 +220,11 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.MountVolumeOptionsDriverConfig](docs/MountVolumeOptionsDriverConfig.md) - [de.gesellix.docker.engine.model.Network](docs/Network.md) - [de.gesellix.docker.engine.model.NetworkAttachmentConfig](docs/NetworkAttachmentConfig.md) + - [de.gesellix.docker.engine.model.NetworkConnectRequest](docs/NetworkConnectRequest.md) - [de.gesellix.docker.engine.model.NetworkContainer](docs/NetworkContainer.md) + - [de.gesellix.docker.engine.model.NetworkCreateRequest](docs/NetworkCreateRequest.md) - [de.gesellix.docker.engine.model.NetworkCreateResponse](docs/NetworkCreateResponse.md) + - [de.gesellix.docker.engine.model.NetworkDisconnectRequest](docs/NetworkDisconnectRequest.md) - [de.gesellix.docker.engine.model.NetworkPruneResponse](docs/NetworkPruneResponse.md) - [de.gesellix.docker.engine.model.NetworkSettings](docs/NetworkSettings.md) - [de.gesellix.docker.engine.model.NetworkingConfig](docs/NetworkingConfig.md) @@ -233,6 +233,8 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.NodeSpec](docs/NodeSpec.md) - [de.gesellix.docker.engine.model.NodeState](docs/NodeState.md) - [de.gesellix.docker.engine.model.NodeStatus](docs/NodeStatus.md) + - [de.gesellix.docker.engine.model.OCIDescriptor](docs/OCIDescriptor.md) + - [de.gesellix.docker.engine.model.OCIPlatform](docs/OCIPlatform.md) - [de.gesellix.docker.engine.model.ObjectVersion](docs/ObjectVersion.md) - [de.gesellix.docker.engine.model.PeerNode](docs/PeerNode.md) - [de.gesellix.docker.engine.model.Platform](docs/Platform.md) @@ -248,7 +250,7 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.PluginEnv](docs/PluginEnv.md) - [de.gesellix.docker.engine.model.PluginInterfaceType](docs/PluginInterfaceType.md) - [de.gesellix.docker.engine.model.PluginMount](docs/PluginMount.md) - - [de.gesellix.docker.engine.model.PluginPrivilegeItem](docs/PluginPrivilegeItem.md) + - [de.gesellix.docker.engine.model.PluginPrivilege](docs/PluginPrivilege.md) - [de.gesellix.docker.engine.model.PluginSettings](docs/PluginSettings.md) - [de.gesellix.docker.engine.model.PluginsInfo](docs/PluginsInfo.md) - [de.gesellix.docker.engine.model.Port](docs/Port.md) @@ -283,6 +285,8 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.Swarm](docs/Swarm.md) - [de.gesellix.docker.engine.model.SwarmAllOf](docs/SwarmAllOf.md) - [de.gesellix.docker.engine.model.SwarmInfo](docs/SwarmInfo.md) + - [de.gesellix.docker.engine.model.SwarmInitRequest](docs/SwarmInitRequest.md) + - [de.gesellix.docker.engine.model.SwarmJoinRequest](docs/SwarmJoinRequest.md) - [de.gesellix.docker.engine.model.SwarmSpec](docs/SwarmSpec.md) - [de.gesellix.docker.engine.model.SwarmSpecCAConfig](docs/SwarmSpecCAConfig.md) - [de.gesellix.docker.engine.model.SwarmSpecCAConfigExternalCAs](docs/SwarmSpecCAConfigExternalCAs.md) @@ -292,10 +296,9 @@ Class | Method | HTTP request | Description - [de.gesellix.docker.engine.model.SwarmSpecRaft](docs/SwarmSpecRaft.md) - [de.gesellix.docker.engine.model.SwarmSpecTaskDefaults](docs/SwarmSpecTaskDefaults.md) - [de.gesellix.docker.engine.model.SwarmSpecTaskDefaultsLogDriver](docs/SwarmSpecTaskDefaultsLogDriver.md) + - [de.gesellix.docker.engine.model.SwarmUnlockRequest](docs/SwarmUnlockRequest.md) - [de.gesellix.docker.engine.model.SystemAuthResponse](docs/SystemAuthResponse.md) - [de.gesellix.docker.engine.model.SystemDataUsageResponse](docs/SystemDataUsageResponse.md) - - [de.gesellix.docker.engine.model.SystemEventsResponse](docs/SystemEventsResponse.md) - - [de.gesellix.docker.engine.model.SystemEventsResponseActor](docs/SystemEventsResponseActor.md) - [de.gesellix.docker.engine.model.SystemInfo](docs/SystemInfo.md) - [de.gesellix.docker.engine.model.SystemInfoDefaultAddressPools](docs/SystemInfoDefaultAddressPools.md) - [de.gesellix.docker.engine.model.SystemVersion](docs/SystemVersion.md) diff --git a/api-model/docker-engine-api-v1.41.yaml b/api-model/docker-engine-api-v1.41.yaml index 32f0520d..f5f4268d 100644 --- a/api-model/docker-engine-api-v1.41.yaml +++ b/api-model/docker-engine-api-v1.41.yaml @@ -24,7 +24,7 @@ info: title: "Docker Engine API" version: "1.41" x-logo: - url: "/images/logo-docker-main.png" + url: "https://docs.docker.com/images/logo-docker-main.png" description: | The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker @@ -117,7 +117,7 @@ tags: x-displayName: "Networks" description: | Networks are user-defined networks that containers can be attached to. - See the [networking documentation](/network/) + See the [networking documentation](https://docs.docker.com/network/) for more information. - name: "Volume" x-displayName: "Volumes" @@ -127,7 +127,7 @@ tags: x-displayName: "Exec" description: | Run new commands inside running containers. Refer to the - [command-line reference](/engine/reference/commandline/exec/) + [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/) for more information. To exec a command in a container, you first need to create an exec instance, @@ -139,7 +139,7 @@ tags: x-displayName: "Swarm" description: | Engines can be clustered together in a swarm. Refer to the - [swarm mode documentation](/engine/swarm/) + [swarm mode documentation](https://docs.docker.com/engine/swarm/) for more information. - name: "Node" x-displayName: "Nodes" @@ -382,11 +382,13 @@ definitions: type: "string" description: | - Empty string means not to restart + - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero enum: - "" + - "no" - "always" - "unless-stopped" - "on-failure" @@ -1274,7 +1276,7 @@ definitions: type: "object" properties: Bridge: - description: Name of the network'a bridge (for example, `docker0`). + description: Name of the network's bridge (for example, `docker0`). type: "string" example: "docker0" SandboxID: @@ -1611,12 +1613,12 @@ definitions: x-nullable: false RepoTags: type: "array" - x-nullable: false + x-nullable: true items: type: "string" RepoDigests: type: "array" - x-nullable: false + x-nullable: true items: type: "string" Created: @@ -1633,7 +1635,7 @@ definitions: x-nullable: false Labels: type: "object" - x-nullable: false + x-nullable: true additionalProperties: type: "string" Containers: @@ -1706,7 +1708,7 @@ definitions: Labels: type: "object" description: "User-defined key/value metadata." - x-nullable: false + x-nullable: true additionalProperties: type: "string" Scope: @@ -1715,10 +1717,11 @@ definitions: The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. default: "local" - x-nullable: false + x-nullable: true enum: ["local", "global"] Options: type: "object" + x-nullable: true description: | The driver specific options used when creating the volume. additionalProperties: @@ -2188,6 +2191,26 @@ definitions: type: "string" x-nullable: false + PluginPrivilege: + description: | + Describes a permission the user has to accept upon installing + the plugin. + type: "object" + x-go-name: "PluginPrivilege" + x-nullable: false + properties: + Name: + type: "string" + example: "network" + Description: + type: "string" + Value: + type: "array" + items: + type: "string" + example: + - "host" + Plugin: description: "A plugin for the Engine API" type: "object" @@ -2267,7 +2290,7 @@ definitions: Documentation: type: "string" x-nullable: false - example: "/engine/extend/plugins/" + example: "https://docs.docker.com/engine/extend/plugins/" Interface: description: "The interface between Docker and the plugin" x-nullable: false @@ -2970,19 +2993,7 @@ definitions: PluginPrivilege: type: "array" items: - description: | - Describes a permission accepted by the user upon installing the - plugin. - type: "object" - properties: - Name: - type: "string" - Description: - type: "string" - Value: - type: "array" - items: - type: "string" + $ref: "#/definitions/PluginPrivilege" ContainerSpec: type: "object" description: | @@ -4022,73 +4033,71 @@ definitions: Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" ContainerSummary: - type: "array" - items: - type: "object" - properties: - Id: - description: "The ID of this container" - type: "string" - x-go-name: "ID" - Names: - description: "The names that this container has been given" - type: "array" - items: - type: "string" - Image: - description: "The name of the image used when creating this container" - type: "string" - ImageID: - description: "The ID of the image that this container was created from" + type: "object" + properties: + Id: + description: "The ID of this container" + type: "string" + x-go-name: "ID" + Names: + description: "The names that this container has been given" + type: "array" + items: type: "string" - Command: - description: "Command to run when starting the container" + Image: + description: "The name of the image used when creating this container" + type: "string" + ImageID: + description: "The ID of the image that this container was created from" + type: "string" + Command: + description: "Command to run when starting the container" + type: "string" + Created: + description: "When the container was created" + type: "integer" + format: "int64" + Ports: + description: "The ports exposed by this container" + type: "array" + items: + $ref: "#/definitions/Port" + SizeRw: + description: "The size of files that have been created or changed by this container" + type: "integer" + format: "int64" + SizeRootFs: + description: "The total size of all the files in this container" + type: "integer" + format: "int64" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: type: "string" - Created: - description: "When the container was created" - type: "integer" - format: "int64" - Ports: - description: "The ports exposed by this container" - type: "array" - items: - $ref: "#/definitions/Port" - SizeRw: - description: "The size of files that have been created or changed by this container" - type: "integer" - format: "int64" - SizeRootFs: - description: "The total size of all the files in this container" - type: "integer" - format: "int64" - Labels: - description: "User-defined key/value metadata." - type: "object" - additionalProperties: + State: + description: "The state of this container (e.g. `Exited`)" + type: "string" + Status: + description: "Additional human-readable status of this container (e.g. `Exit 0`)" + type: "string" + HostConfig: + type: "object" + properties: + NetworkMode: type: "string" - State: - description: "The state of this container (e.g. `Exited`)" - type: "string" - Status: - description: "Additional human-readable status of this container (e.g. `Exit 0`)" - type: "string" - HostConfig: - type: "object" - properties: - NetworkMode: - type: "string" - NetworkSettings: - description: "A summary of the container's network settings" - type: "object" - properties: - Networks: - type: "object" - additionalProperties: - $ref: "#/definitions/EndpointSettings" - Mounts: - type: "array" - items: - $ref: "#/definitions/Mount" + NetworkSettings: + description: "A summary of the container's network settings" + type: "object" + properties: + Networks: + type: "object" + additionalProperties: + $ref: "#/definitions/EndpointSettings" + Mounts: + type: "array" + items: + $ref: "#/definitions/Mount" Driver: description: "Driver represents a driver (network, logging, secrets)." @@ -4366,7 +4375,6 @@ definitions: type: "string" example: "2020-06-22T15:49:27.000000000+00:00" - SystemInfo: type: "object" properties: @@ -4679,7 +4687,7 @@ definitions: description: | Version string of the daemon. - > **Note**: the [standalone Swarm API](/swarm/swarm-api/) + > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. type: "string" @@ -5199,6 +5207,158 @@ definitions: additionalProperties: type: "string" + EventActor: + description: | + Actor describes something that generates events, like a container, network, + or a volume. + type: "object" + properties: + ID: + description: "The ID of the object emitting the event" + type: "string" + example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743" + Attributes: + description: | + Various key/value attributes of the object, depending on its type. + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-label-value" + image: "alpine:latest" + name: "my-container" + + EventMessage: + description: | + EventMessage represents the information an event contains. + type: "object" + title: "SystemEventsResponse" + properties: + Type: + description: "The type of object emitting the event" + type: "string" + enum: ["builder", "config", "container", "daemon", "image", "network", "node", "plugin", "secret", "service", "volume"] + example: "container" + Action: + description: "The type of event" + type: "string" + example: "create" + Actor: + $ref: "#/definitions/EventActor" + scope: + description: | + Scope of the event. Engine events are `local` scope. Cluster (Swarm) + events are `swarm` scope. + type: "string" + enum: ["local", "swarm"] + time: + description: "Timestamp of event" + type: "integer" + format: "int64" + example: 1629574695 + timeNano: + description: "Timestamp of event, with nanosecond accuracy" + type: "integer" + format: "int64" + example: 1629574695515050031 + + OCIDescriptor: + type: "object" + x-go-name: Descriptor + description: | + A descriptor struct containing digest, media type, and size, as defined in + the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md). + properties: + mediaType: + description: | + The media type of the object this schema refers to. + type: "string" + example: "application/vnd.docker.distribution.manifest.v2+json" + digest: + description: | + The digest of the targeted content. + type: "string" + example: "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96" + size: + description: | + The size in bytes of the blob. + type: "integer" + format: "int64" + example: 3987495 + # TODO Not yet including these fields for now, as they are nil / omitted in our response. + # urls: + # description: | + # List of URLs from which this object MAY be downloaded. + # type: "array" + # items: + # type: "string" + # format: "uri" + # annotations: + # description: | + # Arbitrary metadata relating to the targeted content. + # type: "object" + # additionalProperties: + # type: "string" + # platform: + # $ref: "#/definitions/OCIPlatform" + + OCIPlatform: + type: "object" + x-go-name: Platform + description: | + Describes the platform which the image in the manifest runs on, as defined + in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md). + properties: + architecture: + description: | + The CPU architecture, for example `amd64` or `ppc64`. + type: "string" + example: "arm" + os: + description: | + The operating system, for example `linux` or `windows`. + type: "string" + example: "windows" + os.version: + description: | + Optional field specifying the operating system version, for example on + Windows `10.0.19041.1165`. + type: "string" + example: "10.0.19041.1165" + os.features: + description: | + Optional field specifying an array of strings, each listing a required + OS feature (for example on Windows `win32k`). + type: "array" + items: + type: "string" + example: + - "win32k" + variant: + description: | + Optional field specifying a variant of the CPU, for example `v7` to + specify ARMv7 when architecture is `arm`. + type: "string" + example: "v7" + + DistributionInspect: + type: "object" + x-go-name: DistributionInspect + title: "DistributionInspectResponse" + required: [Descriptor, Platforms] + description: | + Describes the result obtained from contacting the registry to retrieve + image metadata. + properties: + Descriptor: + $ref: "#/definitions/OCIDescriptor" + Platforms: + type: "array" + description: | + An array containing all platforms supported by the image. + items: + $ref: "#/definitions/OCIPlatform" + paths: /containers/json: get: @@ -5261,7 +5421,9 @@ paths: 200: description: "no error" schema: - $ref: "#/definitions/ContainerSummary" + type: "array" + items: + $ref: "#/definitions/ContainerSummary" examples: application/json: - Id: "8dfafdbc3a40" @@ -6612,7 +6774,7 @@ paths: Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything. - See the [documentation for the `docker attach` command](/engine/reference/commandline/attach/) + See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details. ### Hijacking @@ -6850,7 +7012,7 @@ paths: properties: StatusCode: description: "Exit code of the container" - type: "integer" + type: "number" x-nullable: false Error: description: "container waiting error, if any" @@ -7214,7 +7376,7 @@ paths: description: | Build an image from a tar archive with a `Dockerfile` in it. - The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](/engine/reference/builder/). + The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/). The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output. @@ -7313,7 +7475,7 @@ paths: query parameter `buildargs={"FOO":"bar"}`. Note that `{"FOO":"bar"}` should be URI component encoded. - [Read more about the buildargs instruction.](/engine/reference/builder/#arg) + [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg) type: "string" - name: "shmsize" in: "query" @@ -7500,6 +7662,18 @@ paths: Refer to the [authentication section](#section/Authentication) for details. type: "string" + - name: "changes" + in: "query" + description: | + Apply `Dockerfile` instructions to the image that is created, + for example: `changes=ENV DEBUG=true`. + Note that `ENV DEBUG=true` should be URI component encoded. + + Supported `Dockerfile` instructions: + `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` + type: "array" + items: + type: "string" - name: "platform" in: "query" description: "Platform in the format os[/arch[/variant]]" @@ -7645,6 +7819,7 @@ paths: type: "array" items: type: "string" + x-nullable: true Size: type: "integer" format: "int64" @@ -8174,44 +8349,7 @@ paths: 200: description: "no error" schema: - type: "object" - title: "SystemEventsResponse" - properties: - Type: - description: "The type of object emitting the event" - type: "string" - Action: - description: "The type of event" - type: "string" - Actor: - type: "object" - properties: - ID: - description: "The ID of the object emitting the event" - type: "string" - Attributes: - description: "Various key/value attributes of the object, depending on its type" - type: "object" - additionalProperties: - type: "string" - time: - description: "Timestamp of event" - type: "integer" - timeNano: - description: "Timestamp of event, with nanosecond accuracy" - type: "integer" - format: "int64" - examples: - application/json: - Type: "container" - Action: "create" - Actor: - ID: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743" - Attributes: - com.example.some-label: "some-label-value" - image: "alpine" - name: "my-container" - time: 1461943101 + $ref: "#/definitions/EventMessage" 400: description: "bad parameter" schema: @@ -8339,6 +8477,29 @@ paths: UsageData: Size: 10920104 RefCount: 2 + BuildCache: + - + ID: "hw53o5aio51xtltp5xjp8v7fx" + Parent: "" + Type: "regular" + Description: "pulled from docker.io/library/debian@sha256:234cb88d3020898631af0ccbbcca9a66ae7306ecd30c9720690858c1b007d2a0" + InUse: false + Shared: true + Size: 0 + CreatedAt: "2021-06-28T13:31:01.474619385Z" + LastUsedAt: "2021-07-07T22:02:32.738075951Z" + UsageCount: 26 + - + ID: "ndlpt0hhvkqcdfkputsk4cq9c" + Parent: "hw53o5aio51xtltp5xjp8v7fx" + Type: "regular" + Description: "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache" + InUse: false + Shared: true + Size: 51 + CreatedAt: "2021-06-28T13:31:03.002625487Z" + LastUsedAt: "2021-07-07T22:02:32.773909517Z" + UsageCount: 26 500: description: "server error" schema: @@ -8493,6 +8654,7 @@ paths: description: "Exec configuration" schema: type: "object" + title: "ExecConfig" properties: AttachStdin: type: "boolean" @@ -8583,6 +8745,7 @@ paths: in: "body" schema: type: "object" + title: "ExecStartConfig" properties: Detach: type: "boolean" @@ -8723,7 +8886,7 @@ paths: $ref: "#/definitions/Volume" Warnings: type: "array" - x-nullable: false + x-nullable: true description: | Warnings that occurred when fetching the list of volumes. items: @@ -9117,6 +9280,7 @@ paths: required: true schema: type: "object" + title: "NetworkCreateRequest" required: ["Name"] properties: Name: @@ -9227,6 +9391,7 @@ paths: required: true schema: type: "object" + title: "NetworkConnectRequest" properties: Container: type: "string" @@ -9273,6 +9438,7 @@ paths: required: true schema: type: "object" + title: "NetworkDisconnectRequest" properties: Container: type: "string" @@ -9357,20 +9523,7 @@ paths: schema: type: "array" items: - description: | - Describes a permission the user has to accept upon installing - the plugin. - type: "object" - title: "PluginPrivilegeItem" - properties: - Name: - type: "string" - Description: - type: "string" - Value: - type: "array" - items: - type: "string" + $ref: "#/definitions/PluginPrivilege" example: - Name: "network" Description: "" @@ -9446,19 +9599,7 @@ paths: schema: type: "array" items: - description: | - Describes a permission accepted by the user upon installing the - plugin. - type: "object" - properties: - Name: - type: "string" - Description: - type: "string" - Value: - type: "array" - items: - type: "string" + $ref: "#/definitions/PluginPrivilege" example: - Name: "network" Description: "" @@ -9630,19 +9771,7 @@ paths: schema: type: "array" items: - description: | - Describes a permission accepted by the user upon installing the - plugin. - type: "object" - properties: - Name: - type: "string" - Description: - type: "string" - Value: - type: "array" - items: - type: "string" + $ref: "#/definitions/PluginPrivilege" example: - Name: "network" Description: "" @@ -9932,6 +10061,7 @@ paths: required: true schema: type: "object" + title: "SwarmInitRequest" properties: ListenAddr: description: | @@ -10030,6 +10160,7 @@ paths: required: true schema: type: "object" + title: "SwarmJoinRequest" properties: ListenAddr: description: | @@ -10050,7 +10181,7 @@ paths: description: | Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, or an interface, - like `eth0`. If `DataPathAddr` is unspecified, the same addres + like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope @@ -10190,6 +10321,7 @@ paths: required: true schema: type: "object" + title: "SwarmUnlockRequest" properties: UnlockKey: description: "The swarm's unlock key." @@ -11301,67 +11433,7 @@ paths: 200: description: "descriptor and platform information" schema: - type: "object" - x-go-name: DistributionInspect - title: "DistributionInspectResponse" - required: [Descriptor, Platforms] - properties: - Descriptor: - type: "object" - description: | - A descriptor struct containing digest, media type, and size. - properties: - MediaType: - type: "string" - Size: - type: "integer" - format: "int64" - Digest: - type: "string" - URLs: - type: "array" - items: - type: "string" - Platforms: - type: "array" - description: | - An array containing all platforms supported by the image. - items: - type: "object" - properties: - Architecture: - type: "string" - OS: - type: "string" - OSVersion: - type: "string" - OSFeatures: - type: "array" - items: - type: "string" - Variant: - type: "string" - Features: - type: "array" - items: - type: "string" - examples: - application/json: - Descriptor: - MediaType: "application/vnd.docker.distribution.manifest.v2+json" - Digest: "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96" - Size: 3987495 - URLs: - - "" - Platforms: - - Architecture: "amd64" - OS: "linux" - OSVersion: "" - OSFeatures: - - "" - Variant: "" - Features: - - "" + $ref: "#/definitions/DistributionInspect" 401: description: "Failed authentication or no image found" schema: diff --git a/api-model/docs/ContainerApi.md b/api-model/docs/ContainerApi.md index f8c721e1..ccc1da5b 100644 --- a/api-model/docs/ContainerApi.md +++ b/api-model/docs/ContainerApi.md @@ -133,7 +133,7 @@ No authorization required Attach to a container -Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached. Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything. See the [documentation for the `docker attach` command](/engine/reference/commandline/attach/) for more details. ### Hijacking This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and `stderr` on the same socket. This is the response from the daemon for an attach request: ``` HTTP/1.1 200 OK Content-Type: application/vnd.docker.raw-stream [STREAM] ``` After the headers and two new lines, the TCP connection can now be used for raw, bidirectional communication between the client and server. To hint potential proxies about connection hijacking, the Docker client can also optionally send connection upgrade headers. For example, the client sends this request to upgrade the connection: ``` POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1 Upgrade: tcp Connection: Upgrade ``` The Docker daemon will respond with a `101 UPGRADED` response, and will similarly follow with the raw stream: ``` HTTP/1.1 101 UPGRADED Content-Type: application/vnd.docker.raw-stream Connection: Upgrade Upgrade: tcp [STREAM] ``` ### Stream format When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate), the stream over the hijacked connected is multiplexed to separate out `stdout` and `stderr`. The stream consists of a series of frames, each containing a header and a payload. The header contains the information which the stream writes (`stdout` or `stderr`). It also contains the size of the associated frame encoded in the last four bytes (`uint32`). It is encoded on the first eight bytes like this: ```go header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} ``` `STREAM_TYPE` can be: - 0: `stdin` (is written on `stdout`) - 1: `stdout` - 2: `stderr` `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as big endian. Following the header is the payload, which is the specified number of bytes of `STREAM_TYPE`. The simplest way to implement this protocol is the following: 1. Read 8 bytes. 2. Choose `stdout` or `stderr` depending on the first byte. 3. Extract the frame size from the last four bytes. 4. Read the extracted size and output it on the correct output. 5. Goto 1. ### Stream format when using a TTY When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate), the stream is not multiplexed. The data exchanged over the hijacked connection is simply the raw data from the process PTY and client's `stdin`. +Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached. Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything. See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details. ### Hijacking This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and `stderr` on the same socket. This is the response from the daemon for an attach request: ``` HTTP/1.1 200 OK Content-Type: application/vnd.docker.raw-stream [STREAM] ``` After the headers and two new lines, the TCP connection can now be used for raw, bidirectional communication between the client and server. To hint potential proxies about connection hijacking, the Docker client can also optionally send connection upgrade headers. For example, the client sends this request to upgrade the connection: ``` POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1 Upgrade: tcp Connection: Upgrade ``` The Docker daemon will respond with a `101 UPGRADED` response, and will similarly follow with the raw stream: ``` HTTP/1.1 101 UPGRADED Content-Type: application/vnd.docker.raw-stream Connection: Upgrade Upgrade: tcp [STREAM] ``` ### Stream format When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate), the stream over the hijacked connected is multiplexed to separate out `stdout` and `stderr`. The stream consists of a series of frames, each containing a header and a payload. The header contains the information which the stream writes (`stdout` or `stderr`). It also contains the size of the associated frame encoded in the last four bytes (`uint32`). It is encoded on the first eight bytes like this: ```go header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} ``` `STREAM_TYPE` can be: - 0: `stdin` (is written on `stdout`) - 1: `stdout` - 2: `stderr` `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as big endian. Following the header is the payload, which is the specified number of bytes of `STREAM_TYPE`. The simplest way to implement this protocol is the following: 1. Read 8 bytes. 2. Choose `stdout` or `stderr` depending on the first byte. 3. Extract the frame size from the last four bytes. 4. Read the extracted size and output it on the correct output. 5. Goto 1. ### Stream format when using a TTY When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate), the stream is not multiplexed. The data exchanged over the hijacked connection is simply the raw data from the process PTY and client's `stdin`. ### Example ```kotlin @@ -530,7 +530,7 @@ No authorization required # **containerList** -> kotlin.collections.List<kotlin.Any> containerList(all, limit, size, filters) +> kotlin.collections.List<ContainerSummary> containerList(all, limit, size, filters) List containers @@ -548,7 +548,7 @@ val limit : kotlin.Int = 56 // kotlin.Int | Return this number of most recently val size : kotlin.Boolean = true // kotlin.Boolean | Return the size of container as fields `SizeRw` and `SizeRootFs`. val filters : kotlin.String = filters_example // kotlin.String | Filters to process on the container list, encoded as JSON (a `map[string][]string`). For example, `{\"status\": [\"paused\"]}` will only return paused containers. Available filters: - `ancestor`=(`[:]`, ``, or ``) - `before`=(`` or ``) - `expose`=(`[/]`|`/[]`) - `exited=` containers with exit code of `` - `health`=(`starting`|`healthy`|`unhealthy`|`none`) - `id=` a container's ID - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only) - `is-task=`(`true`|`false`) - `label=key` or `label=\"key=value\"` of a container label - `name=` a container's name - `network`=(`` or ``) - `publish`=(`[/]`|`/[]`) - `since`=(`` or ``) - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`) - `volume`=(`` or ``) try { - val result : kotlin.collections.List = apiInstance.containerList(all, limit, size, filters) + val result : kotlin.collections.List = apiInstance.containerList(all, limit, size, filters) println(result) } catch (e: ClientException) { println("4xx response calling ContainerApi#containerList") @@ -570,7 +570,7 @@ Name | Type | Description | Notes ### Return type -[**kotlin.collections.List<kotlin.Any>**](kotlin.Any.md) +[**kotlin.collections.List<ContainerSummary>**](ContainerSummary.md) ### Authorization diff --git a/api-model/docs/ContainerSummary.md b/api-model/docs/ContainerSummary.md new file mode 100644 index 00000000..29c72c4b --- /dev/null +++ b/api-model/docs/ContainerSummary.md @@ -0,0 +1,24 @@ + +# ContainerSummary + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **kotlin.String** | The ID of this container | [optional] +**names** | **kotlin.collections.List<kotlin.String>** | The names that this container has been given | [optional] +**image** | **kotlin.String** | The name of the image used when creating this container | [optional] +**imageID** | **kotlin.String** | The ID of the image that this container was created from | [optional] +**command** | **kotlin.String** | Command to run when starting the container | [optional] +**created** | **kotlin.Long** | When the container was created | [optional] +**ports** | [**kotlin.collections.List<Port>**](Port.md) | The ports exposed by this container | [optional] +**sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container | [optional] +**sizeRootFs** | **kotlin.Long** | The total size of all the files in this container | [optional] +**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +**state** | **kotlin.String** | The state of this container (e.g. `Exited`) | [optional] +**status** | **kotlin.String** | Additional human-readable status of this container (e.g. `Exit 0`) | [optional] +**hostConfig** | [**ContainerSummaryHostConfig**](ContainerSummaryHostConfig.md) | | [optional] +**networkSettings** | [**ContainerSummaryNetworkSettings**](ContainerSummaryNetworkSettings.md) | | [optional] +**mounts** | [**kotlin.collections.List<Mount>**](Mount.md) | | [optional] + + + diff --git a/api-model/docs/ContainerSummaryHostConfig.md b/api-model/docs/ContainerSummaryHostConfig.md new file mode 100644 index 00000000..165a27a8 --- /dev/null +++ b/api-model/docs/ContainerSummaryHostConfig.md @@ -0,0 +1,10 @@ + +# ContainerSummaryHostConfig + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**networkMode** | **kotlin.String** | | [optional] + + + diff --git a/api-model/docs/ContainerSummaryNetworkSettings.md b/api-model/docs/ContainerSummaryNetworkSettings.md new file mode 100644 index 00000000..0daa70bc --- /dev/null +++ b/api-model/docs/ContainerSummaryNetworkSettings.md @@ -0,0 +1,10 @@ + +# ContainerSummaryNetworkSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**networks** | [**kotlin.collections.Map<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] + + + diff --git a/api-model/docs/ContainerWaitResponse.md b/api-model/docs/ContainerWaitResponse.md index d70f7237..96f8abd1 100644 --- a/api-model/docs/ContainerWaitResponse.md +++ b/api-model/docs/ContainerWaitResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**statusCode** | **kotlin.Int** | Exit code of the container | +**statusCode** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | Exit code of the container | **error** | [**ContainerWaitResponseError**](ContainerWaitResponseError.md) | | [optional] diff --git a/api-model/docs/DistributionApi.md b/api-model/docs/DistributionApi.md index d5343383..f2817287 100644 --- a/api-model/docs/DistributionApi.md +++ b/api-model/docs/DistributionApi.md @@ -9,7 +9,7 @@ Method | HTTP request | Description # **distributionInspect** -> DistributionInspectResponse distributionInspect(name) +> DistributionInspect distributionInspect(name) Get image information from the registry @@ -24,7 +24,7 @@ Return image digest and platform information by contacting the registry. val apiInstance = DistributionApi() val name : kotlin.String = name_example // kotlin.String | Image name or id try { - val result : DistributionInspectResponse = apiInstance.distributionInspect(name) + val result : DistributionInspect = apiInstance.distributionInspect(name) println(result) } catch (e: ClientException) { println("4xx response calling DistributionApi#distributionInspect") @@ -43,7 +43,7 @@ Name | Type | Description | Notes ### Return type -[**DistributionInspectResponse**](DistributionInspectResponse.md) +[**DistributionInspect**](DistributionInspect.md) ### Authorization diff --git a/api-model/docs/DistributionInspect.md b/api-model/docs/DistributionInspect.md new file mode 100644 index 00000000..68df0183 --- /dev/null +++ b/api-model/docs/DistributionInspect.md @@ -0,0 +1,11 @@ + +# DistributionInspect + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | +**platforms** | [**kotlin.collections.List<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | + + + diff --git a/api-model/docs/EventActor.md b/api-model/docs/EventActor.md new file mode 100644 index 00000000..8e77d488 --- /dev/null +++ b/api-model/docs/EventActor.md @@ -0,0 +1,11 @@ + +# EventActor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ID** | **kotlin.String** | The ID of the object emitting the event | [optional] +**attributes** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] + + + diff --git a/api-model/docs/EventMessage.md b/api-model/docs/EventMessage.md new file mode 100644 index 00000000..b806694a --- /dev/null +++ b/api-model/docs/EventMessage.md @@ -0,0 +1,29 @@ + +# EventMessage + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**inline**](#TypeEnum) | The type of object emitting the event | [optional] +**action** | **kotlin.String** | The type of event | [optional] +**actor** | [**EventActor**](EventActor.md) | | [optional] +**scope** | [**inline**](#ScopeEnum) | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [optional] +**time** | **kotlin.Long** | Timestamp of event | [optional] +**timeNano** | **kotlin.Long** | Timestamp of event, with nanosecond accuracy | [optional] + + + +## Enum: Type +Name | Value +---- | ----- +type | builder, config, container, daemon, image, network, node, plugin, secret, service, volume + + + +## Enum: scope +Name | Value +---- | ----- +scope | local, swarm + + + diff --git a/api-model/docs/ExecApi.md b/api-model/docs/ExecApi.md index a524243b..4cd542aa 100644 --- a/api-model/docs/ExecApi.md +++ b/api-model/docs/ExecApi.md @@ -26,7 +26,7 @@ Run a command inside a running container. val apiInstance = ExecApi() val id : kotlin.String = id_example // kotlin.String | ID or name of container -val execConfig : InlineObject = // InlineObject | +val execConfig : ExecConfig = // ExecConfig | try { val result : IdResponse = apiInstance.containerExec(id, execConfig) println(result) @@ -44,7 +44,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **kotlin.String**| ID or name of container | - **execConfig** | [**InlineObject**](InlineObject.md)| | + **execConfig** | [**ExecConfig**](ExecConfig.md)| | ### Return type @@ -172,7 +172,7 @@ Starts a previously set up exec instance. If detach is true, this endpoint retur val apiInstance = ExecApi() val id : kotlin.String = id_example // kotlin.String | Exec instance ID -val execStartConfig : InlineObject1 = // InlineObject1 | +val execStartConfig : ExecStartConfig = // ExecStartConfig | try { apiInstance.execStart(id, execStartConfig) } catch (e: ClientException) { @@ -189,7 +189,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **kotlin.String**| Exec instance ID | - **execStartConfig** | [**InlineObject1**](InlineObject1.md)| | [optional] + **execStartConfig** | [**ExecStartConfig**](ExecStartConfig.md)| | [optional] ### Return type diff --git a/api-model/docs/ExecConfig.md b/api-model/docs/ExecConfig.md new file mode 100644 index 00000000..b82fbd80 --- /dev/null +++ b/api-model/docs/ExecConfig.md @@ -0,0 +1,19 @@ + +# ExecConfig + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attachStdin** | **kotlin.Boolean** | Attach to `stdin` of the exec command. | [optional] +**attachStdout** | **kotlin.Boolean** | Attach to `stdout` of the exec command. | [optional] +**attachStderr** | **kotlin.Boolean** | Attach to `stderr` of the exec command. | [optional] +**detachKeys** | **kotlin.String** | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional] +**tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] +**env** | **kotlin.collections.List<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] +**cmd** | **kotlin.collections.List<kotlin.String>** | Command to run, as a string or array of strings. | [optional] +**privileged** | **kotlin.Boolean** | Runs the exec process with extended privileges. | [optional] +**user** | **kotlin.String** | The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. | [optional] +**workingDir** | **kotlin.String** | The working directory for the exec process inside the container. | [optional] + + + diff --git a/api-model/docs/ExecStartConfig.md b/api-model/docs/ExecStartConfig.md new file mode 100644 index 00000000..a41e902e --- /dev/null +++ b/api-model/docs/ExecStartConfig.md @@ -0,0 +1,11 @@ + +# ExecStartConfig + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detach** | **kotlin.Boolean** | Detach from the command. | [optional] +**tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] + + + diff --git a/api-model/docs/ImageApi.md b/api-model/docs/ImageApi.md index c961f2f7..5c512a58 100644 --- a/api-model/docs/ImageApi.md +++ b/api-model/docs/ImageApi.md @@ -76,7 +76,7 @@ No authorization required Build an image -Build an image from a tar archive with a `Dockerfile` in it. The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](/engine/reference/builder/). The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output. The build is canceled if the client drops the connection by quitting or being killed. +Build an image from a tar archive with a `Dockerfile` in it. The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/). The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output. The build is canceled if the client drops the connection by quitting or being killed. ### Example ```kotlin @@ -101,7 +101,7 @@ val cpushares : kotlin.Int = 56 // kotlin.Int | CPU shares (relative weight). val cpusetcpus : kotlin.String = cpusetcpus_example // kotlin.String | CPUs in which to allow execution (e.g., `0-3`, `0,1`). val cpuperiod : kotlin.Int = 56 // kotlin.Int | The length of a CPU period in microseconds. val cpuquota : kotlin.Int = 56 // kotlin.Int | Microseconds of CPU time that the container can get in a CPU period. -val buildargs : kotlin.String = buildargs_example // kotlin.String | JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded. [Read more about the buildargs instruction.](/engine/reference/builder/#arg) +val buildargs : kotlin.String = buildargs_example // kotlin.String | JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg) val shmsize : kotlin.Int = 56 // kotlin.Int | Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB. val squash : kotlin.Boolean = true // kotlin.Boolean | Squash the resulting images layers into a single layer. *(Experimental release only.)* val labels : kotlin.String = labels_example // kotlin.String | Arbitrary key/value labels to set on the image, as a JSON map of string pairs. @@ -143,7 +143,7 @@ Name | Type | Description | Notes **cpusetcpus** | **kotlin.String**| CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] **cpuperiod** | **kotlin.Int**| The length of a CPU period in microseconds. | [optional] **cpuquota** | **kotlin.Int**| Microseconds of CPU time that the container can get in a CPU period. | [optional] - **buildargs** | **kotlin.String**| JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded. [Read more about the buildargs instruction.](/engine/reference/builder/#arg) | [optional] + **buildargs** | **kotlin.String**| JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. For example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg) | [optional] **shmsize** | **kotlin.Int**| Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB. | [optional] **squash** | **kotlin.Boolean**| Squash the resulting images layers into a single layer. *(Experimental release only.)* | [optional] **labels** | **kotlin.String**| Arbitrary key/value labels to set on the image, as a JSON map of string pairs. | [optional] @@ -229,7 +229,7 @@ No authorization required # **imageCreate** -> imageCreate(fromImage, fromSrc, repo, tag, message, xRegistryAuth, platform, inputImage) +> imageCreate(fromImage, fromSrc, repo, tag, message, xRegistryAuth, changes, platform, inputImage) Create an image @@ -248,10 +248,11 @@ val repo : kotlin.String = repo_example // kotlin.String | Repository name given val tag : kotlin.String = tag_example // kotlin.String | Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. val message : kotlin.String = message_example // kotlin.String | Set commit message for imported image. val xRegistryAuth : kotlin.String = xRegistryAuth_example // kotlin.String | A base64url-encoded auth configuration. Refer to the [authentication section](#section/Authentication) for details. +val changes : kotlin.collections.List = // kotlin.collections.List | Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` val platform : kotlin.String = platform_example // kotlin.String | Platform in the format os[/arch[/variant]] val inputImage : kotlin.String = inputImage_example // kotlin.String | Image content if the value `-` has been specified in fromSrc query parameter try { - apiInstance.imageCreate(fromImage, fromSrc, repo, tag, message, xRegistryAuth, platform, inputImage) + apiInstance.imageCreate(fromImage, fromSrc, repo, tag, message, xRegistryAuth, changes, platform, inputImage) } catch (e: ClientException) { println("4xx response calling ImageApi#imageCreate") e.printStackTrace() @@ -271,6 +272,7 @@ Name | Type | Description | Notes **tag** | **kotlin.String**| Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. | [optional] **message** | **kotlin.String**| Set commit message for imported image. | [optional] **xRegistryAuth** | **kotlin.String**| A base64url-encoded auth configuration. Refer to the [authentication section](#section/Authentication) for details. | [optional] + **changes** | [**kotlin.collections.List<kotlin.String>**](kotlin.String.md)| Apply `Dockerfile` instructions to the image that is created, for example: `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component encoded. Supported `Dockerfile` instructions: `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR` | [optional] **platform** | **kotlin.String**| Platform in the format os[/arch[/variant]] | [optional] **inputImage** | **kotlin.String**| Image content if the value `-` has been specified in fromSrc query parameter | [optional] diff --git a/api-model/docs/NetworkApi.md b/api-model/docs/NetworkApi.md index 5cf0b097..3ce02e76 100644 --- a/api-model/docs/NetworkApi.md +++ b/api-model/docs/NetworkApi.md @@ -27,7 +27,7 @@ Connect a container to a network val apiInstance = NetworkApi() val id : kotlin.String = id_example // kotlin.String | Network ID or name -val container : InlineObject3 = // InlineObject3 | +val container : NetworkConnectRequest = // NetworkConnectRequest | try { apiInstance.networkConnect(id, container) } catch (e: ClientException) { @@ -44,7 +44,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **kotlin.String**| Network ID or name | - **container** | [**InlineObject3**](InlineObject3.md)| | + **container** | [**NetworkConnectRequest**](NetworkConnectRequest.md)| | ### Return type @@ -72,7 +72,7 @@ Create a network //import de.gesellix.docker.engine.model.* val apiInstance = NetworkApi() -val networkConfig : InlineObject2 = // InlineObject2 | +val networkConfig : NetworkCreateRequest = // NetworkCreateRequest | try { val result : NetworkCreateResponse = apiInstance.networkCreate(networkConfig) println(result) @@ -89,7 +89,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **networkConfig** | [**InlineObject2**](InlineObject2.md)| | + **networkConfig** | [**NetworkCreateRequest**](NetworkCreateRequest.md)| | ### Return type @@ -162,7 +162,7 @@ Disconnect a container from a network val apiInstance = NetworkApi() val id : kotlin.String = id_example // kotlin.String | Network ID or name -val container : InlineObject4 = // InlineObject4 | +val container : NetworkDisconnectRequest = // NetworkDisconnectRequest | try { apiInstance.networkDisconnect(id, container) } catch (e: ClientException) { @@ -179,7 +179,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **kotlin.String**| Network ID or name | - **container** | [**InlineObject4**](InlineObject4.md)| | + **container** | [**NetworkDisconnectRequest**](NetworkDisconnectRequest.md)| | ### Return type diff --git a/api-model/docs/NetworkConnectRequest.md b/api-model/docs/NetworkConnectRequest.md new file mode 100644 index 00000000..04789a8b --- /dev/null +++ b/api-model/docs/NetworkConnectRequest.md @@ -0,0 +1,11 @@ + +# NetworkConnectRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**container** | **kotlin.String** | The ID or name of the container to connect to the network. | [optional] +**endpointConfig** | [**EndpointSettings**](EndpointSettings.md) | | [optional] + + + diff --git a/api-model/docs/NetworkCreateRequest.md b/api-model/docs/NetworkCreateRequest.md new file mode 100644 index 00000000..acc23145 --- /dev/null +++ b/api-model/docs/NetworkCreateRequest.md @@ -0,0 +1,19 @@ + +# NetworkCreateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **kotlin.String** | The network's name. | +**checkDuplicate** | **kotlin.Boolean** | Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions. | [optional] +**driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] +**`internal`** | **kotlin.Boolean** | Restrict external access to the network. | [optional] +**attachable** | **kotlin.Boolean** | Globally scoped network is manually attachable by regular containers from workers in swarm mode. | [optional] +**ingress** | **kotlin.Boolean** | Ingress network is the network which provides the routing-mesh in swarm mode. | [optional] +**IPAM** | [**IPAM**](IPAM.md) | | [optional] +**enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] +**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] +**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] + + + diff --git a/api-model/docs/NetworkDisconnectRequest.md b/api-model/docs/NetworkDisconnectRequest.md new file mode 100644 index 00000000..5adfb121 --- /dev/null +++ b/api-model/docs/NetworkDisconnectRequest.md @@ -0,0 +1,11 @@ + +# NetworkDisconnectRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**container** | **kotlin.String** | The ID or name of the container to disconnect from the network. | [optional] +**force** | **kotlin.Boolean** | Force the container to disconnect from the network. | [optional] + + + diff --git a/api-model/docs/NetworkSettings.md b/api-model/docs/NetworkSettings.md index 2cc5dd00..4305f380 100644 --- a/api-model/docs/NetworkSettings.md +++ b/api-model/docs/NetworkSettings.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bridge** | **kotlin.String** | Name of the network'a bridge (for example, `docker0`). | [optional] +**bridge** | **kotlin.String** | Name of the network's bridge (for example, `docker0`). | [optional] **sandboxID** | **kotlin.String** | SandboxID uniquely represents a container's network stack. | [optional] **hairpinMode** | **kotlin.Boolean** | Indicates if hairpin NAT should be enabled on the virtual interface. | [optional] **linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. | [optional] diff --git a/api-model/docs/OCIDescriptor.md b/api-model/docs/OCIDescriptor.md new file mode 100644 index 00000000..26014af3 --- /dev/null +++ b/api-model/docs/OCIDescriptor.md @@ -0,0 +1,12 @@ + +# OCIDescriptor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mediaType** | **kotlin.String** | The media type of the object this schema refers to. | [optional] +**digest** | **kotlin.String** | The digest of the targeted content. | [optional] +**size** | **kotlin.Long** | The size in bytes of the blob. | [optional] + + + diff --git a/api-model/docs/OCIPlatform.md b/api-model/docs/OCIPlatform.md new file mode 100644 index 00000000..00be2078 --- /dev/null +++ b/api-model/docs/OCIPlatform.md @@ -0,0 +1,14 @@ + +# OCIPlatform + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**architecture** | **kotlin.String** | The CPU architecture, for example `amd64` or `ppc64`. | [optional] +**os** | **kotlin.String** | The operating system, for example `linux` or `windows`. | [optional] +**osVersion** | **kotlin.String** | Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. | [optional] +**osFeatures** | **kotlin.collections.List<kotlin.String>** | Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). | [optional] +**variant** | **kotlin.String** | Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. | [optional] + + + diff --git a/api-model/docs/PluginApi.md b/api-model/docs/PluginApi.md index 67de60d0..0b316ea3 100644 --- a/api-model/docs/PluginApi.md +++ b/api-model/docs/PluginApi.md @@ -19,7 +19,7 @@ Method | HTTP request | Description # **getPluginPrivileges** -> kotlin.collections.List<PluginPrivilegeItem> getPluginPrivileges(remote) +> kotlin.collections.List<PluginPrivilege> getPluginPrivileges(remote) Get plugin privileges @@ -32,7 +32,7 @@ Get plugin privileges val apiInstance = PluginApi() val remote : kotlin.String = remote_example // kotlin.String | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. try { - val result : kotlin.collections.List = apiInstance.getPluginPrivileges(remote) + val result : kotlin.collections.List = apiInstance.getPluginPrivileges(remote) println(result) } catch (e: ClientException) { println("4xx response calling PluginApi#getPluginPrivileges") @@ -51,7 +51,7 @@ Name | Type | Description | Notes ### Return type -[**kotlin.collections.List<PluginPrivilegeItem>**](PluginPrivilegeItem.md) +[**kotlin.collections.List<PluginPrivilege>**](PluginPrivilege.md) ### Authorization @@ -355,7 +355,7 @@ val apiInstance = PluginApi() val remote : kotlin.String = remote_example // kotlin.String | Remote reference for plugin to install. The `:latest` tag is optional, and is used as the default if omitted. val name : kotlin.String = name_example // kotlin.String | Local name for the pulled plugin. The `:latest` tag is optional, and is used as the default if omitted. val xRegistryAuth : kotlin.String = xRegistryAuth_example // kotlin.String | A base64url-encoded auth configuration to use when pulling a plugin from a registry. Refer to the [authentication section](#section/Authentication) for details. -val body : kotlin.collections.List = // kotlin.collections.List | +val body : kotlin.collections.List = // kotlin.collections.List | try { apiInstance.pluginPull(remote, name, xRegistryAuth, body) } catch (e: ClientException) { @@ -374,7 +374,7 @@ Name | Type | Description | Notes **remote** | **kotlin.String**| Remote reference for plugin to install. The `:latest` tag is optional, and is used as the default if omitted. | **name** | **kotlin.String**| Local name for the pulled plugin. The `:latest` tag is optional, and is used as the default if omitted. | [optional] **xRegistryAuth** | **kotlin.String**| A base64url-encoded auth configuration to use when pulling a plugin from a registry. Refer to the [authentication section](#section/Authentication) for details. | [optional] - **body** | [**kotlin.collections.List<InlineObject>**](InlineObject.md)| | [optional] + **body** | [**kotlin.collections.List<PluginPrivilege>**](PluginPrivilege.md)| | [optional] ### Return type @@ -497,7 +497,7 @@ val apiInstance = PluginApi() val name : kotlin.String = name_example // kotlin.String | The name of the plugin. The `:latest` tag is optional, and is the default if omitted. val remote : kotlin.String = remote_example // kotlin.String | Remote reference to upgrade to. The `:latest` tag is optional, and is used as the default if omitted. val xRegistryAuth : kotlin.String = xRegistryAuth_example // kotlin.String | A base64url-encoded auth configuration to use when pulling a plugin from a registry. Refer to the [authentication section](#section/Authentication) for details. -val body : kotlin.collections.List = // kotlin.collections.List | +val body : kotlin.collections.List = // kotlin.collections.List | try { apiInstance.pluginUpgrade(name, remote, xRegistryAuth, body) } catch (e: ClientException) { @@ -516,7 +516,7 @@ Name | Type | Description | Notes **name** | **kotlin.String**| The name of the plugin. The `:latest` tag is optional, and is the default if omitted. | **remote** | **kotlin.String**| Remote reference to upgrade to. The `:latest` tag is optional, and is used as the default if omitted. | **xRegistryAuth** | **kotlin.String**| A base64url-encoded auth configuration to use when pulling a plugin from a registry. Refer to the [authentication section](#section/Authentication) for details. | [optional] - **body** | [**kotlin.collections.List<InlineObject>**](InlineObject.md)| | [optional] + **body** | [**kotlin.collections.List<PluginPrivilege>**](PluginPrivilege.md)| | [optional] ### Return type diff --git a/api-model/docs/PluginPrivilege.md b/api-model/docs/PluginPrivilege.md new file mode 100644 index 00000000..93ab7751 --- /dev/null +++ b/api-model/docs/PluginPrivilege.md @@ -0,0 +1,12 @@ + +# PluginPrivilege + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **kotlin.String** | | [optional] +**description** | **kotlin.String** | | [optional] +**value** | **kotlin.collections.List<kotlin.String>** | | [optional] + + + diff --git a/api-model/docs/RestartPolicy.md b/api-model/docs/RestartPolicy.md index d6fb3849..b0e3950f 100644 --- a/api-model/docs/RestartPolicy.md +++ b/api-model/docs/RestartPolicy.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | [**inline**](#NameEnum) | - Empty string means not to restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] +**name** | [**inline**](#NameEnum) | - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] **maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] @@ -12,7 +12,7 @@ Name | Type | Description | Notes ## Enum: Name Name | Value ---- | ----- -name | , always, unless-stopped, on-failure +name | , no, always, unless-stopped, on-failure diff --git a/api-model/docs/SwarmApi.md b/api-model/docs/SwarmApi.md index ff421982..ed6ab180 100644 --- a/api-model/docs/SwarmApi.md +++ b/api-model/docs/SwarmApi.md @@ -26,7 +26,7 @@ Initialize a new swarm //import de.gesellix.docker.engine.model.* val apiInstance = SwarmApi() -val body : InlineObject5 = // InlineObject5 | +val body : SwarmInitRequest = // SwarmInitRequest | try { val result : kotlin.String = apiInstance.swarmInit(body) println(result) @@ -43,7 +43,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**InlineObject5**](InlineObject5.md)| | + **body** | [**SwarmInitRequest**](SwarmInitRequest.md)| | ### Return type @@ -112,7 +112,7 @@ Join an existing swarm //import de.gesellix.docker.engine.model.* val apiInstance = SwarmApi() -val body : InlineObject6 = // InlineObject6 | +val body : SwarmJoinRequest = // SwarmJoinRequest | try { apiInstance.swarmJoin(body) } catch (e: ClientException) { @@ -128,7 +128,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**InlineObject6**](InlineObject6.md)| | + **body** | [**SwarmJoinRequest**](SwarmJoinRequest.md)| | ### Return type @@ -200,7 +200,7 @@ Unlock a locked manager //import de.gesellix.docker.engine.model.* val apiInstance = SwarmApi() -val body : InlineObject7 = // InlineObject7 | +val body : SwarmUnlockRequest = // SwarmUnlockRequest | try { apiInstance.swarmUnlock(body) } catch (e: ClientException) { @@ -216,7 +216,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**InlineObject7**](InlineObject7.md)| | + **body** | [**SwarmUnlockRequest**](SwarmUnlockRequest.md)| | ### Return type diff --git a/api-model/docs/SwarmInitRequest.md b/api-model/docs/SwarmInitRequest.md new file mode 100644 index 00000000..953330e9 --- /dev/null +++ b/api-model/docs/SwarmInitRequest.md @@ -0,0 +1,17 @@ + +# SwarmInitRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**listenAddr** | **kotlin.String** | Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. | [optional] +**advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] +**dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] +**dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used. | [optional] +**defaultAddrPool** | **kotlin.collections.List<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] +**forceNewCluster** | **kotlin.Boolean** | Force creation of a new swarm. | [optional] +**subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] +**spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] + + + diff --git a/api-model/docs/SwarmJoinRequest.md b/api-model/docs/SwarmJoinRequest.md new file mode 100644 index 00000000..ead4a099 --- /dev/null +++ b/api-model/docs/SwarmJoinRequest.md @@ -0,0 +1,14 @@ + +# SwarmJoinRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**listenAddr** | **kotlin.String** | Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). | [optional] +**advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] +**dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] +**remoteAddrs** | **kotlin.collections.List<kotlin.String>** | Addresses of manager nodes already participating in the swarm. | [optional] +**joinToken** | **kotlin.String** | Secret token for joining this swarm. | [optional] + + + diff --git a/api-model/docs/SwarmUnlockRequest.md b/api-model/docs/SwarmUnlockRequest.md new file mode 100644 index 00000000..ddf81767 --- /dev/null +++ b/api-model/docs/SwarmUnlockRequest.md @@ -0,0 +1,10 @@ + +# SwarmUnlockRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] + + + diff --git a/api-model/docs/SystemApi.md b/api-model/docs/SystemApi.md index 71c3b4bb..a908281f 100644 --- a/api-model/docs/SystemApi.md +++ b/api-model/docs/SystemApi.md @@ -103,7 +103,7 @@ No authorization required # **systemEvents** -> SystemEventsResponse systemEvents(since, until, filters) +> EventMessage systemEvents(since, until, filters) Monitor events @@ -120,7 +120,7 @@ val since : kotlin.String = since_example // kotlin.String | Show events created val until : kotlin.String = until_example // kotlin.String | Show events created until this timestamp then stop streaming. val filters : kotlin.String = filters_example // kotlin.String | A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters: - `config=` config name or ID - `container=` container name or ID - `daemon=` daemon name or ID - `event=` event type - `image=` image name or ID - `label=` image or container label - `network=` network name or ID - `node=` node ID - `plugin`= plugin name or ID - `scope`= local or swarm - `secret=` secret name or ID - `service=` service name or ID - `type=` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config` - `volume=` volume name try { - val result : SystemEventsResponse = apiInstance.systemEvents(since, until, filters) + val result : EventMessage = apiInstance.systemEvents(since, until, filters) println(result) } catch (e: ClientException) { println("4xx response calling SystemApi#systemEvents") @@ -141,7 +141,7 @@ Name | Type | Description | Notes ### Return type -[**SystemEventsResponse**](SystemEventsResponse.md) +[**EventMessage**](EventMessage.md) ### Authorization diff --git a/api-model/docs/SystemDataUsageResponse.md b/api-model/docs/SystemDataUsageResponse.md index da2353ee..749b7930 100644 --- a/api-model/docs/SystemDataUsageResponse.md +++ b/api-model/docs/SystemDataUsageResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **layersSize** | **kotlin.Long** | | [optional] **images** | [**kotlin.collections.List<ImageSummary>**](ImageSummary.md) | | [optional] -**containers** | **kotlin.collections.List<kotlin.collections.List<kotlin.Any>>** | | [optional] +**containers** | [**kotlin.collections.List<ContainerSummary>**](ContainerSummary.md) | | [optional] **volumes** | [**kotlin.collections.List<Volume>**](Volume.md) | | [optional] **buildCache** | [**kotlin.collections.List<BuildCache>**](BuildCache.md) | | [optional] diff --git a/api-model/docs/SystemInfo.md b/api-model/docs/SystemInfo.md index 306e1ffa..e7fa6335 100644 --- a/api-model/docs/SystemInfo.md +++ b/api-model/docs/SystemInfo.md @@ -50,7 +50,7 @@ Name | Type | Description | Notes **name** | **kotlin.String** | Hostname of the host. | [optional] **labels** | **kotlin.collections.List<kotlin.String>** | User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. | [optional] **experimentalBuild** | **kotlin.Boolean** | Indicates if experimental features are enabled on the daemon. | [optional] -**serverVersion** | **kotlin.String** | Version string of the daemon. > **Note**: the [standalone Swarm API](/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. | [optional] +**serverVersion** | **kotlin.String** | Version string of the daemon. > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. | [optional] **clusterStore** | **kotlin.String** | URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism. <p><br /></p> > **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. | [optional] **clusterAdvertise** | **kotlin.String** | The network endpoint that the Engine advertises for the purpose of node discovery. ClusterAdvertise is a `host:port` combination on which the daemon is reachable by other hosts. <p><br /></p> > **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. | [optional] **runtimes** | [**kotlin.collections.Map<kotlin.String, Runtime>**](Runtime.md) | List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. | [optional] diff --git a/api-model/docs/TaskSpecPluginSpec.md b/api-model/docs/TaskSpecPluginSpec.md index 740dfdf1..8035a40a 100644 --- a/api-model/docs/TaskSpecPluginSpec.md +++ b/api-model/docs/TaskSpecPluginSpec.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **name** | **kotlin.String** | The name or 'alias' to use for the plugin. | [optional] **remote** | **kotlin.String** | The plugin image reference to use. | [optional] **disabled** | **kotlin.Boolean** | Disable the plugin once scheduled. | [optional] -**pluginPrivilege** | [**kotlin.collections.List<InlineObject>**](InlineObject.md) | | [optional] +**pluginPrivilege** | [**kotlin.collections.List<PluginPrivilege>**](PluginPrivilege.md) | | [optional] diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummary.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummary.kt new file mode 100644 index 00000000..c993bdde --- /dev/null +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummary.kt @@ -0,0 +1,79 @@ +/** +* Docker Engine API +* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` +* +* The version of the OpenAPI document: 1.41 +* +* +* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). +* https://openapi-generator.tech +* Do not edit the class manually. +*/ +package de.gesellix.docker.engine.model + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * @param id The ID of this container + * @param names The names that this container has been given + * @param image The name of the image used when creating this container + * @param imageID The ID of the image that this container was created from + * @param command Command to run when starting the container + * @param created When the container was created + * @param ports The ports exposed by this container + * @param sizeRw The size of files that have been created or changed by this container + * @param sizeRootFs The total size of all the files in this container + * @param labels User-defined key/value metadata. + * @param state The state of this container (e.g. `Exited`) + * @param status Additional human-readable status of this container (e.g. `Exit 0`) + * @param hostConfig + * @param networkSettings + * @param mounts + */ +@JsonClass(generateAdapter = true) +data class ContainerSummary( + /* The ID of this container */ + @Json(name = "Id") + val id: kotlin.String? = null, + /* The names that this container has been given */ + @Json(name = "Names") + val names: kotlin.collections.List? = null, + /* The name of the image used when creating this container */ + @Json(name = "Image") + val image: kotlin.String? = null, + /* The ID of the image that this container was created from */ + @Json(name = "ImageID") + val imageID: kotlin.String? = null, + /* Command to run when starting the container */ + @Json(name = "Command") + val command: kotlin.String? = null, + /* When the container was created */ + @Json(name = "Created") + val created: kotlin.Long? = null, + /* The ports exposed by this container */ + @Json(name = "Ports") + val ports: kotlin.collections.List? = null, + /* The size of files that have been created or changed by this container */ + @Json(name = "SizeRw") + val sizeRw: kotlin.Long? = null, + /* The total size of all the files in this container */ + @Json(name = "SizeRootFs") + val sizeRootFs: kotlin.Long? = null, + /* User-defined key/value metadata. */ + @Json(name = "Labels") + val labels: kotlin.collections.Map? = null, + /* The state of this container (e.g. `Exited`) */ + @Json(name = "State") + val state: kotlin.String? = null, + /* Additional human-readable status of this container (e.g. `Exit 0`) */ + @Json(name = "Status") + val status: kotlin.String? = null, + @Json(name = "HostConfig") + val hostConfig: ContainerSummaryHostConfig? = null, + @Json(name = "NetworkSettings") + val networkSettings: ContainerSummaryNetworkSettings? = null, + @Json(name = "Mounts") + val mounts: kotlin.collections.List? = null +) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryHostConfig.kt similarity index 88% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryHostConfig.kt index c12a1c31..b7b0cd17 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryHostConfig.kt @@ -15,17 +15,11 @@ import com.squareup.moshi.Json import com.squareup.moshi.JsonClass /** - * Describes a permission accepted by the user upon installing the plugin. - * @param name - * @param description - * @param value + * + * @param networkMode */ @JsonClass(generateAdapter = true) -data class InlineObject( - @Json(name = "Name") - val name: kotlin.String? = null, - @Json(name = "Description") - val description: kotlin.String? = null, - @Json(name = "Value") - val value: kotlin.collections.List? = null +data class ContainerSummaryHostConfig( + @Json(name = "NetworkMode") + val networkMode: kotlin.String? = null ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryNetworkSettings.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryNetworkSettings.kt new file mode 100644 index 00000000..9ae462e2 --- /dev/null +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryNetworkSettings.kt @@ -0,0 +1,25 @@ +/** +* Docker Engine API +* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` +* +* The version of the OpenAPI document: 1.41 +* +* +* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). +* https://openapi-generator.tech +* Do not edit the class manually. +*/ +package de.gesellix.docker.engine.model + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A summary of the container's network settings + * @param networks + */ +@JsonClass(generateAdapter = true) +data class ContainerSummaryNetworkSettings( + @Json(name = "Networks") + val networks: kotlin.collections.Map? = null +) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponse.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponse.kt index 18f9767b..b26b9359 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponse.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponse.kt @@ -23,7 +23,7 @@ import com.squareup.moshi.JsonClass data class ContainerWaitResponse( /* Exit code of the container */ @Json(name = "StatusCode") - val statusCode: kotlin.Int, + val statusCode: java.math.BigDecimal, @Json(name = "Error") val error: ContainerWaitResponseError? = null ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponse.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspect.kt similarity index 93% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponse.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspect.kt index 929d6c9a..a9362ddd 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponse.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspect.kt @@ -15,15 +15,15 @@ import com.squareup.moshi.Json import com.squareup.moshi.JsonClass /** - * + * Describes the result obtained from contacting the registry to retrieve image metadata. * @param descriptor * @param platforms An array containing all platforms supported by the image. */ @JsonClass(generateAdapter = true) -data class DistributionInspectResponse( +data class DistributionInspect( @Json(name = "Descriptor") - val descriptor: DistributionInspectResponseDescriptor, + val descriptor: OCIDescriptor, /* An array containing all platforms supported by the image. */ @Json(name = "Platforms") - val platforms: kotlin.collections.List + val platforms: kotlin.collections.List ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponseActor.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/EventActor.kt similarity index 95% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponseActor.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/EventActor.kt index 1cf4fa03..1e2564fc 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponseActor.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/EventActor.kt @@ -15,16 +15,16 @@ import com.squareup.moshi.Json import com.squareup.moshi.JsonClass /** - * + * Actor describes something that generates events, like a container, network, or a volume. * @param ID The ID of the object emitting the event - * @param attributes Various key/value attributes of the object, depending on its type + * @param attributes Various key/value attributes of the object, depending on its type. */ @JsonClass(generateAdapter = true) -data class SystemEventsResponseActor( +data class EventActor( /* The ID of the object emitting the event */ @Json(name = "ID") val ID: kotlin.String? = null, - /* Various key/value attributes of the object, depending on its type */ + /* Various key/value attributes of the object, depending on its type. */ @Json(name = "Attributes") val attributes: kotlin.collections.Map? = null ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponse.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/EventMessage.kt similarity index 70% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponse.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/EventMessage.kt index c9f33c6e..25fb9026 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemEventsResponse.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/EventMessage.kt @@ -15,27 +15,58 @@ import com.squareup.moshi.Json import com.squareup.moshi.JsonClass /** - * + * EventMessage represents the information an event contains. * @param type The type of object emitting the event * @param action The type of event * @param actor + * @param scope Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. * @param time Timestamp of event * @param timeNano Timestamp of event, with nanosecond accuracy */ @JsonClass(generateAdapter = true) -data class SystemEventsResponse( +data class EventMessage( /* The type of object emitting the event */ @Json(name = "Type") - val type: kotlin.String? = null, + val type: EventMessage.Type? = null, /* The type of event */ @Json(name = "Action") val action: kotlin.String? = null, @Json(name = "Actor") - val actor: SystemEventsResponseActor? = null, + val actor: EventActor? = null, + /* Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. */ + @Json(name = "scope") + val scope: EventMessage.Scope? = null, /* Timestamp of event */ @Json(name = "time") - val time: kotlin.Int? = null, + val time: kotlin.Long? = null, /* Timestamp of event, with nanosecond accuracy */ @Json(name = "timeNano") val timeNano: kotlin.Long? = null -) +) { + + /** + * The type of object emitting the event + * Values: Builder,Config,Container,Daemon,Image,Network,Node,Plugin,Secret,Service,Volume + */ + enum class Type(val value: kotlin.String) { + @Json(name = "builder") Builder("builder"), + @Json(name = "config") Config("config"), + @Json(name = "container") Container("container"), + @Json(name = "daemon") Daemon("daemon"), + @Json(name = "image") Image("image"), + @Json(name = "network") Network("network"), + @Json(name = "node") Node("node"), + @Json(name = "plugin") Plugin("plugin"), + @Json(name = "secret") Secret("secret"), + @Json(name = "service") Service("service"), + @Json(name = "volume") Volume("volume"); + } + /** + * Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. + * Values: Local,Swarm + */ + enum class Scope(val value: kotlin.String) { + @Json(name = "local") Local("local"), + @Json(name = "swarm") Swarm("swarm"); + } +} diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecConfig.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecConfig.kt new file mode 100644 index 00000000..f04d3996 --- /dev/null +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecConfig.kt @@ -0,0 +1,62 @@ +/** +* Docker Engine API +* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` +* +* The version of the OpenAPI document: 1.41 +* +* +* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). +* https://openapi-generator.tech +* Do not edit the class manually. +*/ +package de.gesellix.docker.engine.model + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * @param attachStdin Attach to `stdin` of the exec command. + * @param attachStdout Attach to `stdout` of the exec command. + * @param attachStderr Attach to `stderr` of the exec command. + * @param detachKeys Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. + * @param tty Allocate a pseudo-TTY. + * @param env A list of environment variables in the form `[\"VAR=value\", ...]`. + * @param cmd Command to run, as a string or array of strings. + * @param privileged Runs the exec process with extended privileges. + * @param user The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. + * @param workingDir The working directory for the exec process inside the container. + */ +@JsonClass(generateAdapter = true) +data class ExecConfig( + /* Attach to `stdin` of the exec command. */ + @Json(name = "AttachStdin") + val attachStdin: kotlin.Boolean? = null, + /* Attach to `stdout` of the exec command. */ + @Json(name = "AttachStdout") + val attachStdout: kotlin.Boolean? = null, + /* Attach to `stderr` of the exec command. */ + @Json(name = "AttachStderr") + val attachStderr: kotlin.Boolean? = null, + /* Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. */ + @Json(name = "DetachKeys") + val detachKeys: kotlin.String? = null, + /* Allocate a pseudo-TTY. */ + @Json(name = "Tty") + val tty: kotlin.Boolean? = null, + /* A list of environment variables in the form `[\"VAR=value\", ...]`. */ + @Json(name = "Env") + val env: kotlin.collections.List? = null, + /* Command to run, as a string or array of strings. */ + @Json(name = "Cmd") + val cmd: kotlin.collections.List? = null, + /* Runs the exec process with extended privileges. */ + @Json(name = "Privileged") + val privileged: kotlin.Boolean? = null, + /* The user, and optionally, group to run the exec process inside the container. Format is one of: `user`, `user:group`, `uid`, or `uid:gid`. */ + @Json(name = "User") + val user: kotlin.String? = null, + /* The working directory for the exec process inside the container. */ + @Json(name = "WorkingDir") + val workingDir: kotlin.String? = null +) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject1.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecStartConfig.kt similarity index 99% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject1.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecStartConfig.kt index 16cc986d..279321dd 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject1.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ExecStartConfig.kt @@ -20,7 +20,7 @@ import com.squareup.moshi.JsonClass * @param tty Allocate a pseudo-TTY. */ @JsonClass(generateAdapter = true) -data class InlineObject1( +data class ExecStartConfig( /* Detach from the command. */ @Json(name = "Detach") val detach: kotlin.Boolean? = null, diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/HistoryResponseItem.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/HistoryResponseItem.kt index 5342c637..0cf550ec 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/HistoryResponseItem.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/HistoryResponseItem.kt @@ -32,7 +32,7 @@ data class HistoryResponseItem( @Json(name = "CreatedBy") val createdBy: kotlin.String, @Json(name = "Tags") - val tags: kotlin.collections.List, + val tags: kotlin.collections.List?, @Json(name = "Size") val size: kotlin.Long, @Json(name = "Comment") diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ImageSummary.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ImageSummary.kt index c60c3999..7a9753ca 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ImageSummary.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/ImageSummary.kt @@ -34,9 +34,9 @@ data class ImageSummary( @Json(name = "ParentId") val parentId: kotlin.String, @Json(name = "RepoTags") - val repoTags: kotlin.collections.List, + val repoTags: kotlin.collections.List?, @Json(name = "RepoDigests") - val repoDigests: kotlin.collections.List, + val repoDigests: kotlin.collections.List?, @Json(name = "Created") val created: kotlin.Int, @Json(name = "Size") @@ -46,7 +46,7 @@ data class ImageSummary( @Json(name = "VirtualSize") val virtualSize: kotlin.Int, @Json(name = "Labels") - val labels: kotlin.collections.Map, + val labels: kotlin.collections.Map?, @Json(name = "Containers") val containers: kotlin.Int ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject3.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkConnectRequest.kt similarity index 98% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject3.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkConnectRequest.kt index cfa145ed..d278f2bf 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject3.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkConnectRequest.kt @@ -20,7 +20,7 @@ import com.squareup.moshi.JsonClass * @param endpointConfig */ @JsonClass(generateAdapter = true) -data class InlineObject3( +data class NetworkConnectRequest( /* The ID or name of the container to connect to the network. */ @Json(name = "Container") val container: kotlin.String? = null, diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject2.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkCreateRequest.kt similarity index 99% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject2.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkCreateRequest.kt index 4ec9d23c..dfd54878 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject2.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkCreateRequest.kt @@ -28,7 +28,7 @@ import com.squareup.moshi.JsonClass * @param labels User-defined key/value metadata. */ @JsonClass(generateAdapter = true) -data class InlineObject2( +data class NetworkCreateRequest( /* The network's name. */ @Json(name = "Name") val name: kotlin.String, diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject4.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkDisconnectRequest.kt similarity index 98% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject4.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkDisconnectRequest.kt index b32d40c8..db7bbe3a 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject4.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkDisconnectRequest.kt @@ -20,7 +20,7 @@ import com.squareup.moshi.JsonClass * @param force Force the container to disconnect from the network. */ @JsonClass(generateAdapter = true) -data class InlineObject4( +data class NetworkDisconnectRequest( /* The ID or name of the container to disconnect from the network. */ @Json(name = "Container") val container: kotlin.String? = null, diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkSettings.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkSettings.kt index 9845251e..f78109a7 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkSettings.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/NetworkSettings.kt @@ -16,7 +16,7 @@ import com.squareup.moshi.JsonClass /** * NetworkSettings exposes the network settings in the API - * @param bridge Name of the network'a bridge (for example, `docker0`). + * @param bridge Name of the network's bridge (for example, `docker0`). * @param sandboxID SandboxID uniquely represents a container's network stack. * @param hairpinMode Indicates if hairpin NAT should be enabled on the virtual interface. * @param linkLocalIPv6Address IPv6 unicast address using the link-local prefix. @@ -37,7 +37,7 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class NetworkSettings( - /* Name of the network'a bridge (for example, `docker0`). */ + /* Name of the network's bridge (for example, `docker0`). */ @Json(name = "Bridge") val bridge: kotlin.String? = null, /* SandboxID uniquely represents a container's network stack. */ diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponseDescriptor.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/OCIDescriptor.kt similarity index 82% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponseDescriptor.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/OCIDescriptor.kt index 4a5fda4c..01d0ebbe 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponseDescriptor.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/OCIDescriptor.kt @@ -15,20 +15,20 @@ import com.squareup.moshi.Json import com.squareup.moshi.JsonClass /** - * A descriptor struct containing digest, media type, and size. - * @param mediaType - * @param size - * @param digest - * @param urLs + * A descriptor struct containing digest, media type, and size, as defined in the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md). + * @param mediaType The media type of the object this schema refers to. + * @param digest The digest of the targeted content. + * @param size The size in bytes of the blob. */ @JsonClass(generateAdapter = true) -data class DistributionInspectResponseDescriptor( - @Json(name = "MediaType") +data class OCIDescriptor( + /* The media type of the object this schema refers to. */ + @Json(name = "mediaType") val mediaType: kotlin.String? = null, - @Json(name = "Size") - val size: kotlin.Long? = null, - @Json(name = "Digest") + /* The digest of the targeted content. */ + @Json(name = "digest") val digest: kotlin.String? = null, - @Json(name = "URLs") - val urLs: kotlin.collections.List? = null + /* The size in bytes of the blob. */ + @Json(name = "size") + val size: kotlin.Long? = null ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponsePlatforms.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/OCIPlatform.kt similarity index 68% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponsePlatforms.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/OCIPlatform.kt index 13dcf3da..fa310196 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/DistributionInspectResponsePlatforms.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/OCIPlatform.kt @@ -15,26 +15,28 @@ import com.squareup.moshi.Json import com.squareup.moshi.JsonClass /** - * - * @param architecture - * @param OS - * @param osVersion - * @param osFeatures - * @param variant - * @param features + * Describes the platform which the image in the manifest runs on, as defined in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md). + * @param architecture The CPU architecture, for example `amd64` or `ppc64`. + * @param os The operating system, for example `linux` or `windows`. + * @param osVersion Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. + * @param osFeatures Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). + * @param variant Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. */ @JsonClass(generateAdapter = true) -data class DistributionInspectResponsePlatforms( - @Json(name = "Architecture") +data class OCIPlatform( + /* The CPU architecture, for example `amd64` or `ppc64`. */ + @Json(name = "architecture") val architecture: kotlin.String? = null, - @Json(name = "OS") - val OS: kotlin.String? = null, - @Json(name = "OSVersion") + /* The operating system, for example `linux` or `windows`. */ + @Json(name = "os") + val os: kotlin.String? = null, + /* Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. */ + @Json(name = "os.version") val osVersion: kotlin.String? = null, - @Json(name = "OSFeatures") + /* Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). */ + @Json(name = "os.features") val osFeatures: kotlin.collections.List? = null, - @Json(name = "Variant") - val variant: kotlin.String? = null, - @Json(name = "Features") - val features: kotlin.collections.List? = null + /* Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. */ + @Json(name = "variant") + val variant: kotlin.String? = null ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilegeItem.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilege.kt similarity index 99% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilegeItem.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilege.kt index d28413ee..05c3b2be 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilegeItem.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/PluginPrivilege.kt @@ -21,7 +21,7 @@ import com.squareup.moshi.JsonClass * @param value */ @JsonClass(generateAdapter = true) -data class PluginPrivilegeItem( +data class PluginPrivilege( @Json(name = "Name") val name: kotlin.String? = null, @Json(name = "Description") diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/RestartPolicy.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/RestartPolicy.kt index 4484ef4f..6faff6af 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/RestartPolicy.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/RestartPolicy.kt @@ -16,12 +16,12 @@ import com.squareup.moshi.JsonClass /** * The behavior to apply when the container exits. The default is not to restart. An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server. - * @param name - Empty string means not to restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero + * @param name - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero * @param maximumRetryCount If `on-failure` is used, the number of times to retry before giving up. */ @JsonClass(generateAdapter = true) data class RestartPolicy( - /* - Empty string means not to restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero */ + /* - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero */ @Json(name = "Name") val name: RestartPolicy.Name? = null, /* If `on-failure` is used, the number of times to retry before giving up. */ @@ -30,11 +30,12 @@ data class RestartPolicy( ) { /** - * - Empty string means not to restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero - * Values: EMPTY,Always,UnlessMinusStopped,OnMinusFailure + * - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero + * Values: EMPTY,No,Always,UnlessMinusStopped,OnMinusFailure */ enum class Name(val value: kotlin.String) { @Json(name = "") EMPTY(""), + @Json(name = "no") No("no"), @Json(name = "always") Always("always"), @Json(name = "unless-stopped") UnlessMinusStopped("unless-stopped"), @Json(name = "on-failure") OnMinusFailure("on-failure"); diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject5.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmInitRequest.kt similarity index 99% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject5.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmInitRequest.kt index f7b06425..07edf000 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject5.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmInitRequest.kt @@ -26,7 +26,7 @@ import com.squareup.moshi.JsonClass * @param spec */ @JsonClass(generateAdapter = true) -data class InlineObject5( +data class SwarmInitRequest( /* Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. */ @Json(name = "ListenAddr") val listenAddr: kotlin.String? = null, diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject6.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmJoinRequest.kt similarity index 87% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject6.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmJoinRequest.kt index cf84eac5..4480036d 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject6.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmJoinRequest.kt @@ -18,19 +18,19 @@ import com.squareup.moshi.JsonClass * * @param listenAddr Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). * @param advertiseAddr Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. - * @param dataPathAddr Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same addres as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. + * @param dataPathAddr Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. * @param remoteAddrs Addresses of manager nodes already participating in the swarm. * @param joinToken Secret token for joining this swarm. */ @JsonClass(generateAdapter = true) -data class InlineObject6( +data class SwarmJoinRequest( /* Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). */ @Json(name = "ListenAddr") val listenAddr: kotlin.String? = null, /* Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. */ @Json(name = "AdvertiseAddr") val advertiseAddr: kotlin.String? = null, - /* Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same addres as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. */ + /* Address or interface to use for data path traffic (format: ``), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. */ @Json(name = "DataPathAddr") val dataPathAddr: kotlin.String? = null, /* Addresses of manager nodes already participating in the swarm. */ diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject7.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmUnlockRequest.kt similarity index 98% rename from api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject7.kt rename to api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmUnlockRequest.kt index 742e9d1d..9710b2d9 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/InlineObject7.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SwarmUnlockRequest.kt @@ -19,7 +19,7 @@ import com.squareup.moshi.JsonClass * @param unlockKey The swarm's unlock key. */ @JsonClass(generateAdapter = true) -data class InlineObject7( +data class SwarmUnlockRequest( /* The swarm's unlock key. */ @Json(name = "UnlockKey") val unlockKey: kotlin.String? = null diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemDataUsageResponse.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemDataUsageResponse.kt index 10d73d73..c3376326 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemDataUsageResponse.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemDataUsageResponse.kt @@ -29,7 +29,7 @@ data class SystemDataUsageResponse( @Json(name = "Images") val images: kotlin.collections.List? = null, @Json(name = "Containers") - val containers: kotlin.collections.List>? = null, + val containers: kotlin.collections.List? = null, @Json(name = "Volumes") val volumes: kotlin.collections.List? = null, @Json(name = "BuildCache") diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemInfo.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemInfo.kt index 0ebf2916..d878d335 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemInfo.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/SystemInfo.kt @@ -62,7 +62,7 @@ import com.squareup.moshi.JsonClass * @param name Hostname of the host. * @param labels User-defined labels (key/value metadata) as set on the daemon.


> **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. * @param experimentalBuild Indicates if experimental features are enabled on the daemon. - * @param serverVersion Version string of the daemon. > **Note**: the [standalone Swarm API](/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. + * @param serverVersion Version string of the daemon. > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. * @param clusterStore URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism.


> **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. * @param clusterAdvertise The network endpoint that the Engine advertises for the purpose of node discovery. ClusterAdvertise is a `host:port` combination on which the daemon is reachable by other hosts.


> **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. * @param runtimes List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. @@ -217,7 +217,7 @@ data class SystemInfo( /* Indicates if experimental features are enabled on the daemon. */ @Json(name = "ExperimentalBuild") val experimentalBuild: kotlin.Boolean? = null, - /* Version string of the daemon. > **Note**: the [standalone Swarm API](/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. */ + /* Version string of the daemon. > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. */ @Json(name = "ServerVersion") val serverVersion: kotlin.String? = null, /* URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism.


> **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. */ diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/TaskSpecPluginSpec.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/TaskSpecPluginSpec.kt index 85652a86..fb09fb2c 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/TaskSpecPluginSpec.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/TaskSpecPluginSpec.kt @@ -33,5 +33,5 @@ data class TaskSpecPluginSpec( @Json(name = "Disabled") val disabled: kotlin.Boolean? = null, @Json(name = "PluginPrivilege") - val pluginPrivilege: kotlin.collections.List? = null + val pluginPrivilege: kotlin.collections.List? = null ) diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/Volume.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/Volume.kt index 93bad1b6..b0d9a413 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/Volume.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/Volume.kt @@ -39,13 +39,13 @@ data class Volume( val mountpoint: kotlin.String, /* User-defined key/value metadata. */ @Json(name = "Labels") - val labels: kotlin.collections.Map, + val labels: kotlin.collections.Map?, /* The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. */ @Json(name = "Scope") - val scope: Volume.Scope, + val scope: Volume.Scope?, /* The driver specific options used when creating the volume. */ @Json(name = "Options") - val options: kotlin.collections.Map, + val options: kotlin.collections.Map?, /* Date/Time the volume was created. */ @Json(name = "CreatedAt") val createdAt: kotlin.String? = null, diff --git a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/VolumeListResponse.kt b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/VolumeListResponse.kt index 82b471e5..bbc8d3c6 100644 --- a/api-model/src/main/kotlin/de/gesellix/docker/engine/model/VolumeListResponse.kt +++ b/api-model/src/main/kotlin/de/gesellix/docker/engine/model/VolumeListResponse.kt @@ -26,5 +26,5 @@ data class VolumeListResponse( val volumes: kotlin.collections.List, /* Warnings that occurred when fetching the list of volumes. */ @Json(name = "Warnings") - val warnings: kotlin.collections.List + val warnings: kotlin.collections.List? )