diff --git a/api-model-v1-44/.openapi-generator-ignore b/api-model-v1-44/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/api-model-v1-44/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/api-model-v1-44/.openapi-generator/FILES b/api-model-v1-44/.openapi-generator/FILES new file mode 100644 index 00000000..24401b1b --- /dev/null +++ b/api-model-v1-44/.openapi-generator/FILES @@ -0,0 +1,472 @@ +README.md +build.gradle +docs/Address.md +docs/AuthConfig.md +docs/BuildCache.md +docs/BuildInfo.md +docs/BuildPruneResponse.md +docs/ChangeType.md +docs/ClusterInfo.md +docs/ClusterVolume.md +docs/ClusterVolumeInfo.md +docs/ClusterVolumePublishStatusInner.md +docs/ClusterVolumeSpec.md +docs/ClusterVolumeSpecAccessMode.md +docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md +docs/ClusterVolumeSpecAccessModeCapacityRange.md +docs/ClusterVolumeSpecAccessModeSecretsInner.md +docs/Commit.md +docs/Config.md +docs/ConfigApi.md +docs/ConfigCreateRequest.md +docs/ConfigReference.md +docs/ConfigSpec.md +docs/ContainerApi.md +docs/ContainerConfig.md +docs/ContainerCreateRequest.md +docs/ContainerCreateResponse.md +docs/ContainerInspectResponse.md +docs/ContainerPruneResponse.md +docs/ContainerState.md +docs/ContainerStatus.md +docs/ContainerSummary.md +docs/ContainerSummaryHostConfig.md +docs/ContainerSummaryNetworkSettings.md +docs/ContainerTopResponse.md +docs/ContainerUpdateRequest.md +docs/ContainerUpdateResponse.md +docs/ContainerWaitExitError.md +docs/ContainerWaitResponse.md +docs/CreateImageInfo.md +docs/DeviceMapping.md +docs/DeviceRequest.md +docs/DistributionApi.md +docs/DistributionInspect.md +docs/Driver.md +docs/EndpointIPAMConfig.md +docs/EndpointPortConfig.md +docs/EndpointSettings.md +docs/EndpointSpec.md +docs/EngineDescription.md +docs/EngineDescriptionPluginsInner.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/FilesystemChange.md +docs/GenericResourcesInner.md +docs/GenericResourcesInnerDiscreteResourceSpec.md +docs/GenericResourcesInnerNamedResourceSpec.md +docs/GraphDriverData.md +docs/Health.md +docs/HealthConfig.md +docs/HealthcheckResult.md +docs/HistoryResponseItem.md +docs/HostConfig.md +docs/HostConfigAllOfLogConfig.md +docs/IPAM.md +docs/IPAMConfig.md +docs/IdResponse.md +docs/ImageApi.md +docs/ImageConfig.md +docs/ImageDeleteResponseItem.md +docs/ImageID.md +docs/ImageInspect.md +docs/ImageInspectMetadata.md +docs/ImageInspectRootFS.md +docs/ImagePruneResponse.md +docs/ImageSearchResponseItem.md +docs/ImageSummary.md +docs/IndexInfo.md +docs/JoinTokens.md +docs/Limit.md +docs/LocalNodeState.md +docs/ManagerStatus.md +docs/Mount.md +docs/MountBindOptions.md +docs/MountPoint.md +docs/MountTmpfsOptions.md +docs/MountVolumeOptions.md +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 +docs/Node.md +docs/NodeApi.md +docs/NodeDescription.md +docs/NodeSpec.md +docs/NodeState.md +docs/NodeStatus.md +docs/OCIDescriptor.md +docs/OCIPlatform.md +docs/ObjectVersion.md +docs/PeerInfo.md +docs/PeerNode.md +docs/Platform.md +docs/Plugin.md +docs/PluginApi.md +docs/PluginConfig.md +docs/PluginConfigArgs.md +docs/PluginConfigInterface.md +docs/PluginConfigLinux.md +docs/PluginConfigNetwork.md +docs/PluginConfigRootfs.md +docs/PluginConfigUser.md +docs/PluginDevice.md +docs/PluginEnv.md +docs/PluginInterfaceType.md +docs/PluginMount.md +docs/PluginPrivilege.md +docs/PluginSettings.md +docs/PluginsInfo.md +docs/Port.md +docs/PortBinding.md +docs/PortStatus.md +docs/ProcessConfig.md +docs/ProgressDetail.md +docs/PushImageInfo.md +docs/Reachability.md +docs/RegistryServiceConfig.md +docs/ResourceObject.md +docs/Resources.md +docs/ResourcesBlkioWeightDeviceInner.md +docs/ResourcesUlimitsInner.md +docs/RestartPolicy.md +docs/Runtime.md +docs/Secret.md +docs/SecretApi.md +docs/SecretCreateRequest.md +docs/SecretSpec.md +docs/Service.md +docs/ServiceApi.md +docs/ServiceCreateRequest.md +docs/ServiceCreateResponse.md +docs/ServiceEndpoint.md +docs/ServiceEndpointVirtualIPsInner.md +docs/ServiceJobStatus.md +docs/ServiceServiceStatus.md +docs/ServiceSpec.md +docs/ServiceSpecMode.md +docs/ServiceSpecModeReplicated.md +docs/ServiceSpecModeReplicatedJob.md +docs/ServiceSpecRollbackConfig.md +docs/ServiceSpecUpdateConfig.md +docs/ServiceUpdateRequest.md +docs/ServiceUpdateResponse.md +docs/ServiceUpdateStatus.md +docs/SessionApi.md +docs/Swarm.md +docs/SwarmApi.md +docs/SwarmInfo.md +docs/SwarmInitRequest.md +docs/SwarmJoinRequest.md +docs/SwarmSpec.md +docs/SwarmSpecCAConfig.md +docs/SwarmSpecCAConfigExternalCAsInner.md +docs/SwarmSpecDispatcher.md +docs/SwarmSpecEncryptionConfig.md +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/SystemInfo.md +docs/SystemInfoDefaultAddressPoolsInner.md +docs/SystemVersion.md +docs/SystemVersionComponentsInner.md +docs/SystemVersionPlatform.md +docs/TLSInfo.md +docs/Task.md +docs/TaskApi.md +docs/TaskSpec.md +docs/TaskSpecContainerSpec.md +docs/TaskSpecContainerSpecConfigsInner.md +docs/TaskSpecContainerSpecConfigsInnerFile.md +docs/TaskSpecContainerSpecDNSConfig.md +docs/TaskSpecContainerSpecPrivileges.md +docs/TaskSpecContainerSpecPrivilegesAppArmor.md +docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md +docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md +docs/TaskSpecContainerSpecPrivilegesSeccomp.md +docs/TaskSpecContainerSpecSecretsInner.md +docs/TaskSpecContainerSpecSecretsInnerFile.md +docs/TaskSpecLogDriver.md +docs/TaskSpecNetworkAttachmentSpec.md +docs/TaskSpecPlacement.md +docs/TaskSpecPlacementPreferencesInner.md +docs/TaskSpecPlacementPreferencesInnerSpread.md +docs/TaskSpecPluginSpec.md +docs/TaskSpecResources.md +docs/TaskSpecRestartPolicy.md +docs/TaskState.md +docs/TaskStatus.md +docs/ThrottleDevice.md +docs/UnlockKeyResponse.md +docs/Volume.md +docs/VolumeApi.md +docs/VolumeCreateOptions.md +docs/VolumeListResponse.md +docs/VolumePruneResponse.md +docs/VolumeUpdateRequest.md +docs/VolumeUsageData.md +gradle/wrapper/gradle-wrapper.jar +gradle/wrapper/gradle-wrapper.properties +gradlew +gradlew.bat +settings.gradle +src/main/kotlin/de/gesellix/docker/remote/api/Address.kt +src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt +src/main/kotlin/de/gesellix/docker/remote/api/Config.kt +src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt +src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt +src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt +src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt +src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt +src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt +src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt +src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt +src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt +src/main/kotlin/de/gesellix/docker/remote/api/Health.kt +src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt +src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt +src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt +src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt +src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt +src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt +src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/Network.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/Node.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt +src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt +src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt +src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt +src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt +src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/Port.kt +src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt +src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt +src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt +src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt +src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt +src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt +src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt +src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt +src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/Service.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt +src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/Task.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt +src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ApiAbstractions.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ApiClient.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ApiResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/BigDecimalAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/BigIntegerAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ByteArrayAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/Errors.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/LocalDateAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/LocalDateTimeAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/OffsetDateTimeAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/PartConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/RequestConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/RequestMethod.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ResponseExtensions.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/Serializer.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/URIAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/UUIDAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ConfigApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ContainerApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/DistributionApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ExecApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ImageApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/NetworkApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/NodeApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/PluginApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SecretApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ServiceApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SessionApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SwarmApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SystemApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/TaskApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/VolumeApi.kt diff --git a/api-model-v1-44/.openapi-generator/VERSION b/api-model-v1-44/.openapi-generator/VERSION new file mode 100644 index 00000000..6328c542 --- /dev/null +++ b/api-model-v1-44/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.17.0 diff --git a/api-model-v1-44/README.md b/api-model-v1-44/README.md new file mode 100644 index 00000000..9773c4d0 --- /dev/null +++ b/api-model-v1-44/README.md @@ -0,0 +1,445 @@ +# de.gesellix.docker.remote.api - Kotlin client library for 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.44) is used. +For example, calling `/info` is the same as calling `/v1.44/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\", + \"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...\" +} +``` + + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client. + +- API version: 1.44 +- Package version: +- Generator version: 7.17.0 +- Build package: org.openapitools.codegen.languages.KotlinClientCodegen + +## Requires + +* Kotlin 2.2.20 +* Gradle 8.14 + +## Build + +First, create the gradle wrapper script: + +``` +gradle wrapper +``` + +Then, run: + +``` +./gradlew check assemble +``` + +This runs all tests and packages the library. + +## Features/Implementation Notes + +* Supports JSON inputs/outputs, File inputs, and Form inputs. +* Supports collection formats for query parameters: csv, tsv, ssv, pipes. +* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions. +* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets. + + +## Documentation for API Endpoints + +All URIs are relative to *http://localhost/v1.44* + +| Class | Method | HTTP request | Description | +| ------------ | ------------- | ------------- | ------------- | +| *ConfigApi* | [**configCreate**](docs/ConfigApi.md#configcreate) | **POST** /configs/create | Create a config | +| *ConfigApi* | [**configDelete**](docs/ConfigApi.md#configdelete) | **DELETE** /configs/{id} | Delete a config | +| *ConfigApi* | [**configInspect**](docs/ConfigApi.md#configinspect) | **GET** /configs/{id} | Inspect a config | +| *ConfigApi* | [**configList**](docs/ConfigApi.md#configlist) | **GET** /configs | List configs | +| *ConfigApi* | [**configUpdate**](docs/ConfigApi.md#configupdate) | **POST** /configs/{id}/update | Update a Config | +| *ContainerApi* | [**containerArchive**](docs/ContainerApi.md#containerarchive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container | +| *ContainerApi* | [**containerArchiveInfo**](docs/ContainerApi.md#containerarchiveinfo) | **HEAD** /containers/{id}/archive | Get information about files in a container | +| *ContainerApi* | [**containerAttach**](docs/ContainerApi.md#containerattach) | **POST** /containers/{id}/attach | Attach to a container | +| *ContainerApi* | [**containerAttachWebsocket**](docs/ContainerApi.md#containerattachwebsocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket | +| *ContainerApi* | [**containerChanges**](docs/ContainerApi.md#containerchanges) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem | +| *ContainerApi* | [**containerCreate**](docs/ContainerApi.md#containercreate) | **POST** /containers/create | Create a container | +| *ContainerApi* | [**containerDelete**](docs/ContainerApi.md#containerdelete) | **DELETE** /containers/{id} | Remove a container | +| *ContainerApi* | [**containerExport**](docs/ContainerApi.md#containerexport) | **GET** /containers/{id}/export | Export a container | +| *ContainerApi* | [**containerInspect**](docs/ContainerApi.md#containerinspect) | **GET** /containers/{id}/json | Inspect a container | +| *ContainerApi* | [**containerKill**](docs/ContainerApi.md#containerkill) | **POST** /containers/{id}/kill | Kill a container | +| *ContainerApi* | [**containerList**](docs/ContainerApi.md#containerlist) | **GET** /containers/json | List containers | +| *ContainerApi* | [**containerLogs**](docs/ContainerApi.md#containerlogs) | **GET** /containers/{id}/logs | Get container logs | +| *ContainerApi* | [**containerPause**](docs/ContainerApi.md#containerpause) | **POST** /containers/{id}/pause | Pause a container | +| *ContainerApi* | [**containerPrune**](docs/ContainerApi.md#containerprune) | **POST** /containers/prune | Delete stopped containers | +| *ContainerApi* | [**containerRename**](docs/ContainerApi.md#containerrename) | **POST** /containers/{id}/rename | Rename a container | +| *ContainerApi* | [**containerResize**](docs/ContainerApi.md#containerresize) | **POST** /containers/{id}/resize | Resize a container TTY | +| *ContainerApi* | [**containerRestart**](docs/ContainerApi.md#containerrestart) | **POST** /containers/{id}/restart | Restart a container | +| *ContainerApi* | [**containerStart**](docs/ContainerApi.md#containerstart) | **POST** /containers/{id}/start | Start a container | +| *ContainerApi* | [**containerStats**](docs/ContainerApi.md#containerstats) | **GET** /containers/{id}/stats | Get container stats based on resource usage | +| *ContainerApi* | [**containerStop**](docs/ContainerApi.md#containerstop) | **POST** /containers/{id}/stop | Stop a container | +| *ContainerApi* | [**containerTop**](docs/ContainerApi.md#containertop) | **GET** /containers/{id}/top | List processes running inside a container | +| *ContainerApi* | [**containerUnpause**](docs/ContainerApi.md#containerunpause) | **POST** /containers/{id}/unpause | Unpause a container | +| *ContainerApi* | [**containerUpdate**](docs/ContainerApi.md#containerupdate) | **POST** /containers/{id}/update | Update a container | +| *ContainerApi* | [**containerWait**](docs/ContainerApi.md#containerwait) | **POST** /containers/{id}/wait | Wait for a container | +| *ContainerApi* | [**putContainerArchive**](docs/ContainerApi.md#putcontainerarchive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container | +| *DistributionApi* | [**distributionInspect**](docs/DistributionApi.md#distributioninspect) | **GET** /distribution/{name}/json | Get image information from the registry | +| *ExecApi* | [**containerExec**](docs/ExecApi.md#containerexec) | **POST** /containers/{id}/exec | Create an exec instance | +| *ExecApi* | [**execInspect**](docs/ExecApi.md#execinspect) | **GET** /exec/{id}/json | Inspect an exec instance | +| *ExecApi* | [**execResize**](docs/ExecApi.md#execresize) | **POST** /exec/{id}/resize | Resize an exec instance | +| *ExecApi* | [**execStart**](docs/ExecApi.md#execstart) | **POST** /exec/{id}/start | Start an exec instance | +| *ImageApi* | [**buildPrune**](docs/ImageApi.md#buildprune) | **POST** /build/prune | Delete builder cache | +| *ImageApi* | [**imageBuild**](docs/ImageApi.md#imagebuild) | **POST** /build | Build an image | +| *ImageApi* | [**imageCommit**](docs/ImageApi.md#imagecommit) | **POST** /commit | Create a new image from a container | +| *ImageApi* | [**imageCreate**](docs/ImageApi.md#imagecreate) | **POST** /images/create | Create an image | +| *ImageApi* | [**imageDelete**](docs/ImageApi.md#imagedelete) | **DELETE** /images/{name} | Remove an image | +| *ImageApi* | [**imageGet**](docs/ImageApi.md#imageget) | **GET** /images/{name}/get | Export an image | +| *ImageApi* | [**imageGetAll**](docs/ImageApi.md#imagegetall) | **GET** /images/get | Export several images | +| *ImageApi* | [**imageHistory**](docs/ImageApi.md#imagehistory) | **GET** /images/{name}/history | Get the history of an image | +| *ImageApi* | [**imageInspect**](docs/ImageApi.md#imageinspect) | **GET** /images/{name}/json | Inspect an image | +| *ImageApi* | [**imageList**](docs/ImageApi.md#imagelist) | **GET** /images/json | List Images | +| *ImageApi* | [**imageLoad**](docs/ImageApi.md#imageload) | **POST** /images/load | Import images | +| *ImageApi* | [**imagePrune**](docs/ImageApi.md#imageprune) | **POST** /images/prune | Delete unused images | +| *ImageApi* | [**imagePush**](docs/ImageApi.md#imagepush) | **POST** /images/{name}/push | Push an image | +| *ImageApi* | [**imageSearch**](docs/ImageApi.md#imagesearch) | **GET** /images/search | Search images | +| *ImageApi* | [**imageTag**](docs/ImageApi.md#imagetag) | **POST** /images/{name}/tag | Tag an image | +| *NetworkApi* | [**networkConnect**](docs/NetworkApi.md#networkconnect) | **POST** /networks/{id}/connect | Connect a container to a network | +| *NetworkApi* | [**networkCreate**](docs/NetworkApi.md#networkcreate) | **POST** /networks/create | Create a network | +| *NetworkApi* | [**networkDelete**](docs/NetworkApi.md#networkdelete) | **DELETE** /networks/{id} | Remove a network | +| *NetworkApi* | [**networkDisconnect**](docs/NetworkApi.md#networkdisconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network | +| *NetworkApi* | [**networkInspect**](docs/NetworkApi.md#networkinspect) | **GET** /networks/{id} | Inspect a network | +| *NetworkApi* | [**networkList**](docs/NetworkApi.md#networklist) | **GET** /networks | List networks | +| *NetworkApi* | [**networkPrune**](docs/NetworkApi.md#networkprune) | **POST** /networks/prune | Delete unused networks | +| *NodeApi* | [**nodeDelete**](docs/NodeApi.md#nodedelete) | **DELETE** /nodes/{id} | Delete a node | +| *NodeApi* | [**nodeInspect**](docs/NodeApi.md#nodeinspect) | **GET** /nodes/{id} | Inspect a node | +| *NodeApi* | [**nodeList**](docs/NodeApi.md#nodelist) | **GET** /nodes | List nodes | +| *NodeApi* | [**nodeUpdate**](docs/NodeApi.md#nodeupdate) | **POST** /nodes/{id}/update | Update a node | +| *PluginApi* | [**getPluginPrivileges**](docs/PluginApi.md#getpluginprivileges) | **GET** /plugins/privileges | Get plugin privileges | +| *PluginApi* | [**pluginCreate**](docs/PluginApi.md#plugincreate) | **POST** /plugins/create | Create a plugin | +| *PluginApi* | [**pluginDelete**](docs/PluginApi.md#plugindelete) | **DELETE** /plugins/{name} | Remove a plugin | +| *PluginApi* | [**pluginDisable**](docs/PluginApi.md#plugindisable) | **POST** /plugins/{name}/disable | Disable a plugin | +| *PluginApi* | [**pluginEnable**](docs/PluginApi.md#pluginenable) | **POST** /plugins/{name}/enable | Enable a plugin | +| *PluginApi* | [**pluginInspect**](docs/PluginApi.md#plugininspect) | **GET** /plugins/{name}/json | Inspect a plugin | +| *PluginApi* | [**pluginList**](docs/PluginApi.md#pluginlist) | **GET** /plugins | List plugins | +| *PluginApi* | [**pluginPull**](docs/PluginApi.md#pluginpull) | **POST** /plugins/pull | Install a plugin | +| *PluginApi* | [**pluginPush**](docs/PluginApi.md#pluginpush) | **POST** /plugins/{name}/push | Push a plugin | +| *PluginApi* | [**pluginSet**](docs/PluginApi.md#pluginset) | **POST** /plugins/{name}/set | Configure a plugin | +| *PluginApi* | [**pluginUpgrade**](docs/PluginApi.md#pluginupgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin | +| *SecretApi* | [**secretCreate**](docs/SecretApi.md#secretcreate) | **POST** /secrets/create | Create a secret | +| *SecretApi* | [**secretDelete**](docs/SecretApi.md#secretdelete) | **DELETE** /secrets/{id} | Delete a secret | +| *SecretApi* | [**secretInspect**](docs/SecretApi.md#secretinspect) | **GET** /secrets/{id} | Inspect a secret | +| *SecretApi* | [**secretList**](docs/SecretApi.md#secretlist) | **GET** /secrets | List secrets | +| *SecretApi* | [**secretUpdate**](docs/SecretApi.md#secretupdate) | **POST** /secrets/{id}/update | Update a Secret | +| *ServiceApi* | [**serviceCreate**](docs/ServiceApi.md#servicecreate) | **POST** /services/create | Create a service | +| *ServiceApi* | [**serviceDelete**](docs/ServiceApi.md#servicedelete) | **DELETE** /services/{id} | Delete a service | +| *ServiceApi* | [**serviceInspect**](docs/ServiceApi.md#serviceinspect) | **GET** /services/{id} | Inspect a service | +| *ServiceApi* | [**serviceList**](docs/ServiceApi.md#servicelist) | **GET** /services | List services | +| *ServiceApi* | [**serviceLogs**](docs/ServiceApi.md#servicelogs) | **GET** /services/{id}/logs | Get service logs | +| *ServiceApi* | [**serviceUpdate**](docs/ServiceApi.md#serviceupdate) | **POST** /services/{id}/update | Update a service | +| *SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session | +| *SwarmApi* | [**swarmInit**](docs/SwarmApi.md#swarminit) | **POST** /swarm/init | Initialize a new swarm | +| *SwarmApi* | [**swarmInspect**](docs/SwarmApi.md#swarminspect) | **GET** /swarm | Inspect swarm | +| *SwarmApi* | [**swarmJoin**](docs/SwarmApi.md#swarmjoin) | **POST** /swarm/join | Join an existing swarm | +| *SwarmApi* | [**swarmLeave**](docs/SwarmApi.md#swarmleave) | **POST** /swarm/leave | Leave a swarm | +| *SwarmApi* | [**swarmUnlock**](docs/SwarmApi.md#swarmunlock) | **POST** /swarm/unlock | Unlock a locked manager | +| *SwarmApi* | [**swarmUnlockkey**](docs/SwarmApi.md#swarmunlockkey) | **GET** /swarm/unlockkey | Get the unlock key | +| *SwarmApi* | [**swarmUpdate**](docs/SwarmApi.md#swarmupdate) | **POST** /swarm/update | Update a swarm | +| *SystemApi* | [**systemAuth**](docs/SystemApi.md#systemauth) | **POST** /auth | Check auth configuration | +| *SystemApi* | [**systemDataUsage**](docs/SystemApi.md#systemdatausage) | **GET** /system/df | Get data usage information | +| *SystemApi* | [**systemEvents**](docs/SystemApi.md#systemevents) | **GET** /events | Monitor events | +| *SystemApi* | [**systemInfo**](docs/SystemApi.md#systeminfo) | **GET** /info | Get system information | +| *SystemApi* | [**systemPing**](docs/SystemApi.md#systemping) | **GET** /_ping | Ping | +| *SystemApi* | [**systemPingHead**](docs/SystemApi.md#systempinghead) | **HEAD** /_ping | Ping | +| *SystemApi* | [**systemVersion**](docs/SystemApi.md#systemversion) | **GET** /version | Get version | +| *TaskApi* | [**taskInspect**](docs/TaskApi.md#taskinspect) | **GET** /tasks/{id} | Inspect a task | +| *TaskApi* | [**taskList**](docs/TaskApi.md#tasklist) | **GET** /tasks | List tasks | +| *TaskApi* | [**taskLogs**](docs/TaskApi.md#tasklogs) | **GET** /tasks/{id}/logs | Get task logs | +| *VolumeApi* | [**volumeCreate**](docs/VolumeApi.md#volumecreate) | **POST** /volumes/create | Create a volume | +| *VolumeApi* | [**volumeDelete**](docs/VolumeApi.md#volumedelete) | **DELETE** /volumes/{name} | Remove a volume | +| *VolumeApi* | [**volumeInspect**](docs/VolumeApi.md#volumeinspect) | **GET** /volumes/{name} | Inspect a volume | +| *VolumeApi* | [**volumeList**](docs/VolumeApi.md#volumelist) | **GET** /volumes | List volumes | +| *VolumeApi* | [**volumePrune**](docs/VolumeApi.md#volumeprune) | **POST** /volumes/prune | Delete unused volumes | +| *VolumeApi* | [**volumeUpdate**](docs/VolumeApi.md#volumeupdate) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\" | + + + +## Documentation for Models + + - [de.gesellix.docker.remote.api.Address](docs/Address.md) + - [de.gesellix.docker.remote.api.AuthConfig](docs/AuthConfig.md) + - [de.gesellix.docker.remote.api.BuildCache](docs/BuildCache.md) + - [de.gesellix.docker.remote.api.BuildInfo](docs/BuildInfo.md) + - [de.gesellix.docker.remote.api.BuildPruneResponse](docs/BuildPruneResponse.md) + - [de.gesellix.docker.remote.api.ChangeType](docs/ChangeType.md) + - [de.gesellix.docker.remote.api.ClusterInfo](docs/ClusterInfo.md) + - [de.gesellix.docker.remote.api.ClusterVolume](docs/ClusterVolume.md) + - [de.gesellix.docker.remote.api.ClusterVolumeInfo](docs/ClusterVolumeInfo.md) + - [de.gesellix.docker.remote.api.ClusterVolumePublishStatusInner](docs/ClusterVolumePublishStatusInner.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpec](docs/ClusterVolumeSpec.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessMode](docs/ClusterVolumeSpecAccessMode.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessModeAccessibilityRequirements](docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessModeCapacityRange](docs/ClusterVolumeSpecAccessModeCapacityRange.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessModeSecretsInner](docs/ClusterVolumeSpecAccessModeSecretsInner.md) + - [de.gesellix.docker.remote.api.Commit](docs/Commit.md) + - [de.gesellix.docker.remote.api.Config](docs/Config.md) + - [de.gesellix.docker.remote.api.ConfigCreateRequest](docs/ConfigCreateRequest.md) + - [de.gesellix.docker.remote.api.ConfigReference](docs/ConfigReference.md) + - [de.gesellix.docker.remote.api.ConfigSpec](docs/ConfigSpec.md) + - [de.gesellix.docker.remote.api.ContainerConfig](docs/ContainerConfig.md) + - [de.gesellix.docker.remote.api.ContainerCreateRequest](docs/ContainerCreateRequest.md) + - [de.gesellix.docker.remote.api.ContainerCreateResponse](docs/ContainerCreateResponse.md) + - [de.gesellix.docker.remote.api.ContainerInspectResponse](docs/ContainerInspectResponse.md) + - [de.gesellix.docker.remote.api.ContainerPruneResponse](docs/ContainerPruneResponse.md) + - [de.gesellix.docker.remote.api.ContainerState](docs/ContainerState.md) + - [de.gesellix.docker.remote.api.ContainerStatus](docs/ContainerStatus.md) + - [de.gesellix.docker.remote.api.ContainerSummary](docs/ContainerSummary.md) + - [de.gesellix.docker.remote.api.ContainerSummaryHostConfig](docs/ContainerSummaryHostConfig.md) + - [de.gesellix.docker.remote.api.ContainerSummaryNetworkSettings](docs/ContainerSummaryNetworkSettings.md) + - [de.gesellix.docker.remote.api.ContainerTopResponse](docs/ContainerTopResponse.md) + - [de.gesellix.docker.remote.api.ContainerUpdateRequest](docs/ContainerUpdateRequest.md) + - [de.gesellix.docker.remote.api.ContainerUpdateResponse](docs/ContainerUpdateResponse.md) + - [de.gesellix.docker.remote.api.ContainerWaitExitError](docs/ContainerWaitExitError.md) + - [de.gesellix.docker.remote.api.ContainerWaitResponse](docs/ContainerWaitResponse.md) + - [de.gesellix.docker.remote.api.CreateImageInfo](docs/CreateImageInfo.md) + - [de.gesellix.docker.remote.api.DeviceMapping](docs/DeviceMapping.md) + - [de.gesellix.docker.remote.api.DeviceRequest](docs/DeviceRequest.md) + - [de.gesellix.docker.remote.api.DistributionInspect](docs/DistributionInspect.md) + - [de.gesellix.docker.remote.api.Driver](docs/Driver.md) + - [de.gesellix.docker.remote.api.EndpointIPAMConfig](docs/EndpointIPAMConfig.md) + - [de.gesellix.docker.remote.api.EndpointPortConfig](docs/EndpointPortConfig.md) + - [de.gesellix.docker.remote.api.EndpointSettings](docs/EndpointSettings.md) + - [de.gesellix.docker.remote.api.EndpointSpec](docs/EndpointSpec.md) + - [de.gesellix.docker.remote.api.EngineDescription](docs/EngineDescription.md) + - [de.gesellix.docker.remote.api.EngineDescriptionPluginsInner](docs/EngineDescriptionPluginsInner.md) + - [de.gesellix.docker.remote.api.ErrorDetail](docs/ErrorDetail.md) + - [de.gesellix.docker.remote.api.ErrorResponse](docs/ErrorResponse.md) + - [de.gesellix.docker.remote.api.EventActor](docs/EventActor.md) + - [de.gesellix.docker.remote.api.EventMessage](docs/EventMessage.md) + - [de.gesellix.docker.remote.api.ExecConfig](docs/ExecConfig.md) + - [de.gesellix.docker.remote.api.ExecInspectResponse](docs/ExecInspectResponse.md) + - [de.gesellix.docker.remote.api.ExecStartConfig](docs/ExecStartConfig.md) + - [de.gesellix.docker.remote.api.FilesystemChange](docs/FilesystemChange.md) + - [de.gesellix.docker.remote.api.GenericResourcesInner](docs/GenericResourcesInner.md) + - [de.gesellix.docker.remote.api.GenericResourcesInnerDiscreteResourceSpec](docs/GenericResourcesInnerDiscreteResourceSpec.md) + - [de.gesellix.docker.remote.api.GenericResourcesInnerNamedResourceSpec](docs/GenericResourcesInnerNamedResourceSpec.md) + - [de.gesellix.docker.remote.api.GraphDriverData](docs/GraphDriverData.md) + - [de.gesellix.docker.remote.api.Health](docs/Health.md) + - [de.gesellix.docker.remote.api.HealthConfig](docs/HealthConfig.md) + - [de.gesellix.docker.remote.api.HealthcheckResult](docs/HealthcheckResult.md) + - [de.gesellix.docker.remote.api.HistoryResponseItem](docs/HistoryResponseItem.md) + - [de.gesellix.docker.remote.api.HostConfig](docs/HostConfig.md) + - [de.gesellix.docker.remote.api.HostConfigAllOfLogConfig](docs/HostConfigAllOfLogConfig.md) + - [de.gesellix.docker.remote.api.IPAM](docs/IPAM.md) + - [de.gesellix.docker.remote.api.IPAMConfig](docs/IPAMConfig.md) + - [de.gesellix.docker.remote.api.IdResponse](docs/IdResponse.md) + - [de.gesellix.docker.remote.api.ImageConfig](docs/ImageConfig.md) + - [de.gesellix.docker.remote.api.ImageDeleteResponseItem](docs/ImageDeleteResponseItem.md) + - [de.gesellix.docker.remote.api.ImageID](docs/ImageID.md) + - [de.gesellix.docker.remote.api.ImageInspect](docs/ImageInspect.md) + - [de.gesellix.docker.remote.api.ImageInspectMetadata](docs/ImageInspectMetadata.md) + - [de.gesellix.docker.remote.api.ImageInspectRootFS](docs/ImageInspectRootFS.md) + - [de.gesellix.docker.remote.api.ImagePruneResponse](docs/ImagePruneResponse.md) + - [de.gesellix.docker.remote.api.ImageSearchResponseItem](docs/ImageSearchResponseItem.md) + - [de.gesellix.docker.remote.api.ImageSummary](docs/ImageSummary.md) + - [de.gesellix.docker.remote.api.IndexInfo](docs/IndexInfo.md) + - [de.gesellix.docker.remote.api.JoinTokens](docs/JoinTokens.md) + - [de.gesellix.docker.remote.api.Limit](docs/Limit.md) + - [de.gesellix.docker.remote.api.LocalNodeState](docs/LocalNodeState.md) + - [de.gesellix.docker.remote.api.ManagerStatus](docs/ManagerStatus.md) + - [de.gesellix.docker.remote.api.Mount](docs/Mount.md) + - [de.gesellix.docker.remote.api.MountBindOptions](docs/MountBindOptions.md) + - [de.gesellix.docker.remote.api.MountPoint](docs/MountPoint.md) + - [de.gesellix.docker.remote.api.MountTmpfsOptions](docs/MountTmpfsOptions.md) + - [de.gesellix.docker.remote.api.MountVolumeOptions](docs/MountVolumeOptions.md) + - [de.gesellix.docker.remote.api.MountVolumeOptionsDriverConfig](docs/MountVolumeOptionsDriverConfig.md) + - [de.gesellix.docker.remote.api.Network](docs/Network.md) + - [de.gesellix.docker.remote.api.NetworkAttachmentConfig](docs/NetworkAttachmentConfig.md) + - [de.gesellix.docker.remote.api.NetworkConnectRequest](docs/NetworkConnectRequest.md) + - [de.gesellix.docker.remote.api.NetworkContainer](docs/NetworkContainer.md) + - [de.gesellix.docker.remote.api.NetworkCreateRequest](docs/NetworkCreateRequest.md) + - [de.gesellix.docker.remote.api.NetworkCreateResponse](docs/NetworkCreateResponse.md) + - [de.gesellix.docker.remote.api.NetworkDisconnectRequest](docs/NetworkDisconnectRequest.md) + - [de.gesellix.docker.remote.api.NetworkPruneResponse](docs/NetworkPruneResponse.md) + - [de.gesellix.docker.remote.api.NetworkSettings](docs/NetworkSettings.md) + - [de.gesellix.docker.remote.api.NetworkingConfig](docs/NetworkingConfig.md) + - [de.gesellix.docker.remote.api.Node](docs/Node.md) + - [de.gesellix.docker.remote.api.NodeDescription](docs/NodeDescription.md) + - [de.gesellix.docker.remote.api.NodeSpec](docs/NodeSpec.md) + - [de.gesellix.docker.remote.api.NodeState](docs/NodeState.md) + - [de.gesellix.docker.remote.api.NodeStatus](docs/NodeStatus.md) + - [de.gesellix.docker.remote.api.OCIDescriptor](docs/OCIDescriptor.md) + - [de.gesellix.docker.remote.api.OCIPlatform](docs/OCIPlatform.md) + - [de.gesellix.docker.remote.api.ObjectVersion](docs/ObjectVersion.md) + - [de.gesellix.docker.remote.api.PeerInfo](docs/PeerInfo.md) + - [de.gesellix.docker.remote.api.PeerNode](docs/PeerNode.md) + - [de.gesellix.docker.remote.api.Platform](docs/Platform.md) + - [de.gesellix.docker.remote.api.Plugin](docs/Plugin.md) + - [de.gesellix.docker.remote.api.PluginConfig](docs/PluginConfig.md) + - [de.gesellix.docker.remote.api.PluginConfigArgs](docs/PluginConfigArgs.md) + - [de.gesellix.docker.remote.api.PluginConfigInterface](docs/PluginConfigInterface.md) + - [de.gesellix.docker.remote.api.PluginConfigLinux](docs/PluginConfigLinux.md) + - [de.gesellix.docker.remote.api.PluginConfigNetwork](docs/PluginConfigNetwork.md) + - [de.gesellix.docker.remote.api.PluginConfigRootfs](docs/PluginConfigRootfs.md) + - [de.gesellix.docker.remote.api.PluginConfigUser](docs/PluginConfigUser.md) + - [de.gesellix.docker.remote.api.PluginDevice](docs/PluginDevice.md) + - [de.gesellix.docker.remote.api.PluginEnv](docs/PluginEnv.md) + - [de.gesellix.docker.remote.api.PluginInterfaceType](docs/PluginInterfaceType.md) + - [de.gesellix.docker.remote.api.PluginMount](docs/PluginMount.md) + - [de.gesellix.docker.remote.api.PluginPrivilege](docs/PluginPrivilege.md) + - [de.gesellix.docker.remote.api.PluginSettings](docs/PluginSettings.md) + - [de.gesellix.docker.remote.api.PluginsInfo](docs/PluginsInfo.md) + - [de.gesellix.docker.remote.api.Port](docs/Port.md) + - [de.gesellix.docker.remote.api.PortBinding](docs/PortBinding.md) + - [de.gesellix.docker.remote.api.PortStatus](docs/PortStatus.md) + - [de.gesellix.docker.remote.api.ProcessConfig](docs/ProcessConfig.md) + - [de.gesellix.docker.remote.api.ProgressDetail](docs/ProgressDetail.md) + - [de.gesellix.docker.remote.api.PushImageInfo](docs/PushImageInfo.md) + - [de.gesellix.docker.remote.api.Reachability](docs/Reachability.md) + - [de.gesellix.docker.remote.api.RegistryServiceConfig](docs/RegistryServiceConfig.md) + - [de.gesellix.docker.remote.api.ResourceObject](docs/ResourceObject.md) + - [de.gesellix.docker.remote.api.Resources](docs/Resources.md) + - [de.gesellix.docker.remote.api.ResourcesBlkioWeightDeviceInner](docs/ResourcesBlkioWeightDeviceInner.md) + - [de.gesellix.docker.remote.api.ResourcesUlimitsInner](docs/ResourcesUlimitsInner.md) + - [de.gesellix.docker.remote.api.RestartPolicy](docs/RestartPolicy.md) + - [de.gesellix.docker.remote.api.Runtime](docs/Runtime.md) + - [de.gesellix.docker.remote.api.Secret](docs/Secret.md) + - [de.gesellix.docker.remote.api.SecretCreateRequest](docs/SecretCreateRequest.md) + - [de.gesellix.docker.remote.api.SecretSpec](docs/SecretSpec.md) + - [de.gesellix.docker.remote.api.Service](docs/Service.md) + - [de.gesellix.docker.remote.api.ServiceCreateRequest](docs/ServiceCreateRequest.md) + - [de.gesellix.docker.remote.api.ServiceCreateResponse](docs/ServiceCreateResponse.md) + - [de.gesellix.docker.remote.api.ServiceEndpoint](docs/ServiceEndpoint.md) + - [de.gesellix.docker.remote.api.ServiceEndpointVirtualIPsInner](docs/ServiceEndpointVirtualIPsInner.md) + - [de.gesellix.docker.remote.api.ServiceJobStatus](docs/ServiceJobStatus.md) + - [de.gesellix.docker.remote.api.ServiceServiceStatus](docs/ServiceServiceStatus.md) + - [de.gesellix.docker.remote.api.ServiceSpec](docs/ServiceSpec.md) + - [de.gesellix.docker.remote.api.ServiceSpecMode](docs/ServiceSpecMode.md) + - [de.gesellix.docker.remote.api.ServiceSpecModeReplicated](docs/ServiceSpecModeReplicated.md) + - [de.gesellix.docker.remote.api.ServiceSpecModeReplicatedJob](docs/ServiceSpecModeReplicatedJob.md) + - [de.gesellix.docker.remote.api.ServiceSpecRollbackConfig](docs/ServiceSpecRollbackConfig.md) + - [de.gesellix.docker.remote.api.ServiceSpecUpdateConfig](docs/ServiceSpecUpdateConfig.md) + - [de.gesellix.docker.remote.api.ServiceUpdateRequest](docs/ServiceUpdateRequest.md) + - [de.gesellix.docker.remote.api.ServiceUpdateResponse](docs/ServiceUpdateResponse.md) + - [de.gesellix.docker.remote.api.ServiceUpdateStatus](docs/ServiceUpdateStatus.md) + - [de.gesellix.docker.remote.api.Swarm](docs/Swarm.md) + - [de.gesellix.docker.remote.api.SwarmInfo](docs/SwarmInfo.md) + - [de.gesellix.docker.remote.api.SwarmInitRequest](docs/SwarmInitRequest.md) + - [de.gesellix.docker.remote.api.SwarmJoinRequest](docs/SwarmJoinRequest.md) + - [de.gesellix.docker.remote.api.SwarmSpec](docs/SwarmSpec.md) + - [de.gesellix.docker.remote.api.SwarmSpecCAConfig](docs/SwarmSpecCAConfig.md) + - [de.gesellix.docker.remote.api.SwarmSpecCAConfigExternalCAsInner](docs/SwarmSpecCAConfigExternalCAsInner.md) + - [de.gesellix.docker.remote.api.SwarmSpecDispatcher](docs/SwarmSpecDispatcher.md) + - [de.gesellix.docker.remote.api.SwarmSpecEncryptionConfig](docs/SwarmSpecEncryptionConfig.md) + - [de.gesellix.docker.remote.api.SwarmSpecOrchestration](docs/SwarmSpecOrchestration.md) + - [de.gesellix.docker.remote.api.SwarmSpecRaft](docs/SwarmSpecRaft.md) + - [de.gesellix.docker.remote.api.SwarmSpecTaskDefaults](docs/SwarmSpecTaskDefaults.md) + - [de.gesellix.docker.remote.api.SwarmSpecTaskDefaultsLogDriver](docs/SwarmSpecTaskDefaultsLogDriver.md) + - [de.gesellix.docker.remote.api.SwarmUnlockRequest](docs/SwarmUnlockRequest.md) + - [de.gesellix.docker.remote.api.SystemAuthResponse](docs/SystemAuthResponse.md) + - [de.gesellix.docker.remote.api.SystemDataUsageResponse](docs/SystemDataUsageResponse.md) + - [de.gesellix.docker.remote.api.SystemInfo](docs/SystemInfo.md) + - [de.gesellix.docker.remote.api.SystemInfoDefaultAddressPoolsInner](docs/SystemInfoDefaultAddressPoolsInner.md) + - [de.gesellix.docker.remote.api.SystemVersion](docs/SystemVersion.md) + - [de.gesellix.docker.remote.api.SystemVersionComponentsInner](docs/SystemVersionComponentsInner.md) + - [de.gesellix.docker.remote.api.SystemVersionPlatform](docs/SystemVersionPlatform.md) + - [de.gesellix.docker.remote.api.TLSInfo](docs/TLSInfo.md) + - [de.gesellix.docker.remote.api.Task](docs/Task.md) + - [de.gesellix.docker.remote.api.TaskSpec](docs/TaskSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpec](docs/TaskSpecContainerSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecConfigsInner](docs/TaskSpecContainerSpecConfigsInner.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecConfigsInnerFile](docs/TaskSpecContainerSpecConfigsInnerFile.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecDNSConfig](docs/TaskSpecContainerSpecDNSConfig.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivileges](docs/TaskSpecContainerSpecPrivileges.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesAppArmor](docs/TaskSpecContainerSpecPrivilegesAppArmor.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesCredentialSpec](docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesSELinuxContext](docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesSeccomp](docs/TaskSpecContainerSpecPrivilegesSeccomp.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecSecretsInner](docs/TaskSpecContainerSpecSecretsInner.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecSecretsInnerFile](docs/TaskSpecContainerSpecSecretsInnerFile.md) + - [de.gesellix.docker.remote.api.TaskSpecLogDriver](docs/TaskSpecLogDriver.md) + - [de.gesellix.docker.remote.api.TaskSpecNetworkAttachmentSpec](docs/TaskSpecNetworkAttachmentSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecPlacement](docs/TaskSpecPlacement.md) + - [de.gesellix.docker.remote.api.TaskSpecPlacementPreferencesInner](docs/TaskSpecPlacementPreferencesInner.md) + - [de.gesellix.docker.remote.api.TaskSpecPlacementPreferencesInnerSpread](docs/TaskSpecPlacementPreferencesInnerSpread.md) + - [de.gesellix.docker.remote.api.TaskSpecPluginSpec](docs/TaskSpecPluginSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecResources](docs/TaskSpecResources.md) + - [de.gesellix.docker.remote.api.TaskSpecRestartPolicy](docs/TaskSpecRestartPolicy.md) + - [de.gesellix.docker.remote.api.TaskState](docs/TaskState.md) + - [de.gesellix.docker.remote.api.TaskStatus](docs/TaskStatus.md) + - [de.gesellix.docker.remote.api.ThrottleDevice](docs/ThrottleDevice.md) + - [de.gesellix.docker.remote.api.UnlockKeyResponse](docs/UnlockKeyResponse.md) + - [de.gesellix.docker.remote.api.Volume](docs/Volume.md) + - [de.gesellix.docker.remote.api.VolumeCreateOptions](docs/VolumeCreateOptions.md) + - [de.gesellix.docker.remote.api.VolumeListResponse](docs/VolumeListResponse.md) + - [de.gesellix.docker.remote.api.VolumePruneResponse](docs/VolumePruneResponse.md) + - [de.gesellix.docker.remote.api.VolumeUpdateRequest](docs/VolumeUpdateRequest.md) + - [de.gesellix.docker.remote.api.VolumeUsageData](docs/VolumeUsageData.md) + + + +## Documentation for Authorization + +Endpoints do not require authorization. + diff --git a/api-model-v1-44/build.gradle.kts b/api-model-v1-44/build.gradle.kts new file mode 100644 index 00000000..4f5d06ba --- /dev/null +++ b/api-model-v1-44/build.gradle.kts @@ -0,0 +1,233 @@ +import java.text.SimpleDateFormat +import java.util.* + +plugins { + id("java") + alias(libs.plugins.kotlinJvm) + id("com.google.devtools.ksp") + id("maven-publish") + id("signing") + id("com.github.ben-manes.versions") + id("org.sonatype.gradle.plugins.scan") + id("io.freefair.maven-central.validate-poms") + id("org.openapi.generator") + id("org.jlleitschuh.gradle.ktlint") +} + +val remoteApiVersion = "1.44" + +logger.lifecycle("checking base: ${file(layout.buildDirectory.dir("generated")).path}") +configure { + filter { +// see https://github.com/JLLeitschuh/ktlint-gradle/issues/579 + exclude("**/generated/**") + exclude { + it.file.path.startsWith(file(layout.buildDirectory.dir("generated")).path) + } + exclude("**/build.gradle.kts") + exclude { + it.file.path.endsWith("build.gradle.kts") + } + } +} + +openApiGenerate { + inputSpec.set(file("./docker-engine-api-v$remoteApiVersion.yaml").absolutePath) + configFile.set(file("./openapi-generator-config.yaml").absolutePath) + outputDir.set(file(".").absolutePath) +} +val openApiGenerateCleanupBuildScript by tasks.register("openApiGenerateCleanupBuildScript") { + group = "openapi tools" + mustRunAfter(tasks.openApiGenerate) + doLast { + listOf( + "build.gradle", + "gradlew", + "gradlew.bat", + "settings.gradle" + ).onEach { + file(it).delete() + } + listOf( + "gradle" + ).onEach { + file(it).deleteRecursively() + } + } +} +val openApiGenerateCleanupGeneratedCode by tasks.register("openApiGenerateCleanupGeneratedCode") { + group = "openapi tools" + mustRunAfter(tasks.openApiGenerate) + doLast { + listOf( + "src/main/kotlin/de/gesellix/docker/remote/api/infrastructure", + "src/main/kotlin/de/gesellix/docker/remote/client", + "src/test/kotlin/de/gesellix/docker/remote/api/infrastructure", + "src/test/kotlin/de/gesellix/docker/remote/api", + "src/test/kotlin/de/gesellix/docker/remote/client", + ).onEach { + file(it).deleteRecursively() + } + } +} + +tasks.runKtlintFormatOverKotlinScripts.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +tasks.ktlintKotlinScriptFormat.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +tasks.ktlintMainSourceSetFormat.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +tasks.loadKtlintReporters.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +// tasks.ktlintFormat.get().dependsOn( +// tasks.openApiGenerate, +// openApiGenerateCleanupBuildScript, +// openApiGenerateCleanupGeneratedCode, +// tasks.named("ktlintGeneratedByKspKotlinSourceSetFormat") +// ) +val updateApiModelSources by tasks.register("updateApiModelSources") { + group = "openapi tools" + dependsOn( + tasks.openApiGenerate, + openApiGenerateCleanupBuildScript +// openApiGenerateCleanupGeneratedCode + ) + +// TODO try to re-enable this one, +// so that a single task can perform everything all at once. +// finalizedBy(tasks.ktlintFormat) +} + +// TODO find a better solution. +// This is a deprecated workaround, +// because the 'kspKotlin' task isn't present at +// evaluation time. +afterEvaluate { + tasks.findByName("kspKotlin")?.mustRunAfter(tasks.openApiGenerate) +} + +repositories { + mavenCentral() +} + +dependencies { + constraints { + listOf(libs.bundles.okio).forEach { + implementation(it) { + version { + strictly(libs.versions.okioVersionrange.get()) + prefer(libs.versions.okio.get()) + } + } + } + } + implementation(libs.kotlinJdk8) + + implementation(libs.moshi) + ksp("com.squareup.moshi:moshi-kotlin-codegen:${libs.versions.moshi.get()}") + compileOnly(libs.okhttp) + + testImplementation("org.junit.jupiter:junit-jupiter-api:5.13.4") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.13.4") + testRuntimeOnly("cglib:cglib-nodep:3.3.0") + testImplementation("org.junit.platform:junit-platform-launcher:1.13.4") + testImplementation("org.junit.platform:junit-platform-commons:1.13.4") +// testImplementation("io.kotlintest:kotlintest-runner-junit5:3.4.2") +} + +java { + toolchain { + // The org.openapi.generator requires JDK 11 to generate the sources. + // Generated code still works with Java 8. + // See below where we use Java 8 to perform checks + // See https://github.com/OpenAPITools/openapi-generator/pull/15553 for details. + languageVersion.set(JavaLanguageVersion.of(11)) + } +} + +tasks { + withType { + options.encoding = "UTF-8" + } + withType { + useJUnitPlatform() + + java { + toolchain { + // See above: the org.openapi.generator requires JDK 11 to generate the sources. + // We're trying to ensure that the generated code still works with Java 8. + languageVersion.set(JavaLanguageVersion.of(8)) + } + } + } +} + +val javadocJar by tasks.registering(Jar::class) { + dependsOn("classes") + archiveClassifier.set("javadoc") + from(tasks.javadoc) +} + +val sourcesJar by tasks.registering(Jar::class) { + dependsOn("classes") + archiveClassifier.set("sources") + from(sourceSets.main.get().allSource) +} + +artifacts { + add("archives", sourcesJar.get()) + add("archives", javadocJar.get()) +} + +fun findProperty(s: String) = project.findProperty(s) as String? + +val isSnapshot = project.version == "unspecified" +val artifactVersion = if (!isSnapshot) project.version as String else SimpleDateFormat("yyyy-MM-dd\'T\'HH-mm-ss").format(Date())!! +val publicationName = "dockerRemoteApiModel" +publishing { + repositories { + maven { + name = "GitHubPackages" + url = uri("https://maven.pkg.github.com/${property("github.package-registry.owner")}/${property("github.package-registry.repository")}") + credentials { + username = System.getenv("GITHUB_ACTOR") ?: findProperty("github.package-registry.username") + password = System.getenv("GITHUB_TOKEN") ?: findProperty("github.package-registry.password") + } + } + } + publications { + register(publicationName, MavenPublication::class) { + pom { + name.set("docker-remote-api-model") + description.set("API model for the Docker remote api v$remoteApiVersion") + url.set("https://github.com/docker-client/docker-remote-api") + licenses { + license { + name.set("MIT") + url.set("https://opensource.org/licenses/MIT") + } + } + developers { + developer { + id.set("gesellix") + name.set("Tobias Gesellchen") + email.set("tobias@gesellix.de") + } + } + scm { + connection.set("scm:git:github.com/docker-client/docker-remote-api.git") + developerConnection.set("scm:git:ssh://github.com/docker-client/docker-remote-api.git") + url.set("https://github.com/docker-client/docker-remote-api") + } + } + artifactId = "docker-remote-api-model-${remoteApiVersion.replace(Regex("\\."), "-")}" + version = artifactVersion + from(components["java"]) + artifact(sourcesJar.get()) + artifact(javadocJar.get()) + } + } +} + +signing { + val signingKey: String? by project + val signingPassword: String? by project + useInMemoryPgpKeys(signingKey, signingPassword) + sign(publishing.publications[publicationName]) +} diff --git a/api-model-v1-44/docker-engine-api-v1.44.yaml b/api-model-v1-44/docker-engine-api-v1.44.yaml new file mode 100644 index 00000000..9892b36a --- /dev/null +++ b/api-model-v1-44/docker-engine-api-v1.44.yaml @@ -0,0 +1,12673 @@ +# A Swagger 2.0 (a.k.a. OpenAPI) definition of the Engine API. +# +# This is used for generating API documentation and the types used by the +# client/server. See api/README.md for more information. +# +# Some style notes: +# - This file is used by ReDoc, which allows GitHub Flavored Markdown in +# descriptions. +# - There is no maximum line length, for ease of editing and pretty diffs. +# - operationIds are in the format "NounVerb", with a singular noun. + +swagger: "2.0" +schemes: + - "http" + - "https" +produces: + - "application/json" + - "text/plain" +consumes: + - "application/json" + - "text/plain" +basePath: "/v1.44" +info: + title: "Docker Engine API" + version: "1.44" + x-logo: + url: "https://docs.docker.com/assets/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 + 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.44) is used. + For example, calling `/info` is the same as calling `/v1.44/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", + "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 tags on paths define the menu sections in the ReDoc documentation, so +# the usage of tags must make sense for that: +# - They should be singular, not plural. +# - There should not be too many tags, or the menu becomes unwieldy. For +# example, it is preferable to add a path to the "System" tag instead of +# creating a tag with a single path in it. +# - The order of tags in this list defines the order in the menu. +tags: + # Primary objects + - name: "Container" + x-displayName: "Containers" + description: | + Create and manage containers. + - name: "Image" + x-displayName: "Images" + - name: "Network" + x-displayName: "Networks" + description: | + Networks are user-defined networks that containers can be attached to. + See the [networking documentation](https://docs.docker.com/network/) + for more information. + - name: "Volume" + x-displayName: "Volumes" + description: | + Create and manage persistent storage that can be attached to containers. + - name: "Exec" + x-displayName: "Exec" + description: | + Run new commands inside running containers. Refer to the + [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, + then start it. These two API endpoints are wrapped up in a single command-line + command, `docker exec`. + + # Swarm things + - name: "Swarm" + x-displayName: "Swarm" + description: | + Engines can be clustered together in a swarm. Refer to the + [swarm mode documentation](https://docs.docker.com/engine/swarm/) + for more information. + - name: "Node" + x-displayName: "Nodes" + description: | + Nodes are instances of the Engine participating in a swarm. Swarm mode + must be enabled for these endpoints to work. + - name: "Service" + x-displayName: "Services" + description: | + Services are the definitions of tasks to run on a swarm. Swarm mode must + be enabled for these endpoints to work. + - name: "Task" + x-displayName: "Tasks" + description: | + A task is a container running on a swarm. It is the atomic scheduling unit + of swarm. Swarm mode must be enabled for these endpoints to work. + - name: "Secret" + x-displayName: "Secrets" + description: | + Secrets are sensitive data that can be used by services. Swarm mode must + be enabled for these endpoints to work. + - name: "Config" + x-displayName: "Configs" + description: | + Configs are application configurations that can be used by services. Swarm + mode must be enabled for these endpoints to work. + # System things + - name: "Plugin" + x-displayName: "Plugins" + - name: "System" + x-displayName: "System" + +definitions: + Port: + type: "object" + description: "An open port on a container" + required: [PrivatePort, Type] + properties: + IP: + type: "string" + format: "ip-address" + description: "Host IP address that the container's port is mapped to" + PrivatePort: + type: "integer" + format: "uint16" + x-nullable: false + description: "Port on the container" + PublicPort: + type: "integer" + format: "uint16" + description: "Port exposed on the host" + Type: + type: "string" + x-nullable: false + enum: ["tcp", "udp", "sctp"] + example: + PrivatePort: 8080 + PublicPort: 80 + Type: "tcp" + + MountPoint: + type: "object" + description: | + MountPoint represents a mount point configuration inside the container. + This is used for reporting the mountpoints in use by a container. + properties: + Type: + description: | + The mount type: + + - `bind` a mount of a file or directory from the host into the container. + - `volume` a docker volume with the given `Name`. + - `tmpfs` a `tmpfs`. + - `npipe` a named pipe from the host into the container. + - `cluster` a Swarm cluster volume + type: "string" + enum: + - "bind" + - "volume" + - "tmpfs" + - "npipe" + - "cluster" + example: "volume" + Name: + description: | + Name is the name reference to the underlying data defined by `Source` + e.g., the volume name. + type: "string" + example: "myvolume" + Source: + description: | + Source location of the mount. + + For volumes, this contains the storage location of the volume (within + `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains + the source (host) part of the bind-mount. For `tmpfs` mount points, this + field is empty. + type: "string" + example: "/var/lib/docker/volumes/myvolume/_data" + Destination: + description: | + Destination is the path relative to the container root (`/`) where + the `Source` is mounted inside the container. + type: "string" + example: "/usr/share/nginx/html/" + Driver: + description: | + Driver is the volume driver used to create the volume (if it is a volume). + type: "string" + example: "local" + Mode: + description: | + Mode is a comma separated list of options supplied by the user when + creating the bind/volume mount. + + The default is platform-specific (`"z"` on Linux, empty on Windows). + type: "string" + example: "z" + RW: + description: | + Whether the mount is mounted writable (read-write). + type: "boolean" + example: true + Propagation: + description: | + Propagation describes how mounts are propagated from the host into the + mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) + for details. This field is not used on Windows. + type: "string" + example: "" + + DeviceMapping: + type: "object" + description: "A device mapping between the host and container" + properties: + PathOnHost: + type: "string" + PathInContainer: + type: "string" + CgroupPermissions: + type: "string" + example: + PathOnHost: "/dev/deviceName" + PathInContainer: "/dev/deviceName" + CgroupPermissions: "mrw" + + DeviceRequest: + type: "object" + description: "A request for devices to be sent to device drivers" + properties: + Driver: + type: "string" + example: "nvidia" + Count: + type: "integer" + example: -1 + DeviceIDs: + type: "array" + items: + type: "string" + example: + - "0" + - "1" + - "GPU-fef8089b-4820-abfc-e83e-94318197576e" + Capabilities: + description: | + A list of capabilities; an OR list of AND lists of capabilities. + type: "array" + items: + type: "array" + items: + type: "string" + example: + # gpu AND nvidia AND compute + - ["gpu", "nvidia", "compute"] + Options: + description: | + Driver-specific options, specified as a key/value pairs. These options + are passed directly to the driver. + type: "object" + additionalProperties: + type: "string" + + ThrottleDevice: + type: "object" + properties: + Path: + description: "Device path" + type: "string" + Rate: + description: "Rate" + type: "integer" + format: "int64" + minimum: 0 + + Mount: + type: "object" + properties: + Target: + description: "Container path." + type: "string" + Source: + description: "Mount source (e.g. a volume name, a host path)." + type: "string" + Type: + description: | + The mount type. Available types: + + - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. + - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. + - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. + - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. + - `cluster` a Swarm cluster volume + type: "string" + enum: + - "bind" + - "volume" + - "tmpfs" + - "npipe" + - "cluster" + ReadOnly: + description: "Whether the mount should be read-only." + type: "boolean" + Consistency: + description: "The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`." + type: "string" + BindOptions: + description: "Optional configuration for the `bind` type." + type: "object" + properties: + Propagation: + description: "A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`." + type: "string" + enum: + - "private" + - "rprivate" + - "shared" + - "rshared" + - "slave" + - "rslave" + NonRecursive: + description: "Disable recursive bind mount." + type: "boolean" + default: false + CreateMountpoint: + description: "Create mount point on host if missing" + type: "boolean" + default: false + ReadOnlyNonRecursive: + description: | + Make the mount non-recursively read-only, but still leave the mount recursive + (unless NonRecursive is set to true in conjunction). + type: "boolean" + default: false + ReadOnlyForceRecursive: + description: "Raise an error if the mount cannot be made recursively read-only." + type: "boolean" + default: false + VolumeOptions: + description: "Optional configuration for the `volume` type." + type: "object" + properties: + NoCopy: + description: "Populate volume with data from the target." + type: "boolean" + default: false + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + DriverConfig: + description: "Map of driver specific options" + type: "object" + properties: + Name: + description: "Name of the driver to use to create the volume." + type: "string" + Options: + description: "key/value map of driver specific options." + type: "object" + additionalProperties: + type: "string" + TmpfsOptions: + description: "Optional configuration for the `tmpfs` type." + type: "object" + properties: + SizeBytes: + description: "The size for the tmpfs mount in bytes." + type: "integer" + format: "int64" + Mode: + description: "The permission mode for the tmpfs mount in an integer." + type: "integer" + + RestartPolicy: + description: | + 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. + type: "object" + properties: + Name: + 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" + MaximumRetryCount: + type: "integer" + description: | + If `on-failure` is used, the number of times to retry before giving up. + + Resources: + description: "A container's resources (cgroups config, ulimits, etc)" + type: "object" + properties: + # Applicable to all platforms + CpuShares: + description: | + An integer value representing this container's relative CPU weight + versus other containers. + type: "integer" + Memory: + description: "Memory limit in bytes." + type: "integer" + format: "int64" + default: 0 + # Applicable to UNIX platforms + CgroupParent: + description: | + Path to `cgroups` under which the container's `cgroup` is created. If + the path is not absolute, the path is considered to be relative to the + `cgroups` path of the init process. Cgroups are created if they do not + already exist. + type: "string" + BlkioWeight: + description: "Block IO weight (relative weight)." + type: "integer" + minimum: 0 + maximum: 1000 + BlkioWeightDevice: + description: | + Block IO weight (relative device weight) in the form: + + ``` + [{"Path": "device_path", "Weight": weight}] + ``` + type: "array" + items: + type: "object" + properties: + Path: + type: "string" + Weight: + type: "integer" + minimum: 0 + BlkioDeviceReadBps: + description: | + Limit read rate (bytes per second) from a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + BlkioDeviceWriteBps: + description: | + Limit write rate (bytes per second) to a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + BlkioDeviceReadIOps: + description: | + Limit read rate (IO per second) from a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + BlkioDeviceWriteIOps: + description: | + Limit write rate (IO per second) to a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + CpuPeriod: + description: "The length of a CPU period in microseconds." + type: "integer" + format: "int64" + CpuQuota: + description: | + Microseconds of CPU time that the container can get in a CPU period. + type: "integer" + format: "int64" + CpuRealtimePeriod: + description: | + The length of a CPU real-time period in microseconds. Set to 0 to + allocate no time allocated to real-time tasks. + type: "integer" + format: "int64" + CpuRealtimeRuntime: + description: | + The length of a CPU real-time runtime in microseconds. Set to 0 to + allocate no time allocated to real-time tasks. + type: "integer" + format: "int64" + CpusetCpus: + description: | + CPUs in which to allow execution (e.g., `0-3`, `0,1`). + type: "string" + example: "0-3" + CpusetMems: + description: | + Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only + effective on NUMA systems. + type: "string" + Devices: + description: "A list of devices to add to the container." + type: "array" + items: + $ref: "#/definitions/DeviceMapping" + DeviceCgroupRules: + description: "a list of cgroup rules to apply to the container" + type: "array" + items: + type: "string" + example: "c 13:* rwm" + DeviceRequests: + description: | + A list of requests for devices to be sent to device drivers. + type: "array" + items: + $ref: "#/definitions/DeviceRequest" + KernelMemoryTCP: + description: | + Hard limit for kernel TCP buffer memory (in bytes). Depending on the + OCI runtime in use, this option may be ignored. It is no longer supported + by the default (runc) runtime. + + This field is omitted when empty. + type: "integer" + format: "int64" + MemoryReservation: + description: "Memory soft limit in bytes." + type: "integer" + format: "int64" + MemorySwap: + description: | + Total memory limit (memory + swap). Set as `-1` to enable unlimited + swap. + type: "integer" + format: "int64" + MemorySwappiness: + description: | + Tune a container's memory swappiness behavior. Accepts an integer + between 0 and 100. + type: "integer" + format: "int64" + minimum: 0 + maximum: 100 + NanoCpus: + description: "CPU quota in units of 10-9 CPUs." + type: "integer" + format: "int64" + OomKillDisable: + description: "Disable OOM Killer for the container." + type: "boolean" + Init: + description: | + Run an init inside the container that forwards signals and reaps + processes. This field is omitted if empty, and the default (as + configured on the daemon) is used. + type: "boolean" + x-nullable: true + PidsLimit: + description: | + Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` + to not change. + type: "integer" + format: "int64" + x-nullable: true + Ulimits: + description: | + A list of resource limits to set in the container. For example: + + ``` + {"Name": "nofile", "Soft": 1024, "Hard": 2048} + ``` + type: "array" + items: + type: "object" + properties: + Name: + description: "Name of ulimit" + type: "string" + Soft: + description: "Soft limit" + type: "integer" + Hard: + description: "Hard limit" + type: "integer" + # Applicable to Windows + CpuCount: + description: | + The number of usable CPUs (Windows only). + + On Windows Server containers, the processor resource controls are + mutually exclusive. The order of precedence is `CPUCount` first, then + `CPUShares`, and `CPUPercent` last. + type: "integer" + format: "int64" + CpuPercent: + description: | + The usable percentage of the available CPUs (Windows only). + + On Windows Server containers, the processor resource controls are + mutually exclusive. The order of precedence is `CPUCount` first, then + `CPUShares`, and `CPUPercent` last. + type: "integer" + format: "int64" + IOMaximumIOps: + description: "Maximum IOps for the container system drive (Windows only)" + type: "integer" + format: "int64" + IOMaximumBandwidth: + description: | + Maximum IO in bytes per second for the container system drive + (Windows only). + type: "integer" + format: "int64" + + Limit: + description: | + An object describing a limit on resources which can be requested by a task. + type: "object" + properties: + NanoCPUs: + type: "integer" + format: "int64" + example: 4000000000 + MemoryBytes: + type: "integer" + format: "int64" + example: 8272408576 + Pids: + description: | + Limits the maximum number of PIDs in the container. Set `0` for unlimited. + type: "integer" + format: "int64" + default: 0 + example: 100 + + ResourceObject: + description: | + An object describing the resources which can be advertised by a node and + requested by a task. + type: "object" + properties: + NanoCPUs: + type: "integer" + format: "int64" + example: 4000000000 + MemoryBytes: + type: "integer" + format: "int64" + example: 8272408576 + GenericResources: + $ref: "#/definitions/GenericResources" + + GenericResources: + description: | + User-defined resources can be either Integer resources (e.g, `SSD=3`) or + String resources (e.g, `GPU=UUID1`). + type: "array" + items: + type: "object" + properties: + NamedResourceSpec: + type: "object" + properties: + Kind: + type: "string" + Value: + type: "string" + DiscreteResourceSpec: + type: "object" + properties: + Kind: + type: "string" + Value: + type: "integer" + format: "int64" + example: + - DiscreteResourceSpec: + Kind: "SSD" + Value: 3 + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID1" + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID2" + + HealthConfig: + description: "A test to perform to check that the container is healthy." + type: "object" + properties: + Test: + description: | + The test to perform. Possible values are: + + - `[]` inherit healthcheck from image or parent image + - `["NONE"]` disable healthcheck + - `["CMD", args...]` exec arguments directly + - `["CMD-SHELL", command]` run command with system's default shell + type: "array" + items: + type: "string" + Interval: + description: | + The time to wait between checks in nanoseconds. It should be 0 or at + least 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + Timeout: + description: | + The time to wait before considering the check to have hung. It should + be 0 or at least 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + Retries: + description: | + The number of consecutive failures needed to consider a container as + unhealthy. 0 means inherit. + type: "integer" + StartPeriod: + description: | + Start period for the container to initialize before starting + health-retries countdown in nanoseconds. It should be 0 or at least + 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + StartInterval: + description: | + The time to wait between checks in nanoseconds during the start period. + It should be 0 or at least 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + + Health: + description: | + Health stores information about the container's healthcheck results. + type: "object" +# x-nullable: true + properties: + Status: + description: | + Status is one of `none`, `starting`, `healthy` or `unhealthy` + + - "none" Indicates there is no healthcheck + - "starting" Starting indicates that the container is not yet ready + - "healthy" Healthy indicates that the container is running correctly + - "unhealthy" Unhealthy indicates that the container has a problem + type: "string" + enum: + - "none" + - "starting" + - "healthy" + - "unhealthy" + example: "healthy" + FailingStreak: + description: "FailingStreak is the number of consecutive failures" + type: "integer" + example: 0 + Log: + type: "array" + description: | + Log contains the last few results (oldest first) + items: + x-nullable: true + $ref: "#/definitions/HealthcheckResult" + + HealthcheckResult: + description: | + HealthcheckResult stores information about a single run of a healthcheck probe + type: "object" +# x-nullable: true + properties: + Start: + description: | + Date and time at which this check started in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "date-time" + example: "2020-01-04T10:44:24.496525531Z" + End: + description: | + Date and time at which this check ended in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2020-01-04T10:45:21.364524523Z" + ExitCode: + description: | + ExitCode meanings: + + - `0` healthy + - `1` unhealthy + - `2` reserved (considered unhealthy) + - other values: error running probe + type: "integer" + example: 0 + Output: + description: "Output from last check" + type: "string" + + HostConfig: + description: "Container configuration that depends on the host we are running on" + allOf: + - $ref: "#/definitions/Resources" + - type: "object" + properties: + # Applicable to all platforms + Binds: + type: "array" + description: | + A list of volume bindings for this container. Each volume binding + is a string in one of these forms: + + - `host-src:container-dest[:options]` to bind-mount a host path + into the container. Both `host-src`, and `container-dest` must + be an _absolute_ path. + - `volume-name:container-dest[:options]` to bind-mount a volume + managed by a volume driver into the container. `container-dest` + must be an _absolute_ path. + + `options` is an optional, comma-delimited list of: + + - `nocopy` disables automatic copying of data from the container + path to the volume. The `nocopy` flag only applies to named volumes. + - `[ro|rw]` mounts a volume read-only or read-write, respectively. + If omitted or set to `rw`, volumes are mounted read-write. + - `[z|Z]` applies SELinux labels to allow or deny multiple containers + to read and write to the same volume. + - `z`: a _shared_ content label is applied to the content. This + label indicates that multiple containers can share the volume + content, for both reading and writing. + - `Z`: a _private unshared_ label is applied to the content. + This label indicates that only the current container can use + a private volume. Labeling systems such as SELinux require + proper labels to be placed on volume content that is mounted + into a container. Without a label, the security system can + prevent a container's processes from using the content. By + default, the labels set by the host operating system are not + modified. + - `[[r]shared|[r]slave|[r]private]` specifies mount + [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). + This only applies to bind-mounted volumes, not internal volumes + or named volumes. Mount propagation requires the source mount + point (the location where the source directory is mounted in the + host operating system) to have the correct propagation properties. + For shared volumes, the source mount point must be set to `shared`. + For slave volumes, the mount must be set to either `shared` or + `slave`. + items: + type: "string" + ContainerIDFile: + type: "string" + description: "Path to a file where the container ID is written" + LogConfig: + type: "object" + description: "The logging configuration for this container" + properties: + Type: + type: "string" + enum: + - "json-file" + - "syslog" + - "journald" + - "gelf" + - "fluentd" + - "awslogs" + - "splunk" + - "etwlogs" + - "none" + Config: + type: "object" + additionalProperties: + type: "string" + NetworkMode: + type: "string" + description: | + Network mode to use for this container. Supported standard values + are: `bridge`, `host`, `none`, and `container:`. Any + other value is taken as a custom network's name to which this + container should connect to. + PortBindings: + $ref: "#/definitions/PortMap" + RestartPolicy: + $ref: "#/definitions/RestartPolicy" + AutoRemove: + type: "boolean" + description: | + Automatically remove the container when the container's process + exits. This has no effect if `RestartPolicy` is set. + VolumeDriver: + type: "string" + description: "Driver that this container uses to mount volumes." + VolumesFrom: + type: "array" + description: | + A list of volumes to inherit from another container, specified in + the form `[:]`. + items: + type: "string" + Mounts: + description: | + Specification for mounts to be added to the container. + type: "array" + items: + $ref: "#/definitions/Mount" + ConsoleSize: + type: "array" + description: | + Initial console size, as an `[height, width]` array. + x-nullable: true + minItems: 2 + maxItems: 2 + items: + type: "integer" + minimum: 0 + Annotations: + type: "object" + description: | + Arbitrary non-identifying metadata attached to container and + provided to the runtime when the container is started. + additionalProperties: + type: "string" + + # Applicable to UNIX platforms + CapAdd: + type: "array" + description: | + A list of kernel capabilities to add to the container. Conflicts + with option 'Capabilities'. + items: + type: "string" + CapDrop: + type: "array" + description: | + A list of kernel capabilities to drop from the container. Conflicts + with option 'Capabilities'. + items: + type: "string" + CgroupnsMode: + type: "string" + enum: + - "private" + - "host" + description: | + cgroup namespace mode for the container. Possible values are: + + - `"private"`: the container runs in its own private cgroup namespace + - `"host"`: use the host system's cgroup namespace + + If not specified, the daemon default is used, which can either be `"private"` + or `"host"`, depending on daemon version, kernel support and configuration. + Dns: + type: "array" + description: "A list of DNS servers for the container to use." + items: + type: "string" + DnsOptions: + type: "array" + description: "A list of DNS options." + items: + type: "string" + DnsSearch: + type: "array" + description: "A list of DNS search domains." + items: + type: "string" + ExtraHosts: + type: "array" + description: | + A list of hostnames/IP mappings to add to the container's `/etc/hosts` + file. Specified in the form `["hostname:IP"]`. + items: + type: "string" + GroupAdd: + type: "array" + description: | + A list of additional groups that the container process will run as. + items: + type: "string" + IpcMode: + type: "string" + description: | + IPC sharing mode for the container. Possible values are: + + - `"none"`: own private IPC namespace, with /dev/shm not mounted + - `"private"`: own private IPC namespace + - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers + - `"container:"`: join another (shareable) container's IPC namespace + - `"host"`: use the host system's IPC namespace + + If not specified, daemon default is used, which can either be `"private"` + or `"shareable"`, depending on daemon version and configuration. + Cgroup: + type: "string" + description: "Cgroup to use for the container." + Links: + type: "array" + description: | + A list of links for the container in the form `container_name:alias`. + items: + type: "string" + OomScoreAdj: + type: "integer" + description: | + An integer value containing the score given to the container in + order to tune OOM killer preferences. + example: 500 + PidMode: + type: "string" + description: | + Set the PID (Process) Namespace mode for the container. It can be + either: + + - `"container:"`: joins another container's PID namespace + - `"host"`: use the host's PID namespace inside the container + Privileged: + type: "boolean" + description: "Gives the container full access to the host." + PublishAllPorts: + type: "boolean" + description: | + Allocates an ephemeral host port for all of a container's + exposed ports. + + Ports are de-allocated when the container stops and allocated when + the container starts. The allocated port might be changed when + restarting the container. + + The port is selected from the ephemeral port range that depends on + the kernel. For example, on Linux the range is defined by + `/proc/sys/net/ipv4/ip_local_port_range`. + ReadonlyRootfs: + type: "boolean" + description: "Mount the container's root filesystem as read only." + SecurityOpt: + type: "array" + description: | + A list of string values to customize labels for MLS systems, such + as SELinux. + items: + type: "string" + StorageOpt: + type: "object" + description: | + Storage driver options for this container, in the form `{"size": "120G"}`. + additionalProperties: + type: "string" + Tmpfs: + type: "object" + description: | + A map of container directories which should be replaced by tmpfs + mounts, and their corresponding mount options. For example: + + ``` + { "/run": "rw,noexec,nosuid,size=65536k" } + ``` + additionalProperties: + type: "string" + UTSMode: + type: "string" + description: "UTS namespace to use for the container." + UsernsMode: + type: "string" + description: | + Sets the usernamespace mode for the container when usernamespace + remapping option is enabled. + ShmSize: + type: "integer" + format: "int64" + description: | + Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. + minimum: 0 + Sysctls: + type: "object" + description: | + A list of kernel parameters (sysctls) to set in the container. + For example: + + ``` + {"net.ipv4.ip_forward": "1"} + ``` + additionalProperties: + type: "string" + Runtime: + type: "string" + description: "Runtime to use with this container." + # Applicable to Windows + Isolation: + type: "string" + description: | + Isolation technology of the container. (Windows only) + enum: + - "default" + - "process" + - "hyperv" + - "" + MaskedPaths: + type: "array" + description: | + The list of paths to be masked inside the container (this overrides + the default set of paths). + items: + type: "string" + ReadonlyPaths: + type: "array" + description: | + The list of paths to be set as read-only inside the container + (this overrides the default set of paths). + items: + type: "string" + + ContainerConfig: + description: | + Configuration for a container that is portable between hosts. + + When used as `ContainerConfig` field in an image, `ContainerConfig` is an + optional field containing the configuration of the container that was last + committed when creating the image. + + Previous versions of Docker builder used this field to store build cache, + and it is not in active use anymore. + type: "object" + properties: + Hostname: + description: | + The hostname to use for the container, as a valid RFC 1123 hostname. + type: "string" + example: "439f4e91bd1d" + Domainname: + description: | + The domain name to use for the container. + type: "string" + User: + description: "The user that commands are run as inside the container." + type: "string" + AttachStdin: + description: "Whether to attach to `stdin`." + type: "boolean" + default: false + AttachStdout: + description: "Whether to attach to `stdout`." + type: "boolean" + default: true + AttachStderr: + description: "Whether to attach to `stderr`." + type: "boolean" + default: true + ExposedPorts: + description: | + An object mapping ports to an empty object in the form: + + `{"/": {}}` + type: "object" +# x-nullable: true + additionalProperties: + type: "object" + enum: + - {} + default: {} + example: { + "80/tcp": {}, + "443/tcp": {} + } + Tty: + description: | + Attach standard streams to a TTY, including `stdin` if it is not closed. + type: "boolean" + default: false + OpenStdin: + description: "Open `stdin`" + type: "boolean" + default: false + StdinOnce: + description: "Close `stdin` after one attached client disconnects" + type: "boolean" + default: false + Env: + description: | + A list of environment variables to set inside the container in the + form `["VAR=value", ...]`. A variable without `=` is removed from the + environment, rather than to have an empty value. + type: "array" + items: + type: "string" + example: + - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + Cmd: + description: | + Command to run specified as a string or an array of strings. + type: "array" + items: + type: "string" + example: ["/bin/sh"] + Healthcheck: + $ref: "#/definitions/HealthConfig" + ArgsEscaped: + description: "Command is already escaped (Windows only)" + type: "boolean" +# default: false + example: false +# x-nullable: true + Image: + description: | + The name (or reference) of the image to use when creating the container, + or which was used when the container was created. + type: "string" + example: "example-image:1.0" + Volumes: + description: | + An object mapping mount point paths inside the container to empty + objects. + type: "object" + additionalProperties: + type: "object" + enum: + - {} + default: {} + WorkingDir: + description: "The working directory for commands to run in." + type: "string" + example: "/public/" + Entrypoint: + description: | + The entry point for the container as a string or an array of strings. + + If the array consists of exactly one empty string (`[""]`) then the + entry point is reset to system default (i.e., the entry point used by + docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + type: "array" + items: + type: "string" + example: [] + NetworkDisabled: + description: "Disable networking for the container." + type: "boolean" +# x-nullable: true + MacAddress: + description: | + MAC address of the container. + + Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. + type: "string" +# x-nullable: true + OnBuild: + description: | + `ONBUILD` metadata that were defined in the image's `Dockerfile`. + type: "array" +# x-nullable: true + items: + type: "string" + example: [] + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + StopSignal: + description: | + Signal to stop a container as a string or unsigned integer. + type: "string" + default: "SIGTERM" + example: "SIGTERM" +# x-nullable: true + StopTimeout: + description: "Timeout to stop a container in seconds." + type: "integer" + default: 10 +# x-nullable: true + Shell: + description: | + Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + type: "array" +# x-nullable: true + items: + type: "string" + example: ["/bin/sh", "-c"] + + ImageConfig: + description: | + Configuration of the image. These fields are used as defaults + when starting a container from the image. + type: "object" + properties: + Hostname: + description: | + The hostname to use for the container, as a valid RFC 1123 hostname. + +


+ + > **Note**: this field is always empty and must not be used. + type: "string" + example: "" + Domainname: + description: | + The domain name to use for the container. + +


+ + > **Note**: this field is always empty and must not be used. + type: "string" + example: "" + User: + description: "The user that commands are run as inside the container." + type: "string" + example: "web:web" + AttachStdin: + description: | + Whether to attach to `stdin`. + +


+ + > **Note**: this field is always false and must not be used. + type: "boolean" + default: false + example: false + AttachStdout: + description: | + Whether to attach to `stdout`. + +


+ + > **Note**: this field is always false and must not be used. + type: "boolean" + default: false + example: false + AttachStderr: + description: | + Whether to attach to `stderr`. + +


+ + > **Note**: this field is always false and must not be used. + type: "boolean" + default: false + example: false + ExposedPorts: + description: | + An object mapping ports to an empty object in the form: + + `{"/": {}}` + type: "object" + x-nullable: true + additionalProperties: + type: "object" + enum: + - {} + default: {} + example: { + "80/tcp": {}, + "443/tcp": {} + } + Tty: + description: | + Attach standard streams to a TTY, including `stdin` if it is not closed. + +


+ + > **Note**: this field is always false and must not be used. + type: "boolean" + default: false + example: false + OpenStdin: + description: | + Open `stdin` + +


+ + > **Note**: this field is always false and must not be used. + type: "boolean" + default: false + example: false + StdinOnce: + description: | + Close `stdin` after one attached client disconnects. + +


+ + > **Note**: this field is always false and must not be used. + type: "boolean" + default: false + example: false + Env: + description: | + A list of environment variables to set inside the container in the + form `["VAR=value", ...]`. A variable without `=` is removed from the + environment, rather than to have an empty value. + type: "array" + items: + type: "string" + example: + - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + Cmd: + description: | + Command to run specified as a string or an array of strings. + type: "array" + items: + type: "string" + example: ["/bin/sh"] + Healthcheck: + $ref: "#/definitions/HealthConfig" + ArgsEscaped: + description: "Command is already escaped (Windows only)" + type: "boolean" + default: false + example: false + x-nullable: true + Image: + description: | + The name (or reference) of the image to use when creating the container, + or which was used when the container was created. + +


+ + > **Note**: this field is always empty and must not be used. + type: "string" + default: "" + example: "" + Volumes: + description: | + An object mapping mount point paths inside the container to empty + objects. + type: "object" + additionalProperties: + type: "object" + enum: + - {} + default: {} + example: + "/app/data": {} + "/app/config": {} + WorkingDir: + description: "The working directory for commands to run in." + type: "string" + example: "/public/" + Entrypoint: + description: | + The entry point for the container as a string or an array of strings. + + If the array consists of exactly one empty string (`[""]`) then the + entry point is reset to system default (i.e., the entry point used by + docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + type: "array" + items: + type: "string" + example: [] + NetworkDisabled: + description: | + Disable networking for the container. + +


+ + > **Note**: this field is always omitted and must not be used. + type: "boolean" + default: false + example: false + x-nullable: true + MacAddress: + description: | + MAC address of the container. + +


+ + > **Deprecated**: this field is deprecated in API v1.44 and up. It is always omitted. + type: "string" + default: "" + example: "" + x-nullable: true + OnBuild: + description: | + `ONBUILD` metadata that were defined in the image's `Dockerfile`. + type: "array" + x-nullable: true + items: + type: "string" + example: [] + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + StopSignal: + description: | + Signal to stop a container as a string or unsigned integer. + type: "string" + example: "SIGTERM" + x-nullable: true + StopTimeout: + description: | + Timeout to stop a container in seconds. + +


+ + > **Note**: this field is always omitted and must not be used. + type: "integer" + default: 10 + x-nullable: true + Shell: + description: | + Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + type: "array" + x-nullable: true + items: + type: "string" + example: ["/bin/sh", "-c"] + # FIXME(thaJeztah): temporarily using a full example to remove some "omitempty" fields. Remove once the fields are removed. + example: + "Hostname": "" + "Domainname": "" + "User": "web:web" + "AttachStdin": false + "AttachStdout": false + "AttachStderr": false + "ExposedPorts": { + "80/tcp": {}, + "443/tcp": {} + } + "Tty": false + "OpenStdin": false + "StdinOnce": false + "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] + "Cmd": ["/bin/sh"] + "Healthcheck": { + "Test": ["string"], + "Interval": 0, + "Timeout": 0, + "Retries": 0, + "StartPeriod": 0, + "StartInterval": 0 + } + "ArgsEscaped": true + "Image": "" + "Volumes": { + "/app/data": {}, + "/app/config": {} + } + "WorkingDir": "/public/" + "Entrypoint": [] + "OnBuild": [] + "Labels": { + "com.example.some-label": "some-value", + "com.example.some-other-label": "some-other-value" + } + "StopSignal": "SIGTERM" + "Shell": ["/bin/sh", "-c"] + + NetworkingConfig: + description: | + NetworkingConfig represents the container's networking configuration for + each of its interfaces. + It is used for the networking configs specified in the `docker create` + and `docker network connect` commands. + type: "object" + properties: + EndpointsConfig: + description: | + A mapping of network name to endpoint configuration for that network. + The endpoint configuration can be left empty to connect to that + network with no particular endpoint configuration. + type: "object" + additionalProperties: + $ref: "#/definitions/EndpointSettings" + example: + # putting an example here, instead of using the example values from + # /definitions/EndpointSettings, because EndpointSettings contains + # operational data returned when inspecting a container that we don't + # accept here. + EndpointsConfig: + isolated_nw: + IPAMConfig: + IPv4Address: "172.20.30.33" + IPv6Address: "2001:db8:abcd::3033" + LinkLocalIPs: + - "169.254.34.68" + - "fe80::3468" + MacAddress: "02:42:ac:12:05:02" + Links: + - "container_1" + - "container_2" + Aliases: + - "server_x" + - "server_y" + database_nw: {} + + NetworkSettings: + description: "NetworkSettings exposes the network settings in the API" + type: "object" + properties: + Bridge: + description: | + Name of the default bridge interface when dockerd's --bridge flag is set. + type: "string" + example: "docker0" + SandboxID: + description: SandboxID uniquely represents a container's network stack. + type: "string" + example: "9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3" + HairpinMode: + description: | + Indicates if hairpin NAT should be enabled on the virtual interface. + + Deprecated: This field is never set and will be removed in a future release. + type: "boolean" + example: false + LinkLocalIPv6Address: + description: | + IPv6 unicast address using the link-local prefix. + + Deprecated: This field is never set and will be removed in a future release. + type: "string" + example: "" + LinkLocalIPv6PrefixLen: + description: | + Prefix length of the IPv6 unicast address. + + Deprecated: This field is never set and will be removed in a future release. + type: "integer" + example: "" + Ports: + $ref: "#/definitions/PortMap" + SandboxKey: + description: SandboxKey is the full path of the netns handle + type: "string" + example: "/var/run/docker/netns/8ab54b426c38" + + SecondaryIPAddresses: + description: "Deprecated: This field is never set and will be removed in a future release." + type: "array" + items: + $ref: "#/definitions/Address" + x-nullable: true + + SecondaryIPv6Addresses: + description: "Deprecated: This field is never set and will be removed in a future release." + type: "array" + items: + $ref: "#/definitions/Address" + x-nullable: true + + # TODO properties below are part of DefaultNetworkSettings, which is + # marked as deprecated since Docker 1.9 and to be removed in Docker v17.12 + EndpointID: + description: | + EndpointID uniquely represents a service endpoint in a Sandbox. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "string" + example: "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b" + Gateway: + description: | + Gateway address for the default "bridge" network. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "string" + example: "172.17.0.1" + GlobalIPv6Address: + description: | + Global IPv6 address for the default "bridge" network. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "string" + example: "2001:db8::5689" + GlobalIPv6PrefixLen: + description: | + Mask length of the global IPv6 address. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "integer" + example: 64 + IPAddress: + description: | + IPv4 address for the default "bridge" network. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "string" + example: "172.17.0.4" + IPPrefixLen: + description: | + Mask length of the IPv4 address. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "integer" + example: 16 + IPv6Gateway: + description: | + IPv6 gateway address for this network. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "string" + example: "2001:db8:2::100" + MacAddress: + description: | + MAC address for the container on the default "bridge" network. + +


+ + > **Deprecated**: This field is only propagated when attached to the + > default "bridge" network. Use the information from the "bridge" + > network inside the `Networks` map instead, which contains the same + > information. This field was deprecated in Docker 1.9 and is scheduled + > to be removed in Docker 17.12.0 + type: "string" + example: "02:42:ac:11:00:04" + Networks: + description: | + Information about all networks that the container is connected to. + type: "object" + additionalProperties: + $ref: "#/definitions/EndpointSettings" + + Address: + description: Address represents an IPv4 or IPv6 IP address. + type: "object" + properties: + Addr: + description: IP address. + type: "string" + PrefixLen: + description: Mask length of the IP address. + type: "integer" + + PortMap: + description: | + PortMap describes the mapping of container ports to host ports, using the + container's port-number and protocol as key in the format `/`, + for example, `80/udp`. + + If a container's port is mapped for multiple protocols, separate entries + are added to the mapping table. + type: "object" + additionalProperties: + type: "array" + x-nullable: true + items: + $ref: "#/definitions/PortBinding" + example: + "443/tcp": + - HostIp: "127.0.0.1" + HostPort: "4443" + "80/tcp": + - HostIp: "0.0.0.0" + HostPort: "80" + - HostIp: "0.0.0.0" + HostPort: "8080" + "80/udp": + - HostIp: "0.0.0.0" + HostPort: "80" + "53/udp": + - HostIp: "0.0.0.0" + HostPort: "53" + "2377/tcp": null + + PortBinding: + description: | + PortBinding represents a binding between a host IP address and a host + port. + type: "object" + properties: + HostIp: + description: "Host IP address that the container's port is mapped to." + type: "string" + example: "127.0.0.1" + HostPort: + description: "Host port number that the container's port is mapped to." + type: "string" + example: "4443" + + GraphDriverData: + description: | + Information about the storage driver used to store the container's and + image's filesystem. + type: "object" + required: [Name] +# required: [Name, Data] + properties: + Name: + description: "Name of the storage driver." + type: "string" + x-nullable: false + example: "overlay2" + Data: + description: | + Low-level storage metadata, provided as key/value pairs. + + This information is driver-specific, and depends on the storage-driver + in use, and should be used for informational purposes only. + type: "object" +# x-nullable: false + additionalProperties: + type: "string" + example: { + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" + } + + FilesystemChange: + description: | + Change in the container's filesystem. + type: "object" + required: [Path, Kind] + properties: + Path: + description: | + Path to file or directory that has changed. + type: "string" + x-nullable: false + Kind: + $ref: "#/definitions/ChangeType" + + ChangeType: + description: | + Kind of change + + Can be one of: + + - `0`: Modified ("C") + - `1`: Added ("A") + - `2`: Deleted ("D") + type: "integer" + format: "uint8" + enum: [0, 1, 2] + x-enum-varnames: ["T0", "T1", "T2"] + x-nullable: false + + ImageInspect: + description: | + Information about an image in the local image cache. + type: "object" + properties: + Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. + type: "string" + x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" + RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same image, and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. + type: "array" + items: + type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" + RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. + type: "array" + items: + type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" + Parent: + description: | + ID of the parent image. + + Depending on how the image was created, this field may be empty and + is only set for images that were built/created locally. This field + is empty if the image was pulled from an image registry. + type: "string" + x-nullable: false + example: "" + Comment: + description: | + Optional message that was set when committing or importing the image. + type: "string" + x-nullable: false + example: "" + Created: + description: | + Date and time at which the image was created, formatted in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + + This information is only available if present in the image, + and omitted otherwise. + type: "string" + format: "dateTime" + x-nullable: false + example: "2022-02-04T21:20:12.497794809Z" + Container: + description: | + The ID of the container that was used to create the image. + + Depending on how the image was created, this field may be empty. + + **Deprecated**: this field is kept for backward compatibility, but + will be removed in API v1.45. + type: "string" + x-nullable: false + example: "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735" + ContainerConfig: + description: | + **Deprecated**: this field is kept for backward compatibility, but + will be removed in API v1.45. + $ref: "#/definitions/ContainerConfig" + DockerVersion: + description: | + The version of Docker that was used to build the image. + + Depending on how the image was created, this field may be empty. + type: "string" + x-nullable: false + example: "20.10.7" + Author: + description: | + Name of the author that was specified when committing the image, or as + specified through MAINTAINER (deprecated) in the Dockerfile. + type: "string" + x-nullable: false + example: "" + Config: + $ref: "#/definitions/ImageConfig" + Architecture: + description: | + Hardware CPU architecture that the image runs on. + type: "string" + x-nullable: false + example: "arm" + Variant: + description: | + CPU architecture variant (presently ARM-only). + type: "string" + x-nullable: true + example: "v7" + Os: + description: | + Operating System the image is built to run on. + type: "string" + x-nullable: false + example: "linux" + OsVersion: + description: | + Operating System version the image is built to run on (especially + for Windows). + type: "string" + example: "" +# x-nullable: true + Size: + description: | + Total size of the image including all layers it is composed of. + type: "integer" + format: "int64" + x-nullable: false + example: 1239828 + GraphDriver: + $ref: "#/definitions/GraphDriverData" + RootFS: + description: | + Information about the image's RootFS, including the layer IDs. + type: "object" + required: [Type] + properties: + Type: + type: "string" + x-nullable: false + example: "layers" + Layers: + type: "array" + items: + type: "string" + example: + - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" + - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" + Metadata: + description: | + Additional metadata of the image in the local cache. This information + is local to the daemon, and not part of the image itself. + type: "object" + properties: + LastTagTime: + description: | + Date and time at which the image was last tagged in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + + This information is only available if the image was tagged locally, + and omitted otherwise. + type: "string" + format: "dateTime" + example: "2022-02-28T14:40:02.623929178Z" +# x-nullable: true + ImageSummary: + type: "object" + x-go-name: "Summary" + required: + - Id + - ParentId +# - RepoTags +# - RepoDigests + - Created + - Size + - SharedSize +# - Labels + - Containers + properties: + Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. + type: "string" + x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" + ParentId: + description: | + ID of the parent image. + + Depending on how the image was created, this field may be empty and + is only set for images that were built/created locally. This field + is empty if the image was pulled from an image registry. + type: "string" + x-nullable: false + example: "" + RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same image, and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. + type: "array" +# x-nullable: false + items: + type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" + RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. + type: "array" +# x-nullable: false + items: + type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" + Created: + description: | + Date and time at which the image was created as a Unix timestamp + (number of seconds since EPOCH). + type: "integer" + x-nullable: false + example: "1644009612" + Size: + description: | + Total size of the image including all layers it is composed of. + type: "integer" + format: "int64" + x-nullable: false + example: 172064416 + SharedSize: + description: | + Total size of image layers that are shared between this image and other + images. + + This size is not calculated by default. `-1` indicates that the value + has not been set / calculated. + type: "integer" + format: "int64" + x-nullable: false + example: 1239828 + Labels: + description: "User-defined key/value metadata." + type: "object" +# x-nullable: false + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Containers: + description: | + Number of containers using this image. Includes both stopped and running + containers. + + This size is not calculated by default, and depends on which API endpoint + is used. `-1` indicates that the value has not been set / calculated. + x-nullable: false + type: "integer" + example: 2 + + AuthConfig: + type: "object" + properties: + username: + type: "string" + password: + type: "string" + email: + description: | + Email is an optional value associated with the username. + + > **Deprecated**: This field is deprecated since docker 1.11 (API v1.23) and will be removed in a future release. + type: "string" + serveraddress: + type: "string" + example: + username: "hannibal" + password: "xxxx" + serveraddress: "https://index.docker.io/v1/" + + ProcessConfig: + type: "object" + properties: + privileged: + type: "boolean" + user: + type: "string" + tty: + type: "boolean" + entrypoint: + type: "string" + arguments: + type: "array" + items: + type: "string" + + Volume: + type: "object" + required: [Name, Driver, Mountpoint, Options] +# required: [Name, Driver, Mountpoint, Labels, Scope, Options] + properties: + Name: + type: "string" + description: "Name of the volume." + x-nullable: false + example: "tardis" + Driver: + type: "string" + description: "Name of the volume driver used by the volume." + x-nullable: false + example: "custom" + Mountpoint: + type: "string" + description: "Mount path of the volume on the host." + x-nullable: false + example: "/var/lib/docker/volumes/tardis" + CreatedAt: + type: "string" + format: "dateTime" + description: "Date/Time the volume was created." + example: "2016-06-07T20:31:11.853781916Z" + Status: + type: "object" + description: | + Low-level details about the volume, provided by the volume driver. + Details are returned as a map with key/value pairs: + `{"key":"value","key2":"value2"}`. + + The `Status` field is optional, and is omitted if the volume driver + does not support this feature. + additionalProperties: + type: "object" + example: + hello: "world" + Labels: + type: "object" + description: "User-defined key/value metadata." +# x-nullable: false + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Scope: + type: "string" + description: | + The level at which the volume exists. Either `global` for cluster-wide, + or `local` for machine level. + default: "local" +# x-nullable: false + enum: ["local", "global"] + example: "local" + ClusterVolume: + $ref: "#/definitions/ClusterVolume" + Options: + type: "object" + x-nullable: true + description: | + The driver specific options used when creating the volume. + additionalProperties: + type: "string" + example: + device: "tmpfs" + o: "size=100m,uid=1000" + type: "tmpfs" + UsageData: + type: "object" + x-nullable: true + x-go-name: "UsageData" + required: [Size, RefCount] + description: | + Usage details about the volume. This information is used by the + `GET /system/df` endpoint, and omitted in other endpoints. + properties: + Size: + type: "integer" + format: "int64" + default: -1 + description: | + Amount of disk space used by the volume (in bytes). This information + is only available for volumes created with the `"local"` volume + driver. For volumes created with other volume drivers, this field + is set to `-1` ("not available") + x-nullable: false + RefCount: + type: "integer" + format: "int64" + default: -1 + description: | + The number of containers referencing this volume. This field + is set to `-1` if the reference-count is not available. + x-nullable: false + + VolumeCreateOptions: + description: "Volume configuration" + type: "object" + title: "VolumeConfig" + x-go-name: "CreateOptions" + properties: + Name: + description: | + The new volume's name. If not specified, Docker generates a name. + type: "string" + x-nullable: false + example: "tardis" + Driver: + description: "Name of the volume driver to use." + type: "string" + default: "local" + x-nullable: false + example: "custom" + DriverOpts: + description: | + A mapping of driver options and values. These options are + passed directly to the driver and are driver specific. + type: "object" + additionalProperties: + type: "string" + example: + device: "tmpfs" + o: "size=100m,uid=1000" + type: "tmpfs" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + ClusterVolumeSpec: + $ref: "#/definitions/ClusterVolumeSpec" + + VolumeListResponse: + type: "object" + title: "VolumeListResponse" + x-go-name: "ListResponse" + description: "Volume list response" + properties: + Volumes: + type: "array" + description: "List of volumes" + items: + $ref: "#/definitions/Volume" + Warnings: + type: "array" + description: | + Warnings that occurred when fetching the list of volumes. + items: + type: "string" + example: [] + + Network: + type: "object" + properties: + Name: + description: | + Name of the network. + type: "string" + example: "my_network" + Id: + description: | + ID that uniquely identifies a network on a single machine. + type: "string" + example: "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99" + Created: + description: | + Date and time at which the network was created in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-10-19T04:33:30.360899459Z" + Scope: + description: | + The level at which the network exists (e.g. `swarm` for cluster-wide + or `local` for machine level) + type: "string" + example: "local" + Driver: + description: | + The name of the driver used to create the network (e.g. `bridge`, + `overlay`). + type: "string" + example: "overlay" + EnableIPv6: + description: | + Whether the network was created with IPv6 enabled. + type: "boolean" + example: false + IPAM: + $ref: "#/definitions/IPAM" + Internal: + description: | + Whether the network is created to only allow internal networking + connectivity. + type: "boolean" + default: false + example: false + Attachable: + description: | + Whether a global / swarm scope network is manually attachable by regular + containers from workers in swarm mode. + type: "boolean" + default: false + example: false + Ingress: + description: | + Whether the network is providing the routing-mesh for the swarm cluster. + type: "boolean" + default: false + example: false + ConfigFrom: + $ref: "#/definitions/ConfigReference" + ConfigOnly: + description: | + Whether the network is a config-only network. Config-only networks are + placeholder networks for network configurations to be used by other + networks. Config-only networks cannot be used directly to run containers + or services. + type: "boolean" + default: false + Containers: + description: | + Contains endpoints attached to the network. + type: "object" + additionalProperties: + $ref: "#/definitions/NetworkContainer" + example: + 19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c: + Name: "test" + EndpointID: "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a" + MacAddress: "02:42:ac:13:00:02" + IPv4Address: "172.19.0.2/16" + IPv6Address: "" + Options: + description: | + Network-specific options uses when creating the network. + type: "object" + additionalProperties: + type: "string" + example: + com.docker.network.bridge.default_bridge: "true" + com.docker.network.bridge.enable_icc: "true" + com.docker.network.bridge.enable_ip_masquerade: "true" + com.docker.network.bridge.host_binding_ipv4: "0.0.0.0" + com.docker.network.bridge.name: "docker0" + com.docker.network.driver.mtu: "1500" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Peers: + description: | + List of peer nodes for an overlay network. This field is only present + for overlay networks, and omitted for other network types. + type: "array" + items: + $ref: "#/definitions/PeerInfo" + x-nullable: true + # TODO: Add Services (only present when "verbose" is set). + + ConfigReference: + description: | + The config-only network source to provide the configuration for + this network. + type: "object" + properties: + Network: + description: | + The name of the config-only network that provides the network's + configuration. The specified network must be an existing config-only + network. Only network names are allowed, not network IDs. + type: "string" + example: "config_only_network_01" + + IPAM: + type: "object" + properties: + Driver: + description: "Name of the IPAM driver to use." + type: "string" + default: "default" + example: "default" + Config: + description: | + List of IPAM configuration options, specified as a map: + + ``` + {"Subnet": , "IPRange": , "Gateway": , "AuxAddress": } + ``` + type: "array" + items: + $ref: "#/definitions/IPAMConfig" + Options: + description: "Driver-specific options, specified as a map." + type: "object" + additionalProperties: + type: "string" + example: + foo: "bar" + + IPAMConfig: + type: "object" + properties: + Subnet: + type: "string" + example: "172.20.0.0/16" + IPRange: + type: "string" + example: "172.20.10.0/24" + Gateway: + type: "string" + example: "172.20.10.11" + AuxiliaryAddresses: + type: "object" + additionalProperties: + type: "string" + + NetworkContainer: + type: "object" + properties: + Name: + type: "string" + example: "container_1" + EndpointID: + type: "string" + example: "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a" + MacAddress: + type: "string" + example: "02:42:ac:13:00:02" + IPv4Address: + type: "string" + example: "172.19.0.2/16" + IPv6Address: + type: "string" + example: "" + + PeerInfo: + description: | + PeerInfo represents one peer of an overlay network. + type: "object" + properties: + Name: + description: + ID of the peer-node in the Swarm cluster. + type: "string" + example: "6869d7c1732b" + IP: + description: + IP-address of the peer-node in the Swarm cluster. + type: "string" + example: "10.133.77.91" + + BuildInfo: + type: "object" + properties: + id: + type: "string" + stream: + type: "string" + error: + type: "string" + errorDetail: + $ref: "#/definitions/ErrorDetail" + status: + type: "string" + progress: + type: "string" + progressDetail: + $ref: "#/definitions/ProgressDetail" + aux: + $ref: "#/definitions/ImageID" + + BuildCache: + type: "object" + description: | + BuildCache contains information about a build cache record. + properties: + ID: + type: "string" + description: | + Unique ID of the build cache record. + example: "ndlpt0hhvkqcdfkputsk4cq9c" + Parents: + description: | + List of parent build cache record IDs. + type: "array" + items: + type: "string" + x-nullable: true + example: ["hw53o5aio51xtltp5xjp8v7fx"] + Type: + type: "string" + description: | + Cache record type. + example: "regular" + # see https://github.com/moby/buildkit/blob/fce4a32258dc9d9664f71a4831d5de10f0670677/client/diskusage.go#L75-L84 + enum: + - "internal" + - "frontend" + - "source.local" + - "source.git.checkout" + - "exec.cachemount" + - "regular" + Description: + type: "string" + description: | + Description of the build-step that produced the build cache. + example: "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache" + InUse: + type: "boolean" + description: | + Indicates if the build cache is in use. + example: false + Shared: + type: "boolean" + description: | + Indicates if the build cache is shared. + example: true + Size: + description: | + Amount of disk space used by the build cache (in bytes). + type: "integer" + example: 51 + CreatedAt: + description: | + Date and time at which the build cache was created in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-08-18T10:44:24.496525531Z" + LastUsedAt: + description: | + Date and time at which the build cache was last used in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + x-nullable: true + example: "2017-08-09T07:09:37.632105588Z" + UsageCount: + type: "integer" + example: 26 + + ImageID: + type: "object" + description: "Image ID or Digest" + properties: + ID: + type: "string" + example: + ID: "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c" + + CreateImageInfo: + type: "object" + properties: + id: + type: "string" + error: + type: "string" + errorDetail: + $ref: "#/definitions/ErrorDetail" + status: + type: "string" + progress: + type: "string" + progressDetail: + $ref: "#/definitions/ProgressDetail" + + PushImageInfo: + type: "object" + properties: + error: + type: "string" + status: + type: "string" + progress: + type: "string" + progressDetail: + $ref: "#/definitions/ProgressDetail" + + ErrorDetail: + type: "object" + properties: + code: + type: "integer" + message: + type: "string" + + ProgressDetail: + type: "object" + properties: + current: + type: "integer" + total: + type: "integer" + + ErrorResponse: + description: "Represents an error." + type: "object" + required: ["message"] + properties: + message: + description: "The error message." + type: "string" + x-nullable: false + example: + message: "Something went wrong." + + IdResponse: + description: "Response to an API call that returns just an Id" + type: "object" + required: ["Id"] + properties: + Id: + description: "The id of the newly created object." + type: "string" + x-nullable: false + + EndpointSettings: + description: "Configuration for a network endpoint." + type: "object" + properties: + # Configurations + IPAMConfig: + $ref: "#/definitions/EndpointIPAMConfig" + Links: + type: "array" + items: + type: "string" + example: + - "container_1" + - "container_2" + MacAddress: + description: | + MAC address for the endpoint on this network. The network driver might ignore this parameter. + type: "string" + example: "02:42:ac:11:00:04" + Aliases: + type: "array" + items: + type: "string" + example: + - "server_x" + - "server_y" + + # Operational data + NetworkID: + description: | + Unique ID of the network. + type: "string" + example: "08754567f1f40222263eab4102e1c733ae697e8e354aa9cd6e18d7402835292a" + EndpointID: + description: | + Unique ID for the service endpoint in a Sandbox. + type: "string" + example: "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b" + Gateway: + description: | + Gateway address for this network. + type: "string" + example: "172.17.0.1" + IPAddress: + description: | + IPv4 address. + type: "string" + example: "172.17.0.4" + IPPrefixLen: + description: | + Mask length of the IPv4 address. + type: "integer" + example: 16 + IPv6Gateway: + description: | + IPv6 gateway address. + type: "string" + example: "2001:db8:2::100" + GlobalIPv6Address: + description: | + Global IPv6 address. + type: "string" + example: "2001:db8::5689" + GlobalIPv6PrefixLen: + description: | + Mask length of the global IPv6 address. + type: "integer" + format: "int64" + example: 64 + DriverOpts: + description: | + DriverOpts is a mapping of driver options and values. These options + are passed directly to the driver and are driver specific. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + DNSNames: + description: | + List of all DNS names an endpoint has on a specific network. This + list is based on the container name, network aliases, container short + ID, and hostname. + + These DNS names are non-fully qualified but can contain several dots. + You can get fully qualified DNS names by appending `.`. + For instance, if container name is `my.ctr` and the network is named + `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be + `my.ctr.testnet`. + type: array + items: + type: string + example: ["foobar", "server_x", "server_y", "my.ctr"] + + EndpointIPAMConfig: + description: | + EndpointIPAMConfig represents an endpoint's IPAM configuration. + type: "object" + x-nullable: true + properties: + IPv4Address: + type: "string" + example: "172.20.30.33" + IPv6Address: + type: "string" + example: "2001:db8:abcd::3033" + LinkLocalIPs: + type: "array" + items: + type: "string" + example: + - "169.254.34.68" + - "fe80::3468" + + PluginMount: + type: "object" + x-nullable: false + required: [Name, Description, Settable, Source, Destination, Type, Options] + properties: + Name: + type: "string" + x-nullable: false + example: "some-mount" + Description: + type: "string" + x-nullable: false + example: "This is a mount that's used by the plugin." + Settable: + type: "array" + items: + type: "string" + Source: + type: "string" + example: "/var/lib/docker/plugins/" + Destination: + type: "string" + x-nullable: false + example: "/mnt/state" + Type: + type: "string" + x-nullable: false + example: "bind" + Options: + type: "array" + items: + type: "string" + example: + - "rbind" + - "rw" + + PluginDevice: + type: "object" + required: [Name, Description, Settable, Path] + x-nullable: false + properties: + Name: + type: "string" + x-nullable: false + Description: + type: "string" + x-nullable: false + Settable: + type: "array" + items: + type: "string" + Path: + type: "string" + example: "/dev/fuse" + + PluginEnv: + type: "object" + x-nullable: false + required: [Name, Description, Settable, Value] + properties: + Name: + x-nullable: false + type: "string" + Description: + x-nullable: false + type: "string" + Settable: + type: "array" + items: + type: "string" + Value: + type: "string" + + PluginInterfaceType: + type: "object" + x-nullable: false + required: [Prefix, Capability, Version] + properties: + Prefix: + type: "string" + x-nullable: false + Capability: + type: "string" + x-nullable: false + Version: + 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" + required: [Settings, Enabled, Config, Name] + properties: + Id: + type: "string" + example: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078" + Name: + type: "string" + x-nullable: false + example: "tiborvass/sample-volume-plugin" + Enabled: + description: + True if the plugin is running. False if the plugin is not running, + only installed. + type: "boolean" + x-nullable: false + example: true + Settings: + description: "Settings that can be modified by users." + type: "object" + x-nullable: false + required: [Args, Devices, Env, Mounts] + properties: + Mounts: + type: "array" + items: + $ref: "#/definitions/PluginMount" + Env: + type: "array" + items: + type: "string" + example: + - "DEBUG=0" + Args: + type: "array" + items: + type: "string" + Devices: + type: "array" + items: + $ref: "#/definitions/PluginDevice" + PluginReference: + description: "plugin remote reference used to push/pull the plugin" + type: "string" + x-nullable: false + example: "localhost:5000/tiborvass/sample-volume-plugin:latest" + Config: + description: "The config of a plugin." + type: "object" + x-nullable: false + required: + - Description + - Documentation + - Interface + - Entrypoint + - WorkDir + - Network + - Linux + - PidHost + - PropagatedMount + - IpcHost + - Mounts + - Env + - Args + properties: + DockerVersion: + description: "Docker Version used to create the plugin" + type: "string" + x-nullable: false + example: "17.06.0-ce" + Description: + type: "string" + x-nullable: false + example: "A sample volume plugin for Docker" + Documentation: + type: "string" + x-nullable: false + example: "https://docs.docker.com/engine/extend/plugins/" + Interface: + description: "The interface between Docker and the plugin" + x-nullable: false + type: "object" + required: [Types, Socket] + properties: + Types: + type: "array" + items: + $ref: "#/definitions/PluginInterfaceType" + example: + - "docker.volumedriver/1.0" + Socket: + type: "string" + x-nullable: false + example: "plugins.sock" + ProtocolScheme: + type: "string" + example: "some.protocol/v1.0" + description: "Protocol to use for clients connecting to the plugin." + enum: + - "" + - "moby.plugins.http/v1" + Entrypoint: + type: "array" + items: + type: "string" + example: + - "/usr/bin/sample-volume-plugin" + - "/data" + WorkDir: + type: "string" + x-nullable: false + example: "/bin/" + User: + type: "object" + x-nullable: false + properties: + UID: + type: "integer" + format: "uint32" + example: 1000 + GID: + type: "integer" + format: "uint32" + example: 1000 + Network: + type: "object" + x-nullable: false + required: [Type] + properties: + Type: + x-nullable: false + type: "string" + example: "host" + Linux: + type: "object" + x-nullable: false + required: [Capabilities, AllowAllDevices, Devices] + properties: + Capabilities: + type: "array" + items: + type: "string" + example: + - "CAP_SYS_ADMIN" + - "CAP_SYSLOG" + AllowAllDevices: + type: "boolean" + x-nullable: false + example: false + Devices: + type: "array" + items: + $ref: "#/definitions/PluginDevice" + PropagatedMount: + type: "string" + x-nullable: false + example: "/mnt/volumes" + IpcHost: + type: "boolean" + x-nullable: false + example: false + PidHost: + type: "boolean" + x-nullable: false + example: false + Mounts: + type: "array" + items: + $ref: "#/definitions/PluginMount" + Env: + type: "array" + items: + $ref: "#/definitions/PluginEnv" + example: + - Name: "DEBUG" + Description: "If set, prints debug messages" + Settable: null + Value: "0" + Args: + type: "object" + x-nullable: false + required: [Name, Description, Settable, Value] + properties: + Name: + x-nullable: false + type: "string" + example: "args" + Description: + x-nullable: false + type: "string" + example: "command line arguments" + Settable: + type: "array" + items: + type: "string" + Value: + type: "array" + items: + type: "string" + rootfs: + type: "object" + properties: + type: + type: "string" + example: "layers" + diff_ids: + type: "array" + items: + type: "string" + example: + - "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887" + - "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8" + + ObjectVersion: + description: | + The version number of the object such as node, service, etc. This is needed + to avoid conflicting writes. The client must send the version number along + with the modified specification when updating these objects. + + This approach ensures safe concurrency and determinism in that the change + on the object may not be applied if the version number has changed from the + last read. In other words, if two update requests specify the same base + version, only one of the requests can succeed. As a result, two separate + update requests that happen at the same time will not unintentionally + overwrite each other. + type: "object" + properties: + Index: + type: "integer" + format: "uint64" + example: 373531 + + NodeSpec: + type: "object" + properties: + Name: + description: "Name for the node." + type: "string" + example: "my-node" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + Role: + description: "Role of the node." + type: "string" + enum: + - "worker" + - "manager" + example: "manager" + Availability: + description: "Availability of the node." + type: "string" + enum: + - "active" + - "pause" + - "drain" + example: "active" + example: + Availability: "active" + Name: "node-name" + Role: "manager" + Labels: + foo: "bar" + + Node: + type: "object" + properties: + ID: + type: "string" + example: "24ifsmvkjbyhk" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + description: | + Date and time at which the node was added to the swarm in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-08-18T10:44:24.496525531Z" + UpdatedAt: + description: | + Date and time at which the node was last updated in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2017-08-09T07:09:37.632105588Z" + Spec: + $ref: "#/definitions/NodeSpec" + Description: + $ref: "#/definitions/NodeDescription" + Status: + $ref: "#/definitions/NodeStatus" + ManagerStatus: + $ref: "#/definitions/ManagerStatus" + + NodeDescription: + description: | + NodeDescription encapsulates the properties of the Node as reported by the + agent. + type: "object" + properties: + Hostname: + type: "string" + example: "bf3067039e47" + Platform: + $ref: "#/definitions/Platform" + Resources: + $ref: "#/definitions/ResourceObject" + Engine: + $ref: "#/definitions/EngineDescription" + TLSInfo: + $ref: "#/definitions/TLSInfo" + + Platform: + description: | + Platform represents the platform (Arch/OS). + type: "object" + properties: + Architecture: + description: | + Architecture represents the hardware architecture (for example, + `x86_64`). + type: "string" + example: "x86_64" + OS: + description: | + OS represents the Operating System (for example, `linux` or `windows`). + type: "string" + example: "linux" + + EngineDescription: + description: "EngineDescription provides information about an engine." + type: "object" + properties: + EngineVersion: + type: "string" + example: "17.06.0" + Labels: + type: "object" + additionalProperties: + type: "string" + example: + foo: "bar" + Plugins: + type: "array" + items: + type: "object" + properties: + Type: + type: "string" + Name: + type: "string" + example: + - Type: "Log" + Name: "awslogs" + - Type: "Log" + Name: "fluentd" + - Type: "Log" + Name: "gcplogs" + - Type: "Log" + Name: "gelf" + - Type: "Log" + Name: "journald" + - Type: "Log" + Name: "json-file" + - Type: "Log" + Name: "splunk" + - Type: "Log" + Name: "syslog" + - Type: "Network" + Name: "bridge" + - Type: "Network" + Name: "host" + - Type: "Network" + Name: "ipvlan" + - Type: "Network" + Name: "macvlan" + - Type: "Network" + Name: "null" + - Type: "Network" + Name: "overlay" + - Type: "Volume" + Name: "local" + - Type: "Volume" + Name: "localhost:5000/vieux/sshfs:latest" + - Type: "Volume" + Name: "vieux/sshfs:latest" + + TLSInfo: + description: | + Information about the issuer of leaf TLS certificates and the trusted root + CA certificate. + type: "object" + properties: + TrustRoot: + description: | + The root CA certificate(s) that are used to validate leaf TLS + certificates. + type: "string" + CertIssuerSubject: + description: + The base64-url-safe-encoded raw subject bytes of the issuer. + type: "string" + CertIssuerPublicKey: + description: | + The base64-url-safe-encoded raw public key bytes of the issuer. + type: "string" + example: + TrustRoot: | + -----BEGIN CERTIFICATE----- + MIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw + EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0 + MzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH + A0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf + 3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB + Af8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO + PQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz + pxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H + -----END CERTIFICATE----- + CertIssuerSubject: "MBMxETAPBgNVBAMTCHN3YXJtLWNh" + CertIssuerPublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==" + + NodeStatus: + description: | + NodeStatus represents the status of a node. + + It provides the current status of the node, as seen by the manager. + type: "object" + properties: + State: + $ref: "#/definitions/NodeState" + Message: + type: "string" + example: "" + Addr: + description: "IP address of the node." + type: "string" + example: "172.17.0.2" + + NodeState: + description: "NodeState represents the state of a node." + type: "string" + enum: + - "unknown" + - "down" + - "ready" + - "disconnected" + example: "ready" + + ManagerStatus: + description: | + ManagerStatus represents the status of a manager. + + It provides the current status of a node's manager component, if the node + is a manager. + x-nullable: true + type: "object" + properties: + Leader: + type: "boolean" + default: false + example: true + Reachability: + $ref: "#/definitions/Reachability" + Addr: + description: | + The IP address and port at which the manager is reachable. + type: "string" + example: "10.0.0.46:2377" + + Reachability: + description: "Reachability represents the reachability of a node." + type: "string" + enum: + - "unknown" + - "unreachable" + - "reachable" + example: "reachable" + + SwarmSpec: + description: "User modifiable swarm configuration." + type: "object" + properties: + Name: + description: "Name of the swarm." + type: "string" + example: "default" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.corp.type: "production" + com.example.corp.department: "engineering" + Orchestration: + description: "Orchestration configuration." + type: "object" + x-nullable: true + properties: + TaskHistoryRetentionLimit: + description: | + The number of historic tasks to keep per instance or node. If + negative, never remove completed or failed tasks. + type: "integer" + format: "int64" + example: 10 + Raft: + description: "Raft configuration." + type: "object" + properties: + SnapshotInterval: + description: "The number of log entries between snapshots." + type: "integer" + format: "uint64" + example: 10000 + KeepOldSnapshots: + description: | + The number of snapshots to keep beyond the current snapshot. + type: "integer" + format: "uint64" + LogEntriesForSlowFollowers: + description: | + The number of log entries to keep around to sync up slow followers + after a snapshot is created. + type: "integer" + format: "uint64" + example: 500 + ElectionTick: + description: | + The number of ticks that a follower will wait for a message from + the leader before becoming a candidate and starting an election. + `ElectionTick` must be greater than `HeartbeatTick`. + + A tick currently defaults to one second, so these translate + directly to seconds currently, but this is NOT guaranteed. + type: "integer" + example: 3 + HeartbeatTick: + description: | + The number of ticks between heartbeats. Every HeartbeatTick ticks, + the leader will send a heartbeat to the followers. + + A tick currently defaults to one second, so these translate + directly to seconds currently, but this is NOT guaranteed. + type: "integer" + example: 1 + Dispatcher: + description: "Dispatcher configuration." + type: "object" + x-nullable: true + properties: + HeartbeatPeriod: + description: | + The delay for an agent to send a heartbeat to the dispatcher. + type: "integer" + format: "int64" + example: 5000000000 + CAConfig: + description: "CA configuration." + type: "object" + x-nullable: true + properties: + NodeCertExpiry: + description: "The duration node certificates are issued for." + type: "integer" + format: "int64" + example: 7776000000000000 + ExternalCAs: + description: | + Configuration for forwarding signing requests to an external + certificate authority. + type: "array" + items: + type: "object" + properties: + Protocol: + description: | + Protocol for communication with the external CA (currently + only `cfssl` is supported). + type: "string" + enum: + - "cfssl" + default: "cfssl" + URL: + description: | + URL where certificate signing requests should be sent. + type: "string" + Options: + description: | + An object with key/value pairs that are interpreted as + protocol-specific options for the external CA driver. + type: "object" + additionalProperties: + type: "string" + CACert: + description: | + The root CA certificate (in PEM format) this external CA uses + to issue TLS certificates (assumed to be to the current swarm + root CA certificate if not provided). + type: "string" + SigningCACert: + description: | + The desired signing CA certificate for all swarm node TLS leaf + certificates, in PEM format. + type: "string" + SigningCAKey: + description: | + The desired signing CA key for all swarm node TLS leaf certificates, + in PEM format. + type: "string" + ForceRotate: + description: | + An integer whose purpose is to force swarm to generate a new + signing CA certificate and key, if none have been specified in + `SigningCACert` and `SigningCAKey` + format: "uint64" + type: "integer" + EncryptionConfig: + description: "Parameters related to encryption-at-rest." + type: "object" + properties: + AutoLockManagers: + description: | + If set, generate a key and use it to lock data stored on the + managers. + type: "boolean" + example: false + TaskDefaults: + description: "Defaults for creating tasks in this cluster." + type: "object" + properties: + LogDriver: + description: | + The log driver to use for tasks created in the orchestrator if + unspecified by a service. + + Updating this value only affects new tasks. Existing tasks continue + to use their previously configured log driver until recreated. + type: "object" + properties: + Name: + description: | + The log driver to use as a default for new tasks. + type: "string" + example: "json-file" + Options: + description: | + Driver-specific options for the selected log driver, specified + as key/value pairs. + type: "object" + additionalProperties: + type: "string" + example: + "max-file": "10" + "max-size": "100m" + + # The Swarm information for `GET /info`. It is the same as `GET /swarm`, but + # without `JoinTokens`. + ClusterInfo: + description: | + ClusterInfo represents information about the swarm as is returned by the + "/info" endpoint. Join-tokens are not included. + x-nullable: true + type: "object" + properties: + ID: + description: "The ID of the swarm." + type: "string" + example: "abajmipo7b4xz5ip2nrla6b11" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + description: | + Date and time at which the swarm was initialised in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-08-18T10:44:24.496525531Z" + UpdatedAt: + description: | + Date and time at which the swarm was last updated in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2017-08-09T07:09:37.632105588Z" + Spec: + $ref: "#/definitions/SwarmSpec" + TLSInfo: + $ref: "#/definitions/TLSInfo" + RootRotationInProgress: + description: | + Whether there is currently a root CA rotation in progress for the swarm + type: "boolean" + example: false + DataPathPort: + description: | + 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, the default port (4789) is used. + type: "integer" + format: "uint32" + default: 4789 + example: 4789 + DefaultAddrPool: + description: | + Default Address Pool specifies default subnet pools for global scope + networks. + type: "array" + items: + type: "string" + format: "CIDR" + example: ["10.10.0.0/16", "20.20.0.0/16"] + SubnetSize: + description: | + SubnetSize specifies the subnet size of the networks created from the + default subnet pool. + type: "integer" + format: "uint32" + maximum: 29 + default: 24 + example: 24 + + JoinTokens: + description: | + JoinTokens contains the tokens workers and managers need to join the swarm. + type: "object" + properties: + Worker: + description: | + The token workers can use to join the swarm. + type: "string" + example: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx" + Manager: + description: | + The token managers can use to join the swarm. + type: "string" + example: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" + + Swarm: + type: "object" + allOf: + - $ref: "#/definitions/ClusterInfo" + - type: "object" + properties: + JoinTokens: + $ref: "#/definitions/JoinTokens" + + TaskSpec: + description: "User modifiable task configuration." + type: "object" + properties: + PluginSpec: + type: "object" + description: | + Plugin spec for the service. *(Experimental release only.)* + +


+ + > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are + > mutually exclusive. PluginSpec is only used when the Runtime field + > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime + > field is set to `attachment`. + properties: + Name: + description: "The name or 'alias' to use for the plugin." + type: "string" + Remote: + description: "The plugin image reference to use." + type: "string" + Disabled: + description: "Disable the plugin once scheduled." + type: "boolean" + PluginPrivilege: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + ContainerSpec: + type: "object" + description: | + Container spec for the service. + +


+ + > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are + > mutually exclusive. PluginSpec is only used when the Runtime field + > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime + > field is set to `attachment`. + properties: + Image: + description: "The image name to use for the container" + type: "string" + Labels: + description: "User-defined key/value data." + type: "object" + additionalProperties: + type: "string" + Command: + description: "The command to be run in the image." + type: "array" + items: + type: "string" + Args: + description: "Arguments to the command." + type: "array" + items: + type: "string" + Hostname: + description: | + The hostname to use for the container, as a valid + [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. + type: "string" + Env: + description: | + A list of environment variables in the form `VAR=value`. + type: "array" + items: + type: "string" + Dir: + description: "The working directory for commands to run in." + type: "string" + User: + description: "The user inside the container." + type: "string" + Groups: + type: "array" + description: | + A list of additional groups that the container process will run as. + items: + type: "string" + Privileges: + type: "object" + description: "Security options for the container" + properties: + CredentialSpec: + type: "object" + description: "CredentialSpec for managed service account (Windows only)" + properties: + Config: + type: "string" + example: "0bt9dmxjvjiqermk6xrop3ekq" + description: | + Load credential spec from a Swarm Config with the given ID. + The specified config must also be present in the Configs + field with the Runtime property set. + +


+ + + > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, + > and `CredentialSpec.Config` are mutually exclusive. + File: + type: "string" + example: "spec.json" + description: | + Load credential spec from this file. The file is read by + the daemon, and must be present in the `CredentialSpecs` + subdirectory in the docker data directory, which defaults + to `C:\ProgramData\Docker\` on Windows. + + For example, specifying `spec.json` loads + `C:\ProgramData\Docker\CredentialSpecs\spec.json`. + +


+ + > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, + > and `CredentialSpec.Config` are mutually exclusive. + Registry: + type: "string" + description: | + Load credential spec from this value in the Windows + registry. The specified registry value must be located in: + + `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs` + +


+ + + > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, + > and `CredentialSpec.Config` are mutually exclusive. + SELinuxContext: + type: "object" + description: "SELinux labels of the container" + properties: + Disable: + type: "boolean" + description: "Disable SELinux" + User: + type: "string" + description: "SELinux user label" + Role: + type: "string" + description: "SELinux role label" + Type: + type: "string" + description: "SELinux type label" + Level: + type: "string" + description: "SELinux level label" + Seccomp: + type: "object" + description: "Options for configuring seccomp on the container" + properties: + Mode: + type: "string" + enum: + - "default" + - "unconfined" + - "custom" + Profile: + description: "The custom seccomp profile as a json object" + type: "string" + AppArmor: + type: "object" + description: "Options for configuring AppArmor on the container" + properties: + Mode: + type: "string" + enum: + - "default" + - "disabled" + NoNewPrivileges: + type: "boolean" + description: "Configuration of the no_new_privs bit in the container" + + TTY: + description: "Whether a pseudo-TTY should be allocated." + type: "boolean" + OpenStdin: + description: "Open `stdin`" + type: "boolean" + ReadOnly: + description: "Mount the container's root filesystem as read only." + type: "boolean" + Mounts: + description: | + Specification for mounts to be added to containers created as part + of the service. + type: "array" + items: + $ref: "#/definitions/Mount" + StopSignal: + description: "Signal to stop the container." + type: "string" + StopGracePeriod: + description: | + Amount of time to wait for the container to terminate before + forcefully killing it. + type: "integer" + format: "int64" + HealthCheck: + $ref: "#/definitions/HealthConfig" + Hosts: + type: "array" + description: | + A list of hostname/IP mappings to add to the container's `hosts` + file. The format of extra hosts is specified in the + [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) + man page: + + IP_address canonical_hostname [aliases] + items: + type: "string" + DNSConfig: + description: | + Specification for DNS related configurations in resolver configuration + file (`resolv.conf`). + type: "object" + properties: + Nameservers: + description: "The IP addresses of the name servers." + type: "array" + items: + type: "string" + Search: + description: "A search list for host-name lookup." + type: "array" + items: + type: "string" + Options: + description: | + A list of internal resolver variables to be modified (e.g., + `debug`, `ndots:3`, etc.). + type: "array" + items: + type: "string" + Secrets: + description: | + Secrets contains references to zero or more secrets that will be + exposed to the service. + type: "array" + items: + type: "object" + properties: + File: + description: | + File represents a specific target that is backed by a file. + type: "object" + properties: + Name: + description: | + Name represents the final filename in the filesystem. + type: "string" + UID: + description: "UID represents the file UID." + type: "string" + GID: + description: "GID represents the file GID." + type: "string" + Mode: + description: "Mode represents the FileMode of the file." + type: "integer" + format: "uint32" + SecretID: + description: | + SecretID represents the ID of the specific secret that we're + referencing. + type: "string" + SecretName: + description: | + SecretName is the name of the secret that this references, + but this is just provided for lookup/display purposes. The + secret in the reference will be identified by its ID. + type: "string" + Configs: + description: | + Configs contains references to zero or more configs that will be + exposed to the service. + type: "array" + items: + type: "object" + properties: + File: + description: | + File represents a specific target that is backed by a file. + +


+ + > **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive + type: "object" + properties: + Name: + description: | + Name represents the final filename in the filesystem. + type: "string" + UID: + description: "UID represents the file UID." + type: "string" + GID: + description: "GID represents the file GID." + type: "string" + Mode: + description: "Mode represents the FileMode of the file." + type: "integer" + format: "uint32" + Runtime: + description: | + Runtime represents a target that is not mounted into the + container but is used by the task + +


+ + > **Note**: `Configs.File` and `Configs.Runtime` are mutually + > exclusive + type: "object" + ConfigID: + description: | + ConfigID represents the ID of the specific config that we're + referencing. + type: "string" + ConfigName: + description: | + ConfigName is the name of the config that this references, + but this is just provided for lookup/display purposes. The + config in the reference will be identified by its ID. + type: "string" + Isolation: + type: "string" + description: | + Isolation technology of the containers running the service. + (Windows only) + enum: + - "default" + - "process" + - "hyperv" + - "" + Init: + description: | + Run an init inside the container that forwards signals and reaps + processes. This field is omitted if empty, and the default (as + configured on the daemon) is used. + type: "boolean" + x-nullable: true + Sysctls: + description: | + Set kernel namedspaced parameters (sysctls) in the container. + The Sysctls option on services accepts the same sysctls as the + are supported on containers. Note that while the same sysctls are + supported, no guarantees or checks are made about their + suitability for a clustered environment, and it's up to the user + to determine whether a given sysctl will work properly in a + Service. + type: "object" + additionalProperties: + type: "string" + # This option is not used by Windows containers + CapabilityAdd: + type: "array" + description: | + A list of kernel capabilities to add to the default set + for the container. + items: + type: "string" + example: + - "CAP_NET_RAW" + - "CAP_SYS_ADMIN" + - "CAP_SYS_CHROOT" + - "CAP_SYSLOG" + CapabilityDrop: + type: "array" + description: | + A list of kernel capabilities to drop from the default set + for the container. + items: + type: "string" + example: + - "CAP_NET_RAW" + Ulimits: + description: | + A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`" + type: "array" + items: + type: "object" + properties: + Name: + description: "Name of ulimit" + type: "string" + Soft: + description: "Soft limit" + type: "integer" + Hard: + description: "Hard limit" + type: "integer" + NetworkAttachmentSpec: + description: | + Read-only spec type for non-swarm containers attached to swarm overlay + networks. + +


+ + > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are + > mutually exclusive. PluginSpec is only used when the Runtime field + > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime + > field is set to `attachment`. + type: "object" + properties: + ContainerID: + description: "ID of the container represented by this task" + type: "string" + Resources: + description: | + Resource requirements which apply to each individual container created + as part of the service. + type: "object" + properties: + Limits: + description: "Define resources limits." + $ref: "#/definitions/Limit" + Reservations: + description: "Define resources reservation." + $ref: "#/definitions/ResourceObject" + RestartPolicy: + description: | + Specification for the restart policy which applies to containers + created as part of this service. + type: "object" + properties: + Condition: + description: "Condition for restart." + type: "string" + enum: + - "none" + - "on-failure" + - "any" + Delay: + description: "Delay between restart attempts." + type: "integer" + format: "int64" + MaxAttempts: + description: | + Maximum attempts to restart a given container before giving up + (default value is 0, which is ignored). + type: "integer" + format: "int64" + default: 0 + Window: + description: | + Windows is the time window used to evaluate the restart policy + (default value is 0, which is unbounded). + type: "integer" + format: "int64" + default: 0 + Placement: + type: "object" + properties: + Constraints: + description: | + An array of constraint expressions to limit the set of nodes where + a task can be scheduled. Constraint expressions can either use a + _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find + nodes that satisfy every expression (AND match). Constraints can + match node or Docker Engine labels as follows: + + node attribute | matches | example + ---------------------|--------------------------------|----------------------------------------------- + `node.id` | Node ID | `node.id==2ivku8v2gvtg4` + `node.hostname` | Node hostname | `node.hostname!=node-2` + `node.role` | Node role (`manager`/`worker`) | `node.role==manager` + `node.platform.os` | Node operating system | `node.platform.os==windows` + `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` + `node.labels` | User-defined node labels | `node.labels.security==high` + `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` + + `engine.labels` apply to Docker Engine labels like operating system, + drivers, etc. Swarm administrators add `node.labels` for operational + purposes by using the [`node update endpoint`](#operation/NodeUpdate). + + type: "array" + items: + type: "string" + example: + - "node.hostname!=node3.corp.example.com" + - "node.role!=manager" + - "node.labels.type==production" + - "node.platform.os==linux" + - "node.platform.arch==x86_64" + Preferences: + description: | + Preferences provide a way to make the scheduler aware of factors + such as topology. They are provided in order from highest to + lowest precedence. + type: "array" + items: + type: "object" + properties: + Spread: + type: "object" + properties: + SpreadDescriptor: + description: | + label descriptor, such as `engine.labels.az`. + type: "string" + example: + - Spread: + SpreadDescriptor: "node.labels.datacenter" + - Spread: + SpreadDescriptor: "node.labels.rack" + MaxReplicas: + description: | + Maximum number of replicas for per node (default value is 0, which + is unlimited) + type: "integer" + format: "int64" + default: 0 + Platforms: + description: | + Platforms stores all the platforms that the service's image can + run on. This field is used in the platform filter for scheduling. + If empty, then the platform filter is off, meaning there are no + scheduling restrictions. + type: "array" + items: + $ref: "#/definitions/Platform" + ForceUpdate: + description: | + A counter that triggers an update even if no relevant parameters have + been changed. + type: "integer" + format: "uint64" + Runtime: + description: | + Runtime is the type of runtime specified for the task executor. + type: "string" + Networks: + description: "Specifies which networks the service should attach to." + type: "array" + items: + $ref: "#/definitions/NetworkAttachmentConfig" + LogDriver: + description: | + Specifies the log driver to use for tasks created from this spec. If + not present, the default one for the swarm will be used, finally + falling back to the engine default if not specified. + type: "object" + properties: + Name: + type: "string" + Options: + type: "object" + additionalProperties: + type: "string" + + TaskState: + type: "string" + enum: + - "new" + - "allocated" + - "pending" + - "assigned" + - "accepted" + - "preparing" + - "ready" + - "starting" + - "running" + - "complete" + - "shutdown" + - "failed" + - "rejected" + - "remove" + - "orphaned" + + ContainerStatus: + type: "object" + description: "represents the status of a container." + properties: + ContainerID: + type: "string" + PID: + type: "integer" + ExitCode: + type: "integer" + + PortStatus: + type: "object" + description: "represents the port status of a task's host ports whose service has published host ports" + properties: + Ports: + type: "array" + items: + $ref: "#/definitions/EndpointPortConfig" + + TaskStatus: + type: "object" + description: "represents the status of a task." + properties: + Timestamp: + type: "string" + format: "dateTime" + State: + $ref: "#/definitions/TaskState" + Message: + type: "string" + Err: + type: "string" + ContainerStatus: + $ref: "#/definitions/ContainerStatus" + PortStatus: + $ref: "#/definitions/PortStatus" + + Task: + type: "object" + properties: + ID: + description: "The ID of the task." + type: "string" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Name: + description: "Name of the task." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + Spec: + $ref: "#/definitions/TaskSpec" + ServiceID: + description: "The ID of the service this task is part of." + type: "string" + Slot: + type: "integer" + NodeID: + description: "The ID of the node that this task is on." + type: "string" + AssignedGenericResources: + $ref: "#/definitions/GenericResources" + Status: + $ref: "#/definitions/TaskStatus" + DesiredState: + $ref: "#/definitions/TaskState" + JobIteration: + description: | + If the Service this Task belongs to is a job-mode service, contains + the JobIteration of the Service this Task was created for. Absent if + the Task was created for a Replicated or Global Service. + $ref: "#/definitions/ObjectVersion" + example: + ID: "0kzzo1i0y4jz6027t0k7aezc7" + Version: + Index: 71 + CreatedAt: "2016-06-07T21:07:31.171892745Z" + UpdatedAt: "2016-06-07T21:07:31.376370513Z" + Spec: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Slot: 1 + NodeID: "60gvrl6tm78dmak4yl7srz94v" + Status: + Timestamp: "2016-06-07T21:07:31.290032978Z" + State: "running" + Message: "started" + ContainerStatus: + ContainerID: "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035" + PID: 677 + DesiredState: "running" + NetworksAttachments: + - Network: + ID: "4qvuz4ko70xaltuqbt8956gd1" + Version: + Index: 18 + CreatedAt: "2016-06-07T20:31:11.912919752Z" + UpdatedAt: "2016-06-07T21:07:29.955277358Z" + Spec: + Name: "ingress" + Labels: + com.docker.swarm.internal: "true" + DriverConfiguration: {} + IPAMOptions: + Driver: {} + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + DriverState: + Name: "overlay" + Options: + com.docker.network.driver.overlay.vxlanid_list: "256" + IPAMOptions: + Driver: + Name: "default" + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + Addresses: + - "10.255.0.10/16" + AssignedGenericResources: + - DiscreteResourceSpec: + Kind: "SSD" + Value: 3 + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID1" + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID2" + + ServiceSpec: + description: "User modifiable configuration for a service." + type: object + properties: + Name: + description: "Name of the service." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + TaskTemplate: + $ref: "#/definitions/TaskSpec" + Mode: + description: "Scheduling mode for the service." + type: "object" + properties: + Replicated: + type: "object" + properties: + Replicas: + type: "integer" + format: "int64" + Global: + type: "object" + ReplicatedJob: + description: | + The mode used for services with a finite number of tasks that run + to a completed state. + type: "object" + properties: + MaxConcurrent: + description: | + The maximum number of replicas to run simultaneously. + type: "integer" + format: "int64" + default: 1 + TotalCompletions: + description: | + The total number of replicas desired to reach the Completed + state. If unset, will default to the value of `MaxConcurrent` + type: "integer" + format: "int64" + GlobalJob: + description: | + The mode used for services which run a task to the completed state + on each valid node. + type: "object" + UpdateConfig: + description: "Specification for the update strategy of the service." + type: "object" + properties: + Parallelism: + description: | + Maximum number of tasks to be updated in one iteration (0 means + unlimited parallelism). + type: "integer" + format: "int64" + Delay: + description: "Amount of time between updates, in nanoseconds." + type: "integer" + format: "int64" + FailureAction: + description: | + Action to take if an updated task fails to run, or stops running + during the update. + type: "string" + enum: + - "continue" + - "pause" + - "rollback" + Monitor: + description: | + Amount of time to monitor each updated task for failures, in + nanoseconds. + type: "integer" + format: "int64" + MaxFailureRatio: + description: | + The fraction of tasks that may fail during an update before the + failure action is invoked, specified as a floating point number + between 0 and 1. + type: "number" + default: 0 + Order: + description: | + The order of operations when rolling out an updated task. Either + the old task is shut down before the new task is started, or the + new task is started before the old task is shut down. + type: "string" + enum: + - "stop-first" + - "start-first" + RollbackConfig: + description: "Specification for the rollback strategy of the service." + type: "object" + properties: + Parallelism: + description: | + Maximum number of tasks to be rolled back in one iteration (0 means + unlimited parallelism). + type: "integer" + format: "int64" + Delay: + description: | + Amount of time between rollback iterations, in nanoseconds. + type: "integer" + format: "int64" + FailureAction: + description: | + Action to take if an rolled back task fails to run, or stops + running during the rollback. + type: "string" + enum: + - "continue" + - "pause" + Monitor: + description: | + Amount of time to monitor each rolled back task for failures, in + nanoseconds. + type: "integer" + format: "int64" + MaxFailureRatio: + description: | + The fraction of tasks that may fail during a rollback before the + failure action is invoked, specified as a floating point number + between 0 and 1. + type: "number" + default: 0 + Order: + description: | + The order of operations when rolling back a task. Either the old + task is shut down before the new task is started, or the new task + is started before the old task is shut down. + type: "string" + enum: + - "stop-first" + - "start-first" + Networks: + description: | + Specifies which networks the service should attach to. + + Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + type: "array" + items: + $ref: "#/definitions/NetworkAttachmentConfig" + + EndpointSpec: + $ref: "#/definitions/EndpointSpec" + + EndpointPortConfig: + type: "object" + properties: + Name: + type: "string" + Protocol: + type: "string" + enum: + - "tcp" + - "udp" + - "sctp" + TargetPort: + description: "The port inside the container." + type: "integer" + PublishedPort: + description: "The port on the swarm hosts." + type: "integer" + PublishMode: + description: | + The mode in which port is published. + +


+ + - "ingress" makes the target port accessible on every node, + regardless of whether there is a task for the service running on + that node or not. + - "host" bypasses the routing mesh and publish the port directly on + the swarm node where that service is running. + + type: "string" + enum: + - "ingress" + - "host" + default: "ingress" + example: "ingress" + + EndpointSpec: + description: "Properties that can be configured to access and load balance a service." + type: "object" + properties: + Mode: + description: | + The mode of resolution to use for internal load balancing between tasks. + type: "string" + enum: + - "vip" + - "dnsrr" + default: "vip" + Ports: + description: | + List of exposed ports that this service is accessible on from the + outside. Ports can only be provided if `vip` resolution mode is used. + type: "array" + items: + $ref: "#/definitions/EndpointPortConfig" + + Service: + type: "object" + properties: + ID: + type: "string" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Spec: + $ref: "#/definitions/ServiceSpec" + Endpoint: + type: "object" + properties: + Spec: + $ref: "#/definitions/EndpointSpec" + Ports: + type: "array" + items: + $ref: "#/definitions/EndpointPortConfig" + VirtualIPs: + type: "array" + items: + type: "object" + properties: + NetworkID: + type: "string" + Addr: + type: "string" + UpdateStatus: + description: "The status of a service update." + type: "object" + properties: + State: + type: "string" + enum: + - "updating" + - "paused" + - "completed" + StartedAt: + type: "string" + format: "dateTime" + CompletedAt: + type: "string" + format: "dateTime" + Message: + type: "string" + ServiceStatus: + description: | + The status of the service's tasks. Provided only when requested as + part of a ServiceList operation. + type: "object" + properties: + RunningTasks: + description: | + The number of tasks for the service currently in the Running state. + type: "integer" + format: "uint64" + example: 7 + DesiredTasks: + description: | + The number of tasks for the service desired to be running. + For replicated services, this is the replica count from the + service spec. For global services, this is computed by taking + count of all tasks for the service with a Desired State other + than Shutdown. + type: "integer" + format: "uint64" + example: 10 + CompletedTasks: + description: | + The number of tasks for a job that are in the Completed state. + This field must be cross-referenced with the service type, as the + value of 0 may mean the service is not in a job mode, or it may + mean the job-mode service has no tasks yet Completed. + type: "integer" + format: "uint64" + JobStatus: + description: | + The status of the service when it is in one of ReplicatedJob or + GlobalJob modes. Absent on Replicated and Global mode services. The + JobIteration is an ObjectVersion, but unlike the Service's version, + does not need to be sent with an update request. + type: "object" + properties: + JobIteration: + description: | + JobIteration is a value increased each time a Job is executed, + successfully or otherwise. "Executed", in this case, means the + job as a whole has been started, not that an individual Task has + been launched. A job is "Executed" when its ServiceSpec is + updated. JobIteration can be used to disambiguate Tasks belonging + to different executions of a job. Though JobIteration will + increase with each subsequent execution, it may not necessarily + increase by 1, and so JobIteration should not be used to + $ref: "#/definitions/ObjectVersion" + LastExecution: + description: | + The last time, as observed by the server, that this job was + started. + type: "string" + format: "dateTime" + example: + ID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Version: + Index: 19 + CreatedAt: "2016-06-07T21:05:51.880065305Z" + UpdatedAt: "2016-06-07T21:07:29.962229872Z" + Spec: + Name: "hopeful_cori" + TaskTemplate: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ForceUpdate: 0 + Mode: + Replicated: + Replicas: 1 + UpdateConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + RollbackConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + EndpointSpec: + Mode: "vip" + Ports: + - + Protocol: "tcp" + TargetPort: 6379 + PublishedPort: 30001 + Endpoint: + Spec: + Mode: "vip" + Ports: + - + Protocol: "tcp" + TargetPort: 6379 + PublishedPort: 30001 + Ports: + - + Protocol: "tcp" + TargetPort: 6379 + PublishedPort: 30001 + VirtualIPs: + - + NetworkID: "4qvuz4ko70xaltuqbt8956gd1" + Addr: "10.255.0.2/16" + - + NetworkID: "4qvuz4ko70xaltuqbt8956gd1" + Addr: "10.255.0.3/16" + + ImageDeleteResponseItem: + type: "object" + x-go-name: "DeleteResponse" + properties: + Untagged: + description: "The image ID of an image that was untagged" + type: "string" + Deleted: + description: "The image ID of an image that was deleted" + type: "string" + + ServiceCreateResponse: + type: "object" + description: | + contains the information returned to a client on the + creation of a new service. + properties: + ID: + description: "The ID of the created service." + type: "string" + x-nullable: false + example: "ak7w3gjqoa3kuz8xcpnyy0pvl" + Warnings: + description: | + Optional warning message. + + FIXME(thaJeztah): this should have "omitempty" in the generated type. + type: "array" + x-nullable: true + items: + type: "string" + example: + - "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" + + ServiceUpdateResponse: + type: "object" + properties: + Warnings: + description: "Optional warning messages" + type: "array" + items: + type: "string" + example: + Warnings: + - "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" + + ContainerSummary: + 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: "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" + 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/MountPoint" + + Driver: + description: "Driver represents a driver (network, logging, secrets)." + type: "object" + required: [Name] + properties: + Name: + description: "Name of the driver." + type: "string" + x-nullable: false + example: "some-driver" + Options: + description: "Key/value map of driver-specific options." + type: "object" + x-nullable: false + additionalProperties: + type: "string" + example: + OptionA: "value for driver-specific option A" + OptionB: "value for driver-specific option B" + + SecretSpec: + type: "object" + properties: + Name: + description: "User-defined name of the secret." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Data: + description: | + Data is the data to store as a secret, formatted as a Base64-url-safe-encoded + ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. + It must be empty if the Driver field is set, in which case the data is + loaded from an external secret store. The maximum allowed size is 500KB, + as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). + + This field is only used to _create_ a secret, and is not returned by + other endpoints. + type: "string" + example: "" + Driver: + description: | + Name of the secrets driver used to fetch the secret's value from an + external secret store. + $ref: "#/definitions/Driver" + Templating: + description: | + Templating driver, if applicable + + Templating controls whether and how to evaluate the config payload as + a template. If no driver is set, no templating is used. + $ref: "#/definitions/Driver" + + Secret: + type: "object" + properties: + ID: + type: "string" + example: "blt1owaxmitz71s9v5zh81zun" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + example: "2017-07-20T13:55:28.678958722Z" + UpdatedAt: + type: "string" + format: "dateTime" + example: "2017-07-20T13:55:28.678958722Z" + Spec: + $ref: "#/definitions/SecretSpec" + + ConfigSpec: + type: "object" + properties: + Name: + description: "User-defined name of the config." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + Data: + description: | + Data is the data to store as a config, formatted as a Base64-url-safe-encoded + ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. + The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + type: "string" + Templating: + description: | + Templating driver, if applicable + + Templating controls whether and how to evaluate the config payload as + a template. If no driver is set, no templating is used. + $ref: "#/definitions/Driver" + + Config: + type: "object" + properties: + ID: + type: "string" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Spec: + $ref: "#/definitions/ConfigSpec" + + ContainerState: + description: | + ContainerState stores container's running state. It's part of ContainerJSONBase + and will be returned by the "inspect" command. + type: "object" +# x-nullable: true + properties: + Status: + description: | + String representation of the container state. Can be one of "created", + "running", "paused", "restarting", "removing", "exited", or "dead". + type: "string" + enum: ["created", "running", "paused", "restarting", "removing", "exited", "dead"] + example: "running" + Running: + description: | + Whether this container is running. + + Note that a running container can be _paused_. The `Running` and `Paused` + booleans are not mutually exclusive: + + When pausing a container (on Linux), the freezer cgroup is used to suspend + all processes in the container. Freezing the process requires the process to + be running. As a result, paused containers are both `Running` _and_ `Paused`. + + Use the `Status` field instead to determine if a container's state is "running". + type: "boolean" + example: true + Paused: + description: "Whether this container is paused." + type: "boolean" + example: false + Restarting: + description: "Whether this container is restarting." + type: "boolean" + example: false + OOMKilled: + description: | + Whether a process within this container has been killed because it ran + out of memory since the container was last started. + type: "boolean" + example: false + Dead: + type: "boolean" + example: false + Pid: + description: "The process ID of this container" + type: "integer" + example: 1234 + ExitCode: + description: "The last exit code of this container" + type: "integer" + example: 0 + Error: + type: "string" + StartedAt: + description: "The time when this container was last started." + type: "string" + example: "2020-01-06T09:06:59.461876391Z" + FinishedAt: + description: "The time when this container last exited." + type: "string" + example: "2020-01-06T09:07:59.461876391Z" + Health: + x-nullable: true + $ref: "#/definitions/Health" + + ContainerCreateResponse: + description: "OK response to ContainerCreate operation" + type: "object" + title: "ContainerCreateResponse" + x-go-name: "CreateResponse" + required: [Id] +# required: [Id, Warnings] + properties: + Id: + description: "The ID of the created container" + type: "string" + x-nullable: false + example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743" + Warnings: + description: "Warnings encountered when creating the container" + type: "array" + x-nullable: true + items: + type: "string" + example: [] + + ContainerWaitResponse: + description: "OK response to ContainerWait operation" + type: "object" + x-go-name: "WaitResponse" + title: "ContainerWaitResponse" + required: [StatusCode] +# required: [StatusCode, Error] + properties: + StatusCode: + description: "Exit code of the container" + type: "integer" + format: "int64" + x-nullable: false + Error: + $ref: "#/definitions/ContainerWaitExitError" + + ContainerWaitExitError: + description: "container waiting error, if any" + type: "object" + x-go-name: "WaitExitError" + properties: + Message: + description: "Details of an error" + type: "string" + + SystemVersion: + type: "object" + description: | + Response of Engine API: GET "/version" + properties: + Platform: + type: "object" + required: [Name] + properties: + Name: + type: "string" + Components: + type: "array" + description: | + Information about system components + items: + type: "object" + x-go-name: ComponentVersion + required: [Name, Version] + properties: + Name: + description: | + Name of the component + type: "string" + example: "Engine" + Version: + description: | + Version of the component + type: "string" + x-nullable: false + example: "19.03.12" + Details: + description: | + Key/value pairs of strings with additional information about the + component. These values are intended for informational purposes + only, and their content is not defined, and not part of the API + specification. + + These messages can be printed by the client as information to the user. + type: "object" + x-nullable: true + Version: + description: "The version of the daemon" + type: "string" + example: "19.03.12" + ApiVersion: + description: | + The default (and highest) API version that is supported by the daemon + type: "string" + example: "1.40" + MinAPIVersion: + description: | + The minimum API version that is supported by the daemon + type: "string" + example: "1.12" + GitCommit: + description: | + The Git commit of the source code that was used to build the daemon + type: "string" + example: "48a66213fe" + GoVersion: + description: | + The version Go used to compile the daemon, and the version of the Go + runtime in use. + type: "string" + example: "go1.13.14" + Os: + description: | + The operating system that the daemon is running on ("linux" or "windows") + type: "string" + example: "linux" + Arch: + description: | + The architecture that the daemon is running on + type: "string" + example: "amd64" + KernelVersion: + description: | + The kernel version (`uname -r`) that the daemon is running on. + + This field is omitted when empty. + type: "string" + example: "4.19.76-linuxkit" + Experimental: + description: | + Indicates if the daemon is started with experimental features enabled. + + This field is omitted when empty / false. + type: "boolean" + example: true + BuildTime: + description: | + The date and time that the daemon was compiled. + type: "string" + example: "2020-06-22T15:49:27.000000000+00:00" + + SystemInfo: + type: "object" + properties: + ID: + description: | + Unique identifier of the daemon. + +


+ + > **Note**: The format of the ID itself is not part of the API, and + > should not be considered stable. + type: "string" + example: "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS" + Containers: + description: "Total number of containers on the host." + type: "integer" + example: 14 + ContainersRunning: + description: | + Number of containers with status `"running"`. + type: "integer" + example: 3 + ContainersPaused: + description: | + Number of containers with status `"paused"`. + type: "integer" + example: 1 + ContainersStopped: + description: | + Number of containers with status `"stopped"`. + type: "integer" + example: 10 + Images: + description: | + Total number of images on the host. + + Both _tagged_ and _untagged_ (dangling) images are counted. + type: "integer" + example: 508 + Driver: + description: "Name of the storage driver in use." + type: "string" + example: "overlay2" + DriverStatus: + description: | + Information specific to the storage driver, provided as + "label" / "value" pairs. + + This information is provided by the storage driver, and formatted + in a way consistent with the output of `docker info` on the command + line. + +


+ + > **Note**: The information returned in this field, including the + > formatting of values and labels, should not be considered stable, + > and may change without notice. + type: "array" + items: + type: "array" + items: + type: "string" + example: + - ["Backing Filesystem", "extfs"] + - ["Supports d_type", "true"] + - ["Native Overlay Diff", "true"] + DockerRootDir: + description: | + Root directory of persistent Docker state. + + Defaults to `/var/lib/docker` on Linux, and `C:\ProgramData\docker` + on Windows. + type: "string" + example: "/var/lib/docker" + Plugins: + $ref: "#/definitions/PluginsInfo" + MemoryLimit: + description: "Indicates if the host has memory limit support enabled." + type: "boolean" + example: true + SwapLimit: + description: "Indicates if the host has memory swap limit support enabled." + type: "boolean" + example: true + KernelMemoryTCP: + description: | + Indicates if the host has kernel memory TCP limit support enabled. This + field is omitted if not supported. + + Kernel memory TCP limits are not supported when using cgroups v2, which + does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. + type: "boolean" + example: true + CpuCfsPeriod: + description: | + Indicates if CPU CFS(Completely Fair Scheduler) period is supported by + the host. + type: "boolean" + example: true + CpuCfsQuota: + description: | + Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by + the host. + type: "boolean" + example: true + CPUShares: + description: | + Indicates if CPU Shares limiting is supported by the host. + type: "boolean" + example: true + CPUSet: + description: | + Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. + + See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) + type: "boolean" + example: true + PidsLimit: + description: "Indicates if the host kernel has PID limit support enabled." + type: "boolean" + example: true + OomKillDisable: + description: "Indicates if OOM killer disable is supported on the host." + type: "boolean" + IPv4Forwarding: + description: "Indicates IPv4 forwarding is enabled." + type: "boolean" + example: true + BridgeNfIptables: + description: "Indicates if `bridge-nf-call-iptables` is available on the host." + type: "boolean" + example: true + BridgeNfIp6tables: + description: "Indicates if `bridge-nf-call-ip6tables` is available on the host." + type: "boolean" + example: true + Debug: + description: | + Indicates if the daemon is running in debug-mode / with debug-level + logging enabled. + type: "boolean" + example: true + NFd: + description: | + The total number of file Descriptors in use by the daemon process. + + This information is only returned if debug-mode is enabled. + type: "integer" + example: 64 + NGoroutines: + description: | + The number of goroutines that currently exist. + + This information is only returned if debug-mode is enabled. + type: "integer" + example: 174 + SystemTime: + description: | + Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) + format with nano-seconds. + type: "string" + example: "2017-08-08T20:28:29.06202363Z" + LoggingDriver: + description: | + The logging driver to use as a default for new containers. + type: "string" + CgroupDriver: + description: | + The driver to use for managing cgroups. + type: "string" + enum: ["cgroupfs", "systemd", "none"] + default: "cgroupfs" + example: "cgroupfs" + CgroupVersion: + description: | + The version of the cgroup. + type: "string" + enum: ["1", "2"] + x-enum-varnames: ["V1", "V2"] + default: "1" + example: "1" + NEventsListener: + description: "Number of event listeners subscribed." + type: "integer" + example: 30 + KernelVersion: + description: | + Kernel version of the host. + + On Linux, this information obtained from `uname`. On Windows this + information is queried from the HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ + registry value, for example _"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_. + type: "string" + example: "4.9.38-moby" + OperatingSystem: + description: | + Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS" + or "Windows Server 2016 Datacenter" + type: "string" + example: "Alpine Linux v3.5" + OSVersion: + description: | + Version of the host's operating system + +


+ + > **Note**: The information returned in this field, including its + > very existence, and the formatting of values, should not be considered + > stable, and may change without notice. + type: "string" + example: "16.04" + OSType: + description: | + Generic type of the operating system of the host, as returned by the + Go runtime (`GOOS`). + + Currently returned values are "linux" and "windows". A full list of + possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + type: "string" + example: "linux" + Architecture: + description: | + Hardware architecture of the host, as returned by the Go runtime + (`GOARCH`). + + A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + type: "string" + example: "x86_64" + NCPU: + description: | + The number of logical CPUs usable by the daemon. + + The number of available CPUs is checked by querying the operating + system when the daemon starts. Changes to operating system CPU + allocation after the daemon is started are not reflected. + type: "integer" + example: 4 + MemTotal: + description: | + Total amount of physical memory available on the host, in bytes. + type: "integer" + format: "int64" + example: 2095882240 + + IndexServerAddress: + description: | + Address / URL of the index server that is used for image search, + and as a default for user authentication for Docker Hub and Docker Cloud. + default: "https://index.docker.io/v1/" + type: "string" + example: "https://index.docker.io/v1/" + RegistryConfig: + $ref: "#/definitions/RegistryServiceConfig" + GenericResources: + $ref: "#/definitions/GenericResources" + HttpProxy: + description: | + HTTP-proxy configured for the daemon. This value is obtained from the + [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. + Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL + are masked in the API response. + + Containers do not automatically inherit this configuration. + type: "string" + example: "http://xxxxx:xxxxx@proxy.corp.example.com:8080" + HttpsProxy: + description: | + HTTPS-proxy configured for the daemon. This value is obtained from the + [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. + Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL + are masked in the API response. + + Containers do not automatically inherit this configuration. + type: "string" + example: "https://xxxxx:xxxxx@proxy.corp.example.com:4443" + NoProxy: + description: | + Comma-separated list of domain extensions for which no proxy should be + used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) + environment variable. + + Containers do not automatically inherit this configuration. + type: "string" + example: "*.local, 169.254/16" + Name: + description: "Hostname of the host." + type: "string" + example: "node5.corp.example.com" + Labels: + description: | + 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. + type: "array" + items: + type: "string" + example: ["storage=ssd", "production"] + ExperimentalBuild: + description: | + Indicates if experimental features are enabled on the daemon. + type: "boolean" + example: true + ServerVersion: + description: | + Version string of the daemon. + type: "string" + example: "24.0.2" + Runtimes: + description: | + 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. + type: "object" + additionalProperties: + $ref: "#/definitions/Runtime" + default: + runc: + path: "runc" + example: + runc: + path: "runc" + runc-master: + path: "/go/bin/runc" + custom: + path: "/usr/local/bin/my-oci-runtime" + runtimeArgs: ["--debug", "--systemd-cgroup=false"] + DefaultRuntime: + description: | + Name of the default OCI runtime that is used when starting containers. + + The default can be overridden per-container at create time. + type: "string" + default: "runc" + example: "runc" + Swarm: + $ref: "#/definitions/SwarmInfo" + LiveRestoreEnabled: + description: | + Indicates if live restore is enabled. + + If enabled, containers are kept running when the daemon is shutdown + or upon daemon start if running containers are detected. + type: "boolean" + default: false + example: false + Isolation: + description: | + Represents the isolation technology to use as a default for containers. + The supported values are platform-specific. + + If no isolation value is specified on daemon start, on Windows client, + the default is `hyperv`, and on Windows server, the default is `process`. + + This option is currently not used on other platforms. + default: "default" + type: "string" + enum: + - "default" + - "hyperv" + - "process" + - "" + InitBinary: + description: | + Name and, optional, path of the `docker-init` binary. + + If the path is omitted, the daemon searches the host's `$PATH` for the + binary and uses the first result. + type: "string" + example: "docker-init" + ContainerdCommit: + $ref: "#/definitions/Commit" + RuncCommit: + $ref: "#/definitions/Commit" + InitCommit: + $ref: "#/definitions/Commit" + SecurityOptions: + description: | + List of security features that are enabled on the daemon, such as + apparmor, seccomp, SELinux, user-namespaces (userns), rootless and + no-new-privileges. + + Additional configuration options for each security feature may + be present, and are included as a comma-separated list of key/value + pairs. + type: "array" + items: + type: "string" + example: + - "name=apparmor" + - "name=seccomp,profile=default" + - "name=selinux" + - "name=userns" + - "name=rootless" + ProductLicense: + description: | + Reports a summary of the product license on the daemon. + + If a commercial license has been applied to the daemon, information + such as number of nodes, and expiration are included. + type: "string" + example: "Community Engine" + DefaultAddressPools: + description: | + List of custom default address pools for local networks, which can be + specified in the daemon.json file or dockerd option. + + Example: a Base "10.10.0.0/16" with Size 24 will define the set of 256 + 10.10.[0-255].0/24 address pools. + type: "array" + items: + type: "object" + properties: + Base: + description: "The network address in CIDR format" + type: "string" + example: "10.10.0.0/16" + Size: + description: "The network pool size" + type: "integer" + example: "24" + Warnings: + description: | + List of warnings / informational messages about missing features, or + issues related to the daemon configuration. + + These messages can be printed by the client as information to the user. + type: "array" + items: + type: "string" + example: + - "WARNING: No memory limit support" + CDISpecDirs: + description: | + List of directories where (Container Device Interface) CDI + specifications are located. + + These specifications define vendor-specific modifications to an OCI + runtime specification for a container being created. + + An empty list indicates that CDI device injection is disabled. + + Note that since using CDI device injection requires the daemon to have + experimental enabled. For non-experimental daemons an empty list will + always be returned. + type: "array" + items: + type: "string" + example: + - "/etc/cdi" + - "/var/run/cdi" + + # PluginsInfo is a temp struct holding Plugins name + # registered with docker daemon. It is used by Info struct + PluginsInfo: + description: | + Available plugins per type. + +


+ + > **Note**: Only unmanaged (V1) plugins are included in this list. + > V1 plugins are "lazily" loaded, and are not returned in this list + > if there is no resource using the plugin. + type: "object" + properties: + Volume: + description: "Names of available volume-drivers, and network-driver plugins." + type: "array" + items: + type: "string" + example: ["local"] + Network: + description: "Names of available network-drivers, and network-driver plugins." + type: "array" + items: + type: "string" + example: ["bridge", "host", "ipvlan", "macvlan", "null", "overlay"] + Authorization: + description: "Names of available authorization plugins." + type: "array" + items: + type: "string" + example: ["img-authz-plugin", "hbm"] + Log: + description: "Names of available logging-drivers, and logging-driver plugins." + type: "array" + items: + type: "string" + example: ["awslogs", "fluentd", "gcplogs", "gelf", "journald", "json-file", "splunk", "syslog"] + + + RegistryServiceConfig: + description: | + RegistryServiceConfig stores daemon registry services configuration. + type: "object" + x-nullable: true + properties: + AllowNondistributableArtifactsCIDRs: + description: | + List of IP ranges to which nondistributable artifacts can be pushed, + using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). + +


+ + > **Deprecated**: Pushing nondistributable artifacts is now always enabled + > and this field is always `null`. + type: "array" + items: + type: "string" + example: [] + AllowNondistributableArtifactsHostnames: + description: | + List of registry hostnames to which nondistributable artifacts can be + pushed, using the format `[:]` or `[:]`. + +


+ + > **Deprecated**: Pushing nondistributable artifacts is now always enabled + > and this field is always `null`. + type: "array" + items: + type: "string" + example: [] + InsecureRegistryCIDRs: + description: | + List of IP ranges of insecure registries, using the CIDR syntax + ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries + accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates + from unknown CAs) communication. + + By default, local registries (`127.0.0.0/8`) are configured as + insecure. All other registries are secure. Communicating with an + insecure registry is not possible if the daemon assumes that registry + is secure. + + This configuration override this behavior, insecure communication with + registries whose resolved IP address is within the subnet described by + the CIDR syntax. + + Registries can also be marked insecure by hostname. Those registries + are listed under `IndexConfigs` and have their `Secure` field set to + `false`. + + > **Warning**: Using this option can be useful when running a local + > registry, but introduces security vulnerabilities. This option + > should therefore ONLY be used for testing purposes. For increased + > security, users should add their CA to their system's list of trusted + > CAs instead of enabling this option. + type: "array" + items: + type: "string" + example: ["::1/128", "127.0.0.0/8"] + IndexConfigs: + type: "object" + additionalProperties: + $ref: "#/definitions/IndexInfo" + example: + "127.0.0.1:5000": + "Name": "127.0.0.1:5000" + "Mirrors": [] + "Secure": false + "Official": false + "[2001:db8:a0b:12f0::1]:80": + "Name": "[2001:db8:a0b:12f0::1]:80" + "Mirrors": [] + "Secure": false + "Official": false + "docker.io": + Name: "docker.io" + Mirrors: ["https://hub-mirror.corp.example.com:5000/"] + Secure: true + Official: true + "registry.internal.corp.example.com:3000": + Name: "registry.internal.corp.example.com:3000" + Mirrors: [] + Secure: false + Official: false + Mirrors: + description: | + List of registry URLs that act as a mirror for the official + (`docker.io`) registry. + + type: "array" + items: + type: "string" + example: + - "https://hub-mirror.corp.example.com:5000/" + - "https://[2001:db8:a0b:12f0::1]/" + + IndexInfo: + description: + IndexInfo contains information about a registry. + type: "object" + x-nullable: true + properties: + Name: + description: | + Name of the registry, such as "docker.io". + type: "string" + example: "docker.io" + Mirrors: + description: | + List of mirrors, expressed as URIs. + type: "array" + items: + type: "string" + example: + - "https://hub-mirror.corp.example.com:5000/" + - "https://registry-2.docker.io/" + - "https://registry-3.docker.io/" + Secure: + description: | + Indicates if the registry is part of the list of insecure + registries. + + If `false`, the registry is insecure. Insecure registries accept + un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from + unknown CAs) communication. + + > **Warning**: Insecure registries can be useful when running a local + > registry. However, because its use creates security vulnerabilities + > it should ONLY be enabled for testing purposes. For increased + > security, users should add their CA to their system's list of + > trusted CAs instead of enabling this option. + type: "boolean" + example: true + Official: + description: | + Indicates whether this is an official registry (i.e., Docker Hub / docker.io) + type: "boolean" + example: true + + Runtime: + description: | + Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) + runtime. + + The runtime is invoked by the daemon via the `containerd` daemon. OCI + runtimes act as an interface to the Linux kernel namespaces, cgroups, + and SELinux. + type: "object" + properties: + path: + description: | + Name and, optional, path, of the OCI executable binary. + + If the path is omitted, the daemon searches the host's `$PATH` for the + binary and uses the first result. + type: "string" + example: "/usr/local/bin/my-oci-runtime" + runtimeArgs: + description: | + List of command-line arguments to pass to the runtime when invoked. + type: "array" + x-nullable: true + items: + type: "string" + example: ["--debug", "--systemd-cgroup=false"] + status: + description: | + Information specific to the runtime. + + While this API specification does not define data provided by runtimes, + the following well-known properties may be provided by runtimes: + + `org.opencontainers.runtime-spec.features`: features structure as defined + in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), + in a JSON string representation. + +


+ + > **Note**: The information returned in this field, including the + > formatting of values and labels, should not be considered stable, + > and may change without notice. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",\"ociVersionMax\":\"1.1.0\",\"...\":\"...\"}" + + Commit: + description: | + Commit holds the Git-commit (SHA1) that a binary was built from, as + reported in the version-string of external tools, such as `containerd`, + or `runC`. + type: "object" + properties: + ID: + description: "Actual commit ID of external tool." + type: "string" + example: "cfb82a876ecc11b5ca0977d1733adbe58599088a" + Expected: + description: | + Commit ID of external tool expected by dockerd as set at build time. + type: "string" + example: "2d41c047c83e09a6d61d464906feb2a2f3c52aa4" + + SwarmInfo: + description: | + Represents generic information about swarm. + type: "object" + properties: + NodeID: + description: "Unique identifier of for this node in the swarm." + type: "string" + default: "" + example: "k67qz4598weg5unwwffg6z1m1" + NodeAddr: + description: | + IP address at which this node can be reached by other nodes in the + swarm. + type: "string" + default: "" + example: "10.0.0.46" + LocalNodeState: + $ref: "#/definitions/LocalNodeState" + ControlAvailable: + type: "boolean" + default: false + example: true + Error: + type: "string" + default: "" + RemoteManagers: + description: | + List of ID's and addresses of other managers in the swarm. + type: "array" + default: null + x-nullable: true + items: + $ref: "#/definitions/PeerNode" + example: + - NodeID: "71izy0goik036k48jg985xnds" + Addr: "10.0.0.158:2377" + - NodeID: "79y6h1o4gv8n120drcprv5nmc" + Addr: "10.0.0.159:2377" + - NodeID: "k67qz4598weg5unwwffg6z1m1" + Addr: "10.0.0.46:2377" + Nodes: + description: "Total number of nodes in the swarm." + type: "integer" + x-nullable: true + example: 4 + Managers: + description: "Total number of managers in the swarm." + type: "integer" + x-nullable: true + example: 3 + Cluster: + $ref: "#/definitions/ClusterInfo" + + LocalNodeState: + description: "Current local status of this node." + type: "string" + default: "" + enum: + - "" + - "inactive" + - "pending" + - "active" + - "error" + - "locked" + example: "active" + + PeerNode: + description: "Represents a peer-node in the swarm" + type: "object" + properties: + NodeID: + description: "Unique identifier of for this node in the swarm." + type: "string" + Addr: + description: | + IP address and ports at which this node can be reached. + type: "string" + + NetworkAttachmentConfig: + description: | + Specifies how a service should be attached to a particular network. + type: "object" + properties: + Target: + description: | + The target network for attachment. Must be a network name or ID. + type: "string" + Aliases: + description: | + Discoverable alternate names for the service on this network. + type: "array" + items: + type: "string" + DriverOpts: + description: | + Driver attachment options for the network target. + type: "object" + 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" + + ClusterVolume: + type: "object" + description: | + Options and information specific to, and only present on, Swarm CSI + cluster volumes. + properties: + ID: + type: "string" + description: | + The Swarm ID of this volume. Because cluster volumes are Swarm + objects, they have an ID, unlike non-cluster volumes. This ID can + be used to refer to the Volume instead of the name. + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Spec: + $ref: "#/definitions/ClusterVolumeSpec" + Info: + type: "object" + description: | + Information about the global status of the volume. + properties: + CapacityBytes: + type: "integer" + format: "int64" + description: | + The capacity of the volume in bytes. A value of 0 indicates that + the capacity is unknown. + VolumeContext: + type: "object" + description: | + A map of strings to strings returned from the storage plugin when + the volume is created. + additionalProperties: + type: "string" + VolumeID: + type: "string" + description: | + The ID of the volume as returned by the CSI storage plugin. This + is distinct from the volume's ID as provided by Docker. This ID + is never used by the user when communicating with Docker to refer + to this volume. If the ID is blank, then the Volume has not been + successfully created in the plugin yet. + AccessibleTopology: + type: "array" + description: | + The topology this volume is actually accessible from. + items: + $ref: "#/definitions/Topology" + PublishStatus: + type: "array" + description: | + The status of the volume as it pertains to its publishing and use on + specific nodes + items: + type: "object" + properties: + NodeID: + type: "string" + description: | + The ID of the Swarm node the volume is published on. + State: + type: "string" + description: | + The published state of the volume. + * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. + * `published` The volume is published successfully to the node. + * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. + * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + enum: + - "pending-publish" + - "published" + - "pending-node-unpublish" + - "pending-controller-unpublish" + PublishContext: + type: "object" + description: | + A map of strings to strings returned by the CSI controller + plugin when a volume is published. + additionalProperties: + type: "string" + + ClusterVolumeSpec: + type: "object" + description: | + Cluster-specific options used to create the volume. + properties: + Group: + type: "string" + description: | + Group defines the volume group of this volume. Volumes belonging to + the same group can be referred to by group name when creating + Services. Referring to a volume by group instructs Swarm to treat + volumes in that group interchangeably for the purpose of scheduling. + Volumes with an empty string for a group technically all belong to + the same, emptystring group. + AccessMode: + type: "object" + description: | + Defines how the volume is used by tasks. + properties: + Scope: + type: "string" + description: | + The set of nodes this volume can be used on at one time. + - `single` The volume may only be scheduled to one node at a time. + - `multi` the volume may be scheduled to any supported number of nodes at a time. + default: "single" + enum: ["single", "multi"] + x-nullable: false + Sharing: + type: "string" + description: | + The number and way that different tasks can use this volume + at one time. + - `none` The volume may only be used by one task at a time. + - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly + - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. + - `all` The volume may have any number of readers and writers. + default: "none" + enum: ["none", "readonly", "onewriter", "all"] + x-nullable: false + MountVolume: + type: "object" + description: | + Options for using this volume as a Mount-type volume. + + Either MountVolume or BlockVolume, but not both, must be + present. + properties: + FsType: + type: "string" + description: | + Specifies the filesystem type for the mount volume. + Optional. + MountFlags: + type: "array" + description: | + Flags to pass when mounting the volume. Optional. + items: + type: "string" + BlockVolume: + type: "object" + description: | + Options for using this volume as a Block-type volume. + Intentionally empty. + Secrets: + type: "array" + description: | + Swarm Secrets that are passed to the CSI storage plugin when + operating on this volume. + items: + type: "object" + description: | + One cluster volume secret entry. Defines a key-value pair that + is passed to the plugin. + properties: + Key: + type: "string" + description: | + Key is the name of the key of the key-value pair passed to + the plugin. + Secret: + type: "string" + description: | + Secret is the swarm Secret object from which to read data. + This can be a Secret name or ID. The Secret data is + retrieved by swarm and used as the value of the key-value + pair passed to the plugin. + AccessibilityRequirements: + type: "object" + description: | + Requirements for the accessible topology of the volume. These + fields are optional. For an in-depth description of what these + fields mean, see the CSI specification. + properties: + Requisite: + type: "array" + description: | + A list of required topologies, at least one of which the + volume must be accessible from. + items: + $ref: "#/definitions/Topology" + Preferred: + type: "array" + description: | + A list of topologies that the volume should attempt to be + provisioned in. + items: + $ref: "#/definitions/Topology" + CapacityRange: + type: "object" + description: | + The desired capacity that the volume should be created with. If + empty, the plugin will decide the capacity. + properties: + RequiredBytes: + type: "integer" + format: "int64" + description: | + The volume must be at least this big. The value of 0 + indicates an unspecified minimum + LimitBytes: + type: "integer" + format: "int64" + description: | + The volume must not be bigger than this. The value of 0 + indicates an unspecified maximum. + Availability: + type: "string" + description: | + The availability of the volume for use in tasks. + - `active` The volume is fully available for scheduling on the cluster + - `pause` No new workloads should use the volume, but existing workloads are not stopped. + - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + default: "active" + x-nullable: false + enum: + - "active" + - "pause" + - "drain" + + Topology: + description: | + A map of topological domains to topological segments. For in depth + details, see documentation for the Topology object in the CSI + specification. + type: "object" + additionalProperties: + type: "string" + +paths: + /containers/json: + get: + summary: "List containers" + description: | + Returns a list of containers. For details on the format, see the + [inspect endpoint](#operation/ContainerInspect). + + Note that it uses a different, smaller representation of a container + than inspecting a single container. For example, the list of linked + containers is not propagated . + operationId: "ContainerList" + produces: + - "application/json" + parameters: + - name: "all" + in: "query" + description: | + Return all containers. By default, only running containers are shown. + type: "boolean" + default: false + - name: "limit" + in: "query" + description: | + Return this number of most recently created containers, including + non-running ones. + type: "integer" + - name: "size" + in: "query" + description: | + Return the size of container as fields `SizeRw` and `SizeRootFs`. + type: "boolean" + default: false + - name: "filters" + in: "query" + description: | + 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 ``) + type: "string" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/ContainerSummary" + examples: + application/json: + - Id: "8dfafdbc3a40" + Names: + - "/boring_feynman" + Image: "ubuntu:latest" + ImageID: "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82" + Command: "echo 1" + Created: 1367854155 + State: "Exited" + Status: "Exit 0" + Ports: + - PrivatePort: 2222 + PublicPort: 3333 + Type: "tcp" + Labels: + com.example.vendor: "Acme" + com.example.license: "GPL" + com.example.version: "1.0" + SizeRw: 12288 + SizeRootFs: 0 + HostConfig: + NetworkMode: "default" + NetworkSettings: + Networks: + bridge: + NetworkID: "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812" + EndpointID: "2cdc4edb1ded3631c81f57966563e5c8525b81121bb3706a9a9a3ae102711f3f" + Gateway: "172.17.0.1" + IPAddress: "172.17.0.2" + IPPrefixLen: 16 + IPv6Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + MacAddress: "02:42:ac:11:00:02" + Mounts: + - Name: "fac362...80535" + Source: "/data" + Destination: "/data" + Driver: "local" + Mode: "ro,Z" + RW: false + Propagation: "" + - Id: "9cd87474be90" + Names: + - "/coolName" + Image: "ubuntu:latest" + ImageID: "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82" + Command: "echo 222222" + Created: 1367854155 + State: "Exited" + Status: "Exit 0" + Ports: [] + Labels: {} + SizeRw: 12288 + SizeRootFs: 0 + HostConfig: + NetworkMode: "default" + NetworkSettings: + Networks: + bridge: + NetworkID: "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812" + EndpointID: "88eaed7b37b38c2a3f0c4bc796494fdf51b270c2d22656412a2ca5d559a64d7a" + Gateway: "172.17.0.1" + IPAddress: "172.17.0.8" + IPPrefixLen: 16 + IPv6Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + MacAddress: "02:42:ac:11:00:08" + Mounts: [] + - Id: "3176a2479c92" + Names: + - "/sleepy_dog" + Image: "ubuntu:latest" + ImageID: "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82" + Command: "echo 3333333333333333" + Created: 1367854154 + State: "Exited" + Status: "Exit 0" + Ports: [] + Labels: {} + SizeRw: 12288 + SizeRootFs: 0 + HostConfig: + NetworkMode: "default" + NetworkSettings: + Networks: + bridge: + NetworkID: "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812" + EndpointID: "8b27c041c30326d59cd6e6f510d4f8d1d570a228466f956edf7815508f78e30d" + Gateway: "172.17.0.1" + IPAddress: "172.17.0.6" + IPPrefixLen: 16 + IPv6Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + MacAddress: "02:42:ac:11:00:06" + Mounts: [] + - Id: "4cb07b47f9fb" + Names: + - "/running_cat" + Image: "ubuntu:latest" + ImageID: "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82" + Command: "echo 444444444444444444444444444444444" + Created: 1367854152 + State: "Exited" + Status: "Exit 0" + Ports: [] + Labels: {} + SizeRw: 12288 + SizeRootFs: 0 + HostConfig: + NetworkMode: "default" + NetworkSettings: + Networks: + bridge: + NetworkID: "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812" + EndpointID: "d91c7b2f0644403d7ef3095985ea0e2370325cd2332ff3a3225c4247328e66e9" + Gateway: "172.17.0.1" + IPAddress: "172.17.0.5" + IPPrefixLen: 16 + IPv6Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + MacAddress: "02:42:ac:11:00:05" + Mounts: [] + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Container"] + /containers/create: + post: + summary: "Create a container" + operationId: "ContainerCreate" + consumes: + - "application/json" + - "application/octet-stream" + produces: + - "application/json" + parameters: + - name: "name" + in: "query" + description: | + Assign the specified name to the container. Must match + `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`. + type: "string" + pattern: "^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$" + - name: "platform" + in: "query" + description: | + Platform in the format `os[/arch[/variant]]` used for image lookup. + + When specified, the daemon checks if the requested image is present + in the local image cache with the given OS and Architecture, and + otherwise returns a `404` status. + + If the option is not set, the host's native OS and Architecture are + used to look up the image in the image cache. However, if no platform + is passed and the given image does exist in the local image cache, + but its OS or architecture does not match, the container is created + with the available image, and a warning is added to the `Warnings` + field in the response, for example; + + WARNING: The requested image's platform (linux/arm64/v8) does not + match the detected host platform (linux/amd64) and no + specific platform was requested + + type: "string" + default: "" + - name: "body" + in: "body" + description: "Container to create" + schema: + allOf: + - $ref: "#/definitions/ContainerConfig" + - type: "object" + properties: + HostConfig: + $ref: "#/definitions/HostConfig" + NetworkingConfig: + $ref: "#/definitions/NetworkingConfig" + example: + Hostname: "" + Domainname: "" + User: "" + AttachStdin: false + AttachStdout: true + AttachStderr: true + Tty: false + OpenStdin: false + StdinOnce: false + Env: + - "FOO=bar" + - "BAZ=quux" + Cmd: + - "date" + Entrypoint: "" + Image: "ubuntu" + Labels: + com.example.vendor: "Acme" + com.example.license: "GPL" + com.example.version: "1.0" + Volumes: + /volumes/data: {} + WorkingDir: "" + NetworkDisabled: false + MacAddress: "12:34:56:78:9a:bc" + ExposedPorts: + 22/tcp: {} + StopSignal: "SIGTERM" + StopTimeout: 10 + HostConfig: + Binds: + - "/tmp:/tmp" + Links: + - "redis3:redis" + Memory: 0 + MemorySwap: 0 + MemoryReservation: 0 + NanoCpus: 500000 + CpuPercent: 80 + CpuShares: 512 + CpuPeriod: 100000 + CpuRealtimePeriod: 1000000 + CpuRealtimeRuntime: 10000 + CpuQuota: 50000 + CpusetCpus: "0,1" + CpusetMems: "0,1" + MaximumIOps: 0 + MaximumIOBps: 0 + BlkioWeight: 300 + BlkioWeightDevice: + - {} + BlkioDeviceReadBps: + - {} + BlkioDeviceReadIOps: + - {} + BlkioDeviceWriteBps: + - {} + BlkioDeviceWriteIOps: + - {} + DeviceRequests: + - Driver: "nvidia" + Count: -1 + DeviceIDs": ["0", "1", "GPU-fef8089b-4820-abfc-e83e-94318197576e"] + Capabilities: [["gpu", "nvidia", "compute"]] + Options: + property1: "string" + property2: "string" + MemorySwappiness: 60 + OomKillDisable: false + OomScoreAdj: 500 + PidMode: "" + PidsLimit: 0 + PortBindings: + 22/tcp: + - HostPort: "11022" + PublishAllPorts: false + Privileged: false + ReadonlyRootfs: false + Dns: + - "8.8.8.8" + DnsOptions: + - "" + DnsSearch: + - "" + VolumesFrom: + - "parent" + - "other:ro" + CapAdd: + - "NET_ADMIN" + CapDrop: + - "MKNOD" + GroupAdd: + - "newgroup" + RestartPolicy: + Name: "" + MaximumRetryCount: 0 + AutoRemove: true + NetworkMode: "bridge" + Devices: [] + Ulimits: + - {} + LogConfig: + Type: "json-file" + Config: {} + SecurityOpt: [] + StorageOpt: {} + CgroupParent: "" + VolumeDriver: "" + ShmSize: 67108864 + NetworkingConfig: + EndpointsConfig: + isolated_nw: + IPAMConfig: + IPv4Address: "172.20.30.33" + IPv6Address: "2001:db8:abcd::3033" + LinkLocalIPs: + - "169.254.34.68" + - "fe80::3468" + Links: + - "container_1" + - "container_2" + Aliases: + - "server_x" + - "server_y" + database_nw: {} + + required: true + responses: + 201: + description: "Container created successfully" + schema: + $ref: "#/definitions/ContainerCreateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such image" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such image: c2ada9df5af8" + 409: + description: "conflict" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Container"] + /containers/{id}/json: + get: + summary: "Inspect a container" + description: "Return low-level information about a container." + operationId: "ContainerInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "object" + title: "ContainerInspectResponse" + properties: + Id: + description: "The ID of the container" + type: "string" + Created: + description: "The time the container was created" + type: "string" + Path: + description: "The path to the command being run" + type: "string" + Args: + description: "The arguments to the command being run" + type: "array" + items: + type: "string" + State: + x-nullable: true + $ref: "#/definitions/ContainerState" + Image: + description: "The container's image ID" + type: "string" + ResolvConfPath: + type: "string" + HostnamePath: + type: "string" + HostsPath: + type: "string" + LogPath: + type: "string" + Name: + type: "string" + RestartCount: + type: "integer" + Driver: + type: "string" + Platform: + type: "string" + MountLabel: + type: "string" + ProcessLabel: + type: "string" + AppArmorProfile: + type: "string" + ExecIDs: + description: "IDs of exec instances that are running in the container." + type: "array" + items: + type: "string" + x-nullable: true + HostConfig: + $ref: "#/definitions/HostConfig" + GraphDriver: + $ref: "#/definitions/GraphDriverData" + 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" + Mounts: + type: "array" + items: + $ref: "#/definitions/MountPoint" + Config: + $ref: "#/definitions/ContainerConfig" + NetworkSettings: + $ref: "#/definitions/NetworkSettings" + examples: + application/json: + AppArmorProfile: "" + Args: + - "-c" + - "exit 9" + Config: + AttachStderr: true + AttachStdin: false + AttachStdout: true + Cmd: + - "/bin/sh" + - "-c" + - "exit 9" + Domainname: "" + Env: + - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + Healthcheck: + Test: ["CMD-SHELL", "exit 0"] + Hostname: "ba033ac44011" + Image: "ubuntu" + Labels: + com.example.vendor: "Acme" + com.example.license: "GPL" + com.example.version: "1.0" + MacAddress: "" + NetworkDisabled: false + OpenStdin: false + StdinOnce: false + Tty: false + User: "" + Volumes: + /volumes/data: {} + WorkingDir: "" + StopSignal: "SIGTERM" + StopTimeout: 10 + Created: "2015-01-06T15:47:31.485331387Z" + Driver: "overlay2" + ExecIDs: + - "b35395de42bc8abd327f9dd65d913b9ba28c74d2f0734eeeae84fa1c616a0fca" + - "3fc1232e5cd20c8de182ed81178503dc6437f4e7ef12b52cc5e8de020652f1c4" + HostConfig: + MaximumIOps: 0 + MaximumIOBps: 0 + BlkioWeight: 0 + BlkioWeightDevice: + - {} + BlkioDeviceReadBps: + - {} + BlkioDeviceWriteBps: + - {} + BlkioDeviceReadIOps: + - {} + BlkioDeviceWriteIOps: + - {} + ContainerIDFile: "" + CpusetCpus: "" + CpusetMems: "" + CpuPercent: 80 + CpuShares: 0 + CpuPeriod: 100000 + CpuRealtimePeriod: 1000000 + CpuRealtimeRuntime: 10000 + Devices: [] + DeviceRequests: + - Driver: "nvidia" + Count: -1 + DeviceIDs": ["0", "1", "GPU-fef8089b-4820-abfc-e83e-94318197576e"] + Capabilities: [["gpu", "nvidia", "compute"]] + Options: + property1: "string" + property2: "string" + IpcMode: "" + Memory: 0 + MemorySwap: 0 + MemoryReservation: 0 + OomKillDisable: false + OomScoreAdj: 500 + NetworkMode: "bridge" + PidMode: "" + PortBindings: {} + Privileged: false + ReadonlyRootfs: false + PublishAllPorts: false + RestartPolicy: + MaximumRetryCount: 2 + Name: "on-failure" + LogConfig: + Type: "json-file" + Sysctls: + net.ipv4.ip_forward: "1" + Ulimits: + - {} + VolumeDriver: "" + ShmSize: 67108864 + HostnamePath: "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname" + HostsPath: "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts" + LogPath: "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log" + Id: "ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39" + Image: "04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2" + MountLabel: "" + Name: "/boring_euclid" + NetworkSettings: + Bridge: "" + SandboxID: "" + HairpinMode: false + LinkLocalIPv6Address: "" + LinkLocalIPv6PrefixLen: 0 + SandboxKey: "" + EndpointID: "" + Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + IPAddress: "" + IPPrefixLen: 0 + IPv6Gateway: "" + MacAddress: "" + Networks: + bridge: + NetworkID: "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812" + EndpointID: "7587b82f0dada3656fda26588aee72630c6fab1536d36e394b2bfbcf898c971d" + Gateway: "172.17.0.1" + IPAddress: "172.17.0.2" + IPPrefixLen: 16 + IPv6Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + MacAddress: "02:42:ac:12:00:02" + Path: "/bin/sh" + ProcessLabel: "" + ResolvConfPath: "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf" + RestartCount: 1 + State: + Error: "" + ExitCode: 9 + FinishedAt: "2015-01-06T15:47:32.080254511Z" + Health: + Status: "healthy" + FailingStreak: 0 + Log: + - Start: "2019-12-22T10:59:05.6385933Z" + End: "2019-12-22T10:59:05.8078452Z" + ExitCode: 0 + Output: "" + OOMKilled: false + Dead: false + Paused: false + Pid: 0 + Restarting: false + Running: true + StartedAt: "2015-01-06T15:47:32.072697474Z" + Status: "running" + Mounts: + - Name: "fac362...80535" + Source: "/data" + Destination: "/data" + Driver: "local" + Mode: "ro,Z" + RW: false + Propagation: "" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "size" + in: "query" + type: "boolean" + default: false + description: "Return the size of container as fields `SizeRw` and `SizeRootFs`" + tags: ["Container"] + /containers/{id}/top: + get: + summary: "List processes running inside a container" + description: | + On Unix systems, this is done by running the `ps` command. This endpoint + is not supported on Windows. + operationId: "ContainerTop" + responses: + 200: + description: "no error" + schema: + type: "object" + title: "ContainerTopResponse" + description: "OK response to ContainerTop operation" + properties: + Titles: + description: "The ps column titles" + type: "array" + items: + type: "string" + Processes: + description: | + Each process running in the container, where each is process + is an array of values corresponding to the titles. + type: "array" + items: + type: "array" + items: + type: "string" + examples: + application/json: + Titles: + - "UID" + - "PID" + - "PPID" + - "C" + - "STIME" + - "TTY" + - "TIME" + - "CMD" + Processes: + - + - "root" + - "13642" + - "882" + - "0" + - "17:03" + - "pts/0" + - "00:00:00" + - "/bin/bash" + - + - "root" + - "13735" + - "13642" + - "0" + - "17:06" + - "pts/0" + - "00:00:00" + - "sleep 10" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "ps_args" + in: "query" + description: "The arguments to pass to `ps`. For example, `aux`" + type: "string" + default: "-ef" + tags: ["Container"] + /containers/{id}/logs: + get: + summary: "Get container logs" + description: | + Get `stdout` and `stderr` logs from a container. + + Note: This endpoint works only for containers with the `json-file` or + `journald` logging driver. + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + operationId: "ContainerLogs" + responses: + 200: + description: | + logs returned as a stream in response body. + For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). + Note that unlike the attach endpoint, the logs endpoint does not + upgrade the connection and does not set Content-Type. + schema: + type: "string" + format: "binary" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "follow" + in: "query" + description: "Keep connection after returning logs." + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Return logs from `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Return logs from `stderr`" + type: "boolean" + default: false + - name: "since" + in: "query" + description: "Only return logs since this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "until" + in: "query" + description: "Only return logs before this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "timestamps" + in: "query" + description: "Add timestamps to every log line" + type: "boolean" + default: false + - name: "tail" + in: "query" + description: | + Only return this number of log lines from the end of the logs. + Specify as an integer or `all` to output all log lines. + type: "string" + default: "all" + tags: ["Container"] + /containers/{id}/changes: + get: + summary: "Get changes on a container’s filesystem" + description: | + Returns which files in a container's filesystem have been added, deleted, + or modified. The `Kind` of modification can be one of: + + - `0`: Modified ("C") + - `1`: Added ("A") + - `2`: Deleted ("D") + operationId: "ContainerChanges" + produces: ["application/json"] + responses: + 200: + description: "The list of changes" + schema: + type: "array" + items: + $ref: "#/definitions/FilesystemChange" + examples: + application/json: + - Path: "/dev" + Kind: 0 + - Path: "/dev/kmsg" + Kind: 1 + - Path: "/test" + Kind: 1 + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/export: + get: + summary: "Export a container" + description: "Export the contents of a container as a tarball." + operationId: "ContainerExport" + produces: + - "application/octet-stream" + responses: + 200: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/stats: + get: + summary: "Get container stats based on resource usage" + description: | + This endpoint returns a live stream of a container’s resource usage + statistics. + + The `precpu_stats` is the CPU statistic of the *previous* read, and is + used to calculate the CPU usage percentage. It is not an exact copy + of the `cpu_stats` field. + + If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is + nil then for compatibility with older daemons the length of the + corresponding `cpu_usage.percpu_usage` array should be used. + + On a cgroup v2 host, the following fields are not set + * `blkio_stats`: all fields other than `io_service_bytes_recursive` + * `cpu_stats`: `cpu_usage.percpu_usage` + * `memory_stats`: `max_usage` and `failcnt` + Also, `memory_stats.stats` fields are incompatible with cgroup v1. + + To calculate the values shown by the `stats` command of the docker cli tool + the following formulas can be used: + * used_memory = `memory_stats.usage - memory_stats.stats.cache` + * available_memory = `memory_stats.limit` + * Memory usage % = `(used_memory / available_memory) * 100.0` + * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage` + * system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage` + * number_cpus = `length(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus` + * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0` + operationId: "ContainerStats" + produces: ["application/json"] + responses: + 200: + description: "no error" + schema: + type: "object" + examples: + application/json: + read: "2015-01-08T22:57:31.547920715Z" + pids_stats: + current: 3 + networks: + eth0: + rx_bytes: 5338 + rx_dropped: 0 + rx_errors: 0 + rx_packets: 36 + tx_bytes: 648 + tx_dropped: 0 + tx_errors: 0 + tx_packets: 8 + eth5: + rx_bytes: 4641 + rx_dropped: 0 + rx_errors: 0 + rx_packets: 26 + tx_bytes: 690 + tx_dropped: 0 + tx_errors: 0 + tx_packets: 9 + memory_stats: + stats: + total_pgmajfault: 0 + cache: 0 + mapped_file: 0 + total_inactive_file: 0 + pgpgout: 414 + rss: 6537216 + total_mapped_file: 0 + writeback: 0 + unevictable: 0 + pgpgin: 477 + total_unevictable: 0 + pgmajfault: 0 + total_rss: 6537216 + total_rss_huge: 6291456 + total_writeback: 0 + total_inactive_anon: 0 + rss_huge: 6291456 + hierarchical_memory_limit: 67108864 + total_pgfault: 964 + total_active_file: 0 + active_anon: 6537216 + total_active_anon: 6537216 + total_pgpgout: 414 + total_cache: 0 + inactive_anon: 0 + active_file: 0 + pgfault: 964 + inactive_file: 0 + total_pgpgin: 477 + max_usage: 6651904 + usage: 6537216 + failcnt: 0 + limit: 67108864 + blkio_stats: {} + cpu_stats: + cpu_usage: + percpu_usage: + - 8646879 + - 24472255 + - 36438778 + - 30657443 + usage_in_usermode: 50000000 + total_usage: 100215355 + usage_in_kernelmode: 30000000 + system_cpu_usage: 739306590000000 + online_cpus: 4 + throttling_data: + periods: 0 + throttled_periods: 0 + throttled_time: 0 + precpu_stats: + cpu_usage: + percpu_usage: + - 8646879 + - 24350896 + - 36438778 + - 30657443 + usage_in_usermode: 50000000 + total_usage: 100093996 + usage_in_kernelmode: 30000000 + system_cpu_usage: 9492140000000 + online_cpus: 4 + throttling_data: + periods: 0 + throttled_periods: 0 + throttled_time: 0 + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "stream" + in: "query" + description: | + Stream the output. If false, the stats will be output once and then + it will disconnect. + type: "boolean" + default: true + - name: "one-shot" + in: "query" + description: | + Only get a single stat instead of waiting for 2 cycles. Must be used + with `stream=false`. + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/resize: + post: + summary: "Resize a container TTY" + description: "Resize the TTY for a container." + operationId: "ContainerResize" + consumes: + - "application/octet-stream" + produces: + - "text/plain" + responses: + 200: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "cannot resize container" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "h" + in: "query" + required: true + description: "Height of the TTY session in characters" + type: "integer" + - name: "w" + in: "query" + required: true + description: "Width of the TTY session in characters" + type: "integer" + tags: ["Container"] + /containers/{id}/start: + post: + summary: "Start a container" + operationId: "ContainerStart" + responses: + 204: + description: "no error" + 304: + description: "container already started" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "detachKeys" + in: "query" + description: | + Override the key sequence for detaching a container. Format is a + single character `[a-Z]` or `ctrl-` where `` is one + of: `a-z`, `@`, `^`, `[`, `,` or `_`. + type: "string" + tags: ["Container"] + /containers/{id}/stop: + post: + summary: "Stop a container" + operationId: "ContainerStop" + responses: + 204: + description: "no error" + 304: + description: "container already stopped" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "signal" + in: "query" + description: | + Signal to send to the container as an integer or string (e.g. `SIGINT`). + type: "string" + - name: "t" + in: "query" + description: "Number of seconds to wait before killing the container" + type: "integer" + tags: ["Container"] + /containers/{id}/restart: + post: + summary: "Restart a container" + operationId: "ContainerRestart" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "signal" + in: "query" + description: | + Signal to send to the container as an integer or string (e.g. `SIGINT`). + type: "string" + - name: "t" + in: "query" + description: "Number of seconds to wait before killing the container" + type: "integer" + tags: ["Container"] + /containers/{id}/kill: + post: + summary: "Kill a container" + description: | + Send a POSIX signal to a container, defaulting to killing to the + container. + operationId: "ContainerKill" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "container is not running" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "signal" + in: "query" + description: | + Signal to send to the container as an integer or string (e.g. `SIGINT`). + type: "string" + default: "SIGKILL" + tags: ["Container"] + /containers/{id}/update: + post: + summary: "Update a container" + description: | + Change various configuration options of a container without having to + recreate it. + operationId: "ContainerUpdate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "The container has been updated." + schema: + type: "object" + title: "ContainerUpdateResponse" + description: "OK response to ContainerUpdate operation" + properties: + Warnings: + type: "array" + items: + type: "string" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "update" + in: "body" + required: true + schema: + allOf: + - $ref: "#/definitions/Resources" + - type: "object" + properties: + RestartPolicy: + $ref: "#/definitions/RestartPolicy" + example: + BlkioWeight: 300 + CpuShares: 512 + CpuPeriod: 100000 + CpuQuota: 50000 + CpuRealtimePeriod: 1000000 + CpuRealtimeRuntime: 10000 + CpusetCpus: "0,1" + CpusetMems: "0" + Memory: 314572800 + MemorySwap: 514288000 + MemoryReservation: 209715200 + RestartPolicy: + MaximumRetryCount: 4 + Name: "on-failure" + tags: ["Container"] + /containers/{id}/rename: + post: + summary: "Rename a container" + operationId: "ContainerRename" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "name already in use" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "name" + in: "query" + required: true + description: "New name for the container" + type: "string" + tags: ["Container"] + /containers/{id}/pause: + post: + summary: "Pause a container" + description: | + Use the freezer cgroup to suspend all processes in a container. + + Traditionally, when suspending a process the `SIGSTOP` signal is used, + which is observable by the process being suspended. With the freezer + cgroup the process is unaware, and unable to capture, that it is being + suspended, and subsequently resumed. + operationId: "ContainerPause" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/unpause: + post: + summary: "Unpause a container" + description: "Resume a container which has been paused." + operationId: "ContainerUnpause" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/attach: + post: + summary: "Attach to a container" + description: | + 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 HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream + and 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`. + + operationId: "ContainerAttach" + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + responses: + 101: + description: "no error, hints proxy about hijacking" + 200: + description: "no error, no upgrade header found" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "detachKeys" + in: "query" + description: | + Override the key sequence for detaching a container.Format is a single + character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, + `@`, `^`, `[`, `,` or `_`. + type: "string" + - name: "logs" + in: "query" + description: | + Replay previous logs from the container. + + This is useful for attaching to a container that has started and you + want to output everything since the container started. + + If `stream` is also enabled, once all the previous output has been + returned, it will seamlessly transition into streaming current + output. + type: "boolean" + default: false + - name: "stream" + in: "query" + description: | + Stream attached streams from the time the request was made onwards. + type: "boolean" + default: false + - name: "stdin" + in: "query" + description: "Attach to `stdin`" + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Attach to `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Attach to `stderr`" + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/attach/ws: + get: + summary: "Attach to a container via a websocket" + operationId: "ContainerAttachWebsocket" + responses: + 101: + description: "no error, hints proxy about hijacking" + 200: + description: "no error, no upgrade header found" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "detachKeys" + in: "query" + description: | + Override the key sequence for detaching a container.Format is a single + character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, + `@`, `^`, `[`, `,`, or `_`. + type: "string" + - name: "logs" + in: "query" + description: "Return logs" + type: "boolean" + default: false + - name: "stream" + in: "query" + description: "Return stream" + type: "boolean" + default: false + - name: "stdin" + in: "query" + description: "Attach to `stdin`" + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Attach to `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Attach to `stderr`" + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/wait: + post: + summary: "Wait for a container" + description: "Block until a container stops, then returns the exit code." + operationId: "ContainerWait" + produces: ["application/json"] + responses: + 200: + description: "The container has exit." + schema: + $ref: "#/definitions/ContainerWaitResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "condition" + in: "query" + description: | + Wait until a container state reaches the given condition. + + Defaults to `not-running` if omitted or empty. + type: "string" + enum: + - "not-running" + - "next-exit" + - "removed" + default: "not-running" + tags: ["Container"] + /containers/{id}: + delete: + summary: "Remove a container" + operationId: "ContainerDelete" + responses: + 204: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "conflict" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: | + You cannot remove a running container: c2ada9df5af8. Stop the + container before attempting removal or force remove + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "v" + in: "query" + description: "Remove anonymous volumes associated with the container." + type: "boolean" + default: false + - name: "force" + in: "query" + description: "If the container is running, kill it before removing it." + type: "boolean" + default: false + - name: "link" + in: "query" + description: "Remove the specified link associated with the container." + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/archive: + head: + summary: "Get information about files in a container" + description: | + A response header `X-Docker-Container-Path-Stat` is returned, containing + a base64 - encoded JSON object with some filesystem header information + about the path. + operationId: "ContainerArchiveInfo" + responses: + 200: + description: "no error" + headers: + X-Docker-Container-Path-Stat: + type: "string" + description: | + A base64 - encoded JSON object with some filesystem header + information about the path + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Container or path does not exist" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "path" + in: "query" + required: true + description: "Resource in the container’s filesystem to archive." + type: "string" + tags: ["Container"] + get: + summary: "Get an archive of a filesystem resource in a container" + description: "Get a tar archive of a resource in the filesystem of container id." + operationId: "ContainerArchive" + produces: ["application/x-tar"] + responses: + 200: + description: "no error" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Container or path does not exist" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "path" + in: "query" + required: true + description: "Resource in the container’s filesystem to archive." + type: "string" + tags: ["Container"] + put: + summary: "Extract an archive of files or folders to a directory in a container" + description: | + Upload a tar archive to be extracted to a path in the filesystem of container id. + `path` parameter is asserted to be a directory. If it exists as a file, 400 error + will be returned with message "not a directory". + operationId: "PutContainerArchive" + consumes: ["application/x-tar", "application/octet-stream"] + responses: + 200: + description: "The content was extracted successfully" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "not a directory" + 403: + description: "Permission denied, the volume or container rootfs is marked as read-only." + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "No such container or path does not exist inside the container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "path" + in: "query" + required: true + description: "Path to a directory in the container to extract the archive’s contents into. " + type: "string" + - name: "noOverwriteDirNonDir" + in: "query" + description: | + If `1`, `true`, or `True` then it will be an error if unpacking the + given content would cause an existing directory to be replaced with + a non-directory and vice versa. + type: "string" + - name: "copyUIDGID" + in: "query" + description: | + If `1`, `true`, then it will copy UID/GID maps to the dest file or + dir + type: "string" + - name: "inputStream" + in: "body" + required: true + description: | + The input stream must be a tar archive compressed with one of the + following algorithms: `identity` (no compression), `gzip`, `bzip2`, + or `xz`. + schema: + type: "string" + format: "binary" + tags: ["Container"] + /containers/prune: + post: + summary: "Delete stopped containers" + produces: + - "application/json" + operationId: "ContainerPrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "ContainerPruneResponse" + properties: + ContainersDeleted: + description: "Container IDs that were deleted" + type: "array" + items: + type: "string" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Container"] + /images/json: + get: + summary: "List Images" + description: "Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image." + operationId: "ImageList" + produces: + - "application/json" + responses: + 200: + description: "Summary image data for the images matching the query" + schema: + type: "array" + items: + $ref: "#/definitions/ImageSummary" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "all" + in: "query" + description: "Show all images. Only images from a final layer (no children) are shown by default." + type: "boolean" + default: false + - name: "filters" + in: "query" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the images list. + + Available filters: + + - `before`=(`[:]`, `` or ``) + - `dangling=true` + - `label=key` or `label="key=value"` of an image label + - `reference`=(`[:]`) + - `since`=(`[:]`, `` or ``) + - `until=` + type: "string" + - name: "shared-size" + in: "query" + description: "Compute and show shared size as a `SharedSize` field on each image." + type: "boolean" + default: false + - name: "digests" + in: "query" + description: "Show digest information as a `RepoDigests` field on each image." + type: "boolean" + default: false + tags: ["Image"] + /build: + post: + summary: "Build an image" + 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](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. + operationId: "ImageBuild" + consumes: + - "application/octet-stream" + produces: + - "application/json" + parameters: + - name: "inputStream" + in: "body" + description: "A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz." + schema: + type: "string" + format: "binary" + - name: "dockerfile" + in: "query" + description: "Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`." + type: "string" + default: "Dockerfile" + - name: "t" + in: "query" + description: "A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters." + type: "string" + - name: "extrahosts" + in: "query" + description: "Extra hosts to add to /etc/hosts" + type: "string" + - name: "remote" + in: "query" + description: "A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball." + type: "string" + - name: "q" + in: "query" + description: "Suppress verbose build output." + type: "boolean" + default: false + - name: "nocache" + in: "query" + description: "Do not use the cache when building the image." + type: "boolean" + default: false + - name: "cachefrom" + in: "query" + description: "JSON array of images used for build cache resolution." + type: "string" + - name: "pull" + in: "query" + description: "Attempt to pull the image even if an older image exists locally." + type: "string" + - name: "rm" + in: "query" + description: "Remove intermediate containers after a successful build." + type: "boolean" + default: true + - name: "forcerm" + in: "query" + description: "Always remove intermediate containers, even upon failure." + type: "boolean" + default: false + - name: "memory" + in: "query" + description: "Set memory limit for build." + type: "integer" + - name: "memswap" + in: "query" + description: "Total memory (memory + swap). Set as `-1` to disable swap." + type: "integer" + - name: "cpushares" + in: "query" + description: "CPU shares (relative weight)." + type: "integer" + - name: "cpusetcpus" + in: "query" + description: "CPUs in which to allow execution (e.g., `0-3`, `0,1`)." + type: "string" + - name: "cpuperiod" + in: "query" + description: "The length of a CPU period in microseconds." + type: "integer" + - name: "cpuquota" + in: "query" + description: "Microseconds of CPU time that the container can get in a CPU period." + type: "integer" + - name: "buildargs" + in: "query" + description: > + 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) + type: "string" + - name: "shmsize" + in: "query" + description: "Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB." + type: "integer" + - name: "squash" + in: "query" + description: "Squash the resulting images layers into a single layer. *(Experimental release only.)*" + type: "boolean" + - name: "labels" + in: "query" + description: "Arbitrary key/value labels to set on the image, as a JSON map of string pairs." + type: "string" + - name: "networkmode" + in: "query" + description: | + Sets the networking mode for the run commands during build. Supported + standard values are: `bridge`, `host`, `none`, and `container:`. + Any other value is taken as a custom network's name or ID to which this + container should connect to. + type: "string" + - name: "Content-type" + in: "header" + type: "string" + enum: + - "application/x-tar" + default: "application/x-tar" + - name: "X-Registry-Config" + in: "header" + description: | + This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to. + + The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example: + + ``` + { + "docker.example.com": { + "username": "janedoe", + "password": "hunter2" + }, + "https://index.docker.io/v1/": { + "username": "mobydock", + "password": "conta1n3rize14" + } + } + ``` + + Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. + type: "string" + - name: "platform" + in: "query" + description: "Platform in the format os[/arch[/variant]]" + type: "string" + default: "" + - name: "target" + in: "query" + description: "Target build stage" + type: "string" + default: "" + - name: "outputs" + in: "query" + description: | + BuildKit output configuration in the format of a stringified JSON array of objects. + Each object must have two top-level properties: `Type` and `Attrs`. + The `Type` property must be set to 'moby'. + The `Attrs` property is a map of attributes for the BuildKit output configuration. + See https://docs.docker.com/build/exporters/oci-docker/ for more information. + + Example: + + ``` + [{"Type":"moby","Attrs":{"type":"image","force-compression":"true","compression":"zstd"}}] + ``` + type: "string" + default: "" + - name: "version" + in: "query" + type: "string" + default: "1" + enum: ["1", "2"] + description: | + Version of the builder backend to use. + + - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) + - `2` is [BuildKit](https://github.com/moby/buildkit) + responses: + 200: + description: "no error" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Image"] + /build/prune: + post: + summary: "Delete builder cache" + produces: + - "application/json" + operationId: "BuildPrune" + parameters: + - name: "keep-storage" + in: "query" + description: "Amount of disk space in bytes to keep for cache" + type: "integer" + format: "int64" + - name: "all" + in: "query" + type: "boolean" + description: "Remove all types of build cache" + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the list of build cache objects. + + Available filters: + + - `until=` remove cache older than ``. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time. + - `id=` + - `parent=` + - `type=` + - `description=` + - `inuse` + - `shared` + - `private` + responses: + 200: + description: "No error" + schema: + type: "object" + title: "BuildPruneResponse" + properties: + CachesDeleted: + type: "array" + items: + description: "ID of build cache object" + type: "string" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Image"] + /images/create: + post: + summary: "Create an image" + description: "Pull or import an image." + operationId: "ImageCreate" + consumes: + - "text/plain" + - "application/octet-stream" + produces: + - "application/json" + responses: + 200: + description: "no error" + 404: + description: "repository does not exist or no read access" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "fromImage" + in: "query" + description: "Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed." + type: "string" + - name: "fromSrc" + in: "query" + description: "Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image." + type: "string" + - name: "repo" + in: "query" + description: "Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image." + type: "string" + - name: "tag" + in: "query" + description: "Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled." + type: "string" + - name: "message" + in: "query" + description: "Set commit message for imported image." + type: "string" + - name: "inputImage" + in: "body" + description: "Image content if the value `-` has been specified in fromSrc query parameter" + schema: + type: "string" + required: false + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration. + + 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]]. + + When used in combination with the `fromImage` option, the daemon checks + if the given image is present in the local image cache with the given + OS and Architecture, and otherwise attempts to pull the image. If the + option is not set, the host's native OS and Architecture are used. + If the given image does not exist in the local image cache, the daemon + attempts to pull the image with the host's native OS and Architecture. + If the given image does exists in the local image cache, but its OS or + architecture does not match, a warning is produced. + + When used with the `fromSrc` option to import an image from an archive, + this option sets the platform information for the imported image. If + the option is not set, the host's native OS and Architecture are used + for the imported image. + type: "string" + default: "" + tags: ["Image"] + /images/{name}/json: + get: + summary: "Inspect an image" + description: "Return low-level information about an image." + operationId: "ImageInspect" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/ImageInspect" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such image: someimage (tag: latest)" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or id" + type: "string" + required: true + tags: ["Image"] + /images/{name}/history: + get: + summary: "Get the history of an image" + description: "Return parent layers of an image." + operationId: "ImageHistory" + produces: ["application/json"] + responses: + 200: + description: "List of image layers" + schema: + type: "array" + items: + type: "object" + x-go-name: HistoryResponseItem + title: "HistoryResponseItem" + description: "individual image layer information in response to ImageHistory operation" + required: [Id, Created, CreatedBy, Tags, Size, Comment] + properties: + Id: + type: "string" + x-nullable: false + Created: + type: "integer" + format: "int64" + x-nullable: false + CreatedBy: + type: "string" + x-nullable: false + Tags: + type: "array" + items: + type: "string" + x-nullable: true + Size: + type: "integer" + format: "int64" + x-nullable: false + Comment: + type: "string" + x-nullable: false + examples: + application/json: + - Id: "3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710" + Created: 1398108230 + CreatedBy: "/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /" + Tags: + - "ubuntu:lucid" + - "ubuntu:10.04" + Size: 182964289 + Comment: "" + - Id: "6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8" + Created: 1398108222 + CreatedBy: "/bin/sh -c #(nop) MAINTAINER Tianon Gravi - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/" + Tags: [] + Size: 0 + Comment: "" + - Id: "511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158" + Created: 1371157430 + CreatedBy: "" + Tags: + - "scratch12:latest" + - "scratch:latest" + Size: 0 + Comment: "Imported from -" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID" + type: "string" + required: true + tags: ["Image"] + /images/{name}/push: + post: + summary: "Push an image" + description: | + Push an image to a registry. + + If you wish to push an image on to a private registry, that image must + already have a tag which references the registry. For example, + `registry.example.com/myimage:latest`. + + The push is cancelled if the HTTP connection is closed. + operationId: "ImagePush" + consumes: + - "application/octet-stream" + responses: + 200: + description: "No error" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + Name of the image to push. For example, `registry.example.com/myimage`. + The image must be present in the local image store with the same name. + + The name should be provided without tag; if a tag is provided, it + is ignored. For example, `registry.example.com/myimage:latest` is + considered equivalent to `registry.example.com/myimage`. + + Use the `tag` parameter to specify the tag to push. + type: "string" + required: true + - name: "tag" + in: "query" + description: | + Tag of the image to push. For example, `latest`. If no tag is provided, + all tags of the given image that are present in the local image store + are pushed. + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + required: true + tags: ["Image"] + /images/{name}/tag: + post: + summary: "Tag an image" + description: "Tag an image so that it becomes part of a repository." + operationId: "ImageTag" + responses: + 201: + description: "No error" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Conflict" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID to tag." + type: "string" + required: true + - name: "repo" + in: "query" + description: "The repository to tag in. For example, `someuser/someimage`." + type: "string" + - name: "tag" + in: "query" + description: "The name of the new tag." + type: "string" + tags: ["Image"] + /images/{name}: + delete: + summary: "Remove an image" + description: | + Remove an image, along with any untagged parent images that were + referenced by that image. + + Images can't be removed if they have descendant images, are being + used by a running container or are being used by a build. + operationId: "ImageDelete" + produces: ["application/json"] + responses: + 200: + description: "The image was deleted successfully" + schema: + type: "array" + items: + $ref: "#/definitions/ImageDeleteResponseItem" + examples: + application/json: + - Untagged: "3e2f21a89f" + - Deleted: "3e2f21a89f" + - Deleted: "53b4f83ac9" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Conflict" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID" + type: "string" + required: true + - name: "force" + in: "query" + description: "Remove the image even if it is being used by stopped containers or has other tags" + type: "boolean" + default: false + - name: "noprune" + in: "query" + description: "Do not delete untagged parent images" + type: "boolean" + default: false + tags: ["Image"] + /images/search: + get: + summary: "Search images" + description: "Search for an image on Docker Hub." + operationId: "ImageSearch" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + type: "array" + items: + type: "object" + title: "ImageSearchResponseItem" + properties: + description: + type: "string" + is_official: + type: "boolean" + is_automated: + description: | + Whether this repository has automated builds enabled. + +


+ + > **Deprecated**: This field is deprecated and will always + > be "false" in future. + type: "boolean" + example: false + name: + type: "string" + star_count: + type: "integer" + examples: + application/json: + - description: "A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!" + is_official: true + is_automated: false + name: "alpine" + star_count: 10093 + - description: "Busybox base image." + is_official: true + is_automated: false + name: "Busybox base image." + star_count: 3037 + - description: "The PostgreSQL object-relational database system provides reliability and data integrity." + is_official: true + is_automated: false + name: "postgres" + star_count: 12408 + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "term" + in: "query" + description: "Term to search" + type: "string" + required: true + - name: "limit" + in: "query" + description: "Maximum number of results to return" + type: "integer" + - name: "filters" + in: "query" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: + + - `is-automated=(true|false)` (deprecated, see below) + - `is-official=(true|false)` + - `stars=` Matches images that has at least 'number' stars. + + The `is-automated` filter is deprecated. The `is_automated` field has + been deprecated by Docker Hub's search API. Consequently, searching + for `is-automated=true` will yield no results. + type: "string" + tags: ["Image"] + /images/prune: + post: + summary: "Delete unused images" + produces: + - "application/json" + operationId: "ImagePrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: + + - `dangling=` When set to `true` (or `1`), prune only + unused *and* untagged images. When set to `false` + (or `0`), all unused images are pruned. + - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "ImagePruneResponse" + properties: + ImagesDeleted: + description: "Images that were deleted" + type: "array" + items: + $ref: "#/definitions/ImageDeleteResponseItem" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Image"] + /auth: + post: + summary: "Check auth configuration" + description: | + Validate credentials for a registry and, if available, get an identity + token for accessing the registry without password. + operationId: "SystemAuth" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "An identity token was generated successfully." + schema: + type: "object" + title: "SystemAuthResponse" + required: [Status] + properties: + Status: + description: "The status of the authentication" + type: "string" + x-nullable: false + IdentityToken: + description: "An opaque token used to authenticate a user after a successful login" + type: "string" + x-nullable: false + examples: + application/json: + Status: "Login Succeeded" + IdentityToken: "9cbaf023786cd7..." + 204: + description: "No error" + 401: + description: "Auth error" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "authConfig" + in: "body" + description: "Authentication to check" + schema: + $ref: "#/definitions/AuthConfig" + tags: ["System"] + /info: + get: + summary: "Get system information" + operationId: "SystemInfo" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/SystemInfo" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["System"] + /version: + get: + summary: "Get version" + description: "Returns the version of Docker that is running and various information about the system that Docker is running on." + operationId: "SystemVersion" + produces: ["application/json"] + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/SystemVersion" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["System"] + /_ping: + get: + summary: "Ping" + description: "This is a dummy endpoint you can use to test if the server is accessible." + operationId: "SystemPing" + produces: ["text/plain"] + responses: + 200: + description: "no error" + schema: + type: "string" + example: "OK" + headers: + Api-Version: + type: "string" + description: "Max API Version the server supports" + Builder-Version: + type: "string" + description: | + Default version of docker image builder + + The default on Linux is version "2" (BuildKit), but the daemon + can be configured to recommend version "1" (classic Builder). + Windows does not yet support BuildKit for native Windows images, + and uses "1" (classic builder) as a default. + + This value is a recommendation as advertised by the daemon, and + it is up to the client to choose which builder to use. + default: "2" + Docker-Experimental: + type: "boolean" + description: "If the server is running with experimental mode enabled" + Swarm: + type: "string" + enum: ["inactive", "pending", "error", "locked", "active/worker", "active/manager"] + description: | + Contains information about Swarm status of the daemon, + and if the daemon is acting as a manager or worker node. + default: "inactive" + Cache-Control: + type: "string" + default: "no-cache, no-store, must-revalidate" + Pragma: + type: "string" + default: "no-cache" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + headers: + Cache-Control: + type: "string" + default: "no-cache, no-store, must-revalidate" + Pragma: + type: "string" + default: "no-cache" + tags: ["System"] + head: + summary: "Ping" + description: "This is a dummy endpoint you can use to test if the server is accessible." + operationId: "SystemPingHead" + produces: ["text/plain"] + responses: + 200: + description: "no error" + schema: + type: "string" + example: "(empty)" + headers: + Api-Version: + type: "string" + description: "Max API Version the server supports" + Builder-Version: + type: "string" + description: "Default version of docker image builder" + Docker-Experimental: + type: "boolean" + description: "If the server is running with experimental mode enabled" + Swarm: + type: "string" + enum: ["inactive", "pending", "error", "locked", "active/worker", "active/manager"] + description: | + Contains information about Swarm status of the daemon, + and if the daemon is acting as a manager or worker node. + default: "inactive" + Cache-Control: + type: "string" + default: "no-cache, no-store, must-revalidate" + Pragma: + type: "string" + default: "no-cache" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["System"] + /commit: + post: + summary: "Create a new image from a container" + operationId: "ImageCommit" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IdResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "containerConfig" + in: "body" + description: "The container configuration" + schema: + $ref: "#/definitions/ContainerConfig" + - name: "container" + in: "query" + description: "The ID or name of the container to commit" + type: "string" + - name: "repo" + in: "query" + description: "Repository name for the created image" + type: "string" + - name: "tag" + in: "query" + description: "Tag name for the create image" + type: "string" + - name: "comment" + in: "query" + description: "Commit message" + type: "string" + - name: "author" + in: "query" + description: "Author of the image (e.g., `John Hannibal Smith `)" + type: "string" + - name: "pause" + in: "query" + description: "Whether to pause the container before committing" + type: "boolean" + default: true + - name: "changes" + in: "query" + description: "`Dockerfile` instructions to apply while committing" + type: "string" + tags: ["Image"] + /events: + get: + summary: "Monitor events" + description: | + Stream real-time events from the server. + + Various objects within Docker report events when something happens to them. + + Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune` + + Images report these events: `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune` + + Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune` + + Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune` + + The Docker daemon reports these events: `reload` + + Services report these events: `create`, `update`, and `remove` + + Nodes report these events: `create`, `update`, and `remove` + + Secrets report these events: `create`, `update`, and `remove` + + Configs report these events: `create`, `update`, and `remove` + + The Builder reports `prune` events + + operationId: "SystemEvents" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/EventMessage" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "since" + in: "query" + description: "Show events created since this timestamp then stream new events." + type: "string" + - name: "until" + in: "query" + description: "Show events created until this timestamp then stop streaming." + type: "string" + - name: "filters" + in: "query" + description: | + 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 + type: "string" + tags: ["System"] + /system/df: + get: + summary: "Get data usage information" + operationId: "SystemDataUsage" + responses: + 200: + description: "no error" + schema: + type: "object" + title: "SystemDataUsageResponse" + properties: + LayersSize: + type: "integer" + format: "int64" + Images: + type: "array" + items: + $ref: "#/definitions/ImageSummary" + Containers: + type: "array" + items: + $ref: "#/definitions/ContainerSummary" + Volumes: + type: "array" + items: + $ref: "#/definitions/Volume" + BuildCache: + type: "array" + items: + $ref: "#/definitions/BuildCache" + example: + LayersSize: 1092588 + Images: + - + Id: "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749" + ParentId: "" + RepoTags: + - "busybox:latest" + RepoDigests: + - "busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6" + Created: 1466724217 + Size: 1092588 + SharedSize: 0 + Labels: {} + Containers: 1 + Containers: + - + Id: "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148" + Names: + - "/top" + Image: "busybox" + ImageID: "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749" + Command: "top" + Created: 1472592424 + Ports: [] + SizeRootFs: 1092588 + Labels: {} + State: "exited" + Status: "Exited (0) 56 minutes ago" + HostConfig: + NetworkMode: "default" + NetworkSettings: + Networks: + bridge: + IPAMConfig: null + Links: null + Aliases: null + NetworkID: "d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92" + EndpointID: "8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a" + Gateway: "172.18.0.1" + IPAddress: "172.18.0.2" + IPPrefixLen: 16 + IPv6Gateway: "" + GlobalIPv6Address: "" + GlobalIPv6PrefixLen: 0 + MacAddress: "02:42:ac:12:00:02" + Mounts: [] + Volumes: + - + Name: "my-volume" + Driver: "local" + Mountpoint: "/var/lib/docker/volumes/my-volume/_data" + Labels: null + Scope: "local" + Options: null + UsageData: + Size: 10920104 + RefCount: 2 + BuildCache: + - + ID: "hw53o5aio51xtltp5xjp8v7fx" + Parents: [] + 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" + Parents: ["ndlpt0hhvkqcdfkputsk4cq9c"] + 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: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "type" + in: "query" + description: | + Object types, for which to compute and return data. + type: "array" + collectionFormat: multi + items: + type: "string" + enum: ["container", "image", "volume", "build-cache"] + tags: ["System"] + /images/{name}/get: + get: + summary: "Export an image" + description: | + Get a tarball containing all images and metadata for a repository. + + If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced. + + ### Image tarball format + + An image tarball contains [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content). + + Additionally, includes the manifest.json file associated with a backwards compatible docker save format. + + If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs. + + ```json + { + "hello-world": { + "latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1" + } + } + ``` + operationId: "ImageGet" + produces: + - "application/x-tar" + responses: + 200: + description: "no error" + schema: + type: "string" + format: "binary" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID" + type: "string" + required: true + tags: ["Image"] + /images/get: + get: + summary: "Export several images" + description: | + Get a tarball containing all images and metadata for several image + repositories. + + For each value of the `names` parameter: if it is a specific name and + tag (e.g. `ubuntu:latest`), then only that image (and its parents) are + returned; if it is an image ID, similarly only that image (and its parents) + are returned and there would be no names referenced in the 'repositories' + file for this image ID. + + For details on the format, see the [export image endpoint](#operation/ImageGet). + operationId: "ImageGetAll" + produces: + - "application/x-tar" + responses: + 200: + description: "no error" + schema: + type: "string" + format: "binary" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "names" + in: "query" + description: "Image names to filter by" + type: "array" + items: + type: "string" + tags: ["Image"] + /images/load: + post: + summary: "Import images" + description: | + Load a set of images and tags into a repository. + + For details on the format, see the [export image endpoint](#operation/ImageGet). + operationId: "ImageLoad" + consumes: + - "application/x-tar" + produces: + - "application/json" + responses: + 200: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "imagesTarball" + in: "body" + description: "Tar archive containing images" + schema: + type: "string" + format: "binary" + - name: "quiet" + in: "query" + description: "Suppress progress details during load." + type: "boolean" + default: false + tags: ["Image"] + /containers/{id}/exec: + post: + summary: "Create an exec instance" + description: "Run a command inside a running container." + operationId: "ContainerExec" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IdResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "container is paused" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "execConfig" + in: "body" + description: "Exec configuration" + schema: + type: "object" + title: "ExecConfig" + properties: + AttachStdin: + type: "boolean" + description: "Attach to `stdin` of the exec command." + AttachStdout: + type: "boolean" + description: "Attach to `stdout` of the exec command." + AttachStderr: + type: "boolean" + description: "Attach to `stderr` of the exec command." + ConsoleSize: + type: "array" + description: "Initial console size, as an `[height, width]` array." + x-nullable: true + minItems: 2 + maxItems: 2 + items: + type: "integer" + minimum: 0 + DetachKeys: + type: "string" + description: | + Override the key sequence for detaching a container. Format is + a single character `[a-Z]` or `ctrl-` where `` + is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. + Tty: + type: "boolean" + description: "Allocate a pseudo-TTY." + Env: + description: | + A list of environment variables in the form `["VAR=value", ...]`. + type: "array" + items: + type: "string" + Cmd: + type: "array" + description: "Command to run, as a string or array of strings." + items: + type: "string" + Privileged: + type: "boolean" + description: "Runs the exec process with extended privileges." + default: false + User: + type: "string" + description: | + The user, and optionally, group to run the exec process inside + the container. Format is one of: `user`, `user:group`, `uid`, + or `uid:gid`. + WorkingDir: + type: "string" + description: | + The working directory for the exec process inside the container. + example: + AttachStdin: false + AttachStdout: true + AttachStderr: true + DetachKeys: "ctrl-p,ctrl-q" + Tty: false + Cmd: + - "date" + Env: + - "FOO=bar" + - "BAZ=quux" + required: true + - name: "id" + in: "path" + description: "ID or name of container" + type: "string" + required: true + tags: ["Exec"] + /exec/{id}/start: + post: + summary: "Start an exec instance" + description: | + Starts a previously set up exec instance. If detach is true, this endpoint + returns immediately after starting the command. Otherwise, it sets up an + interactive session with the command. + operationId: "ExecStart" + consumes: + - "application/json" + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + responses: + 200: + description: "No error" + 404: + description: "No such exec instance" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Container is stopped or paused" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "execStartConfig" + in: "body" + schema: + type: "object" + title: "ExecStartConfig" + properties: + Detach: + type: "boolean" + description: "Detach from the command." + Tty: + type: "boolean" + description: "Allocate a pseudo-TTY." + ConsoleSize: + type: "array" + description: "Initial console size, as an `[height, width]` array." + x-nullable: true + minItems: 2 + maxItems: 2 + items: + type: "integer" + minimum: 0 + example: + Detach: false + Tty: true + ConsoleSize: [80, 64] + - name: "id" + in: "path" + description: "Exec instance ID" + required: true + type: "string" + tags: ["Exec"] + /exec/{id}/resize: + post: + summary: "Resize an exec instance" + description: | + Resize the TTY session used by an exec instance. This endpoint only works + if `tty` was specified as part of creating and starting the exec instance. + operationId: "ExecResize" + responses: + 200: + description: "No error" + 201: + description: "No error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "No such exec instance" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Exec instance ID" + required: true + type: "string" + - name: "h" + in: "query" + required: true + description: "Height of the TTY session in characters" + type: "integer" + - name: "w" + in: "query" + required: true + description: "Width of the TTY session in characters" + type: "integer" + tags: ["Exec"] + /exec/{id}/json: + get: + summary: "Inspect an exec instance" + description: "Return low-level information about an exec instance." + operationId: "ExecInspect" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "ExecInspectResponse" + properties: + CanRemove: + type: "boolean" + DetachKeys: + type: "string" + ID: + type: "string" + Running: + type: "boolean" + ExitCode: + type: "integer" + ProcessConfig: + $ref: "#/definitions/ProcessConfig" + OpenStdin: + type: "boolean" + OpenStderr: + type: "boolean" + OpenStdout: + type: "boolean" + ContainerID: + type: "string" + Pid: + type: "integer" + description: "The system process ID for the exec process." + examples: + application/json: + CanRemove: false + ContainerID: "b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126" + DetachKeys: "" + ExitCode: 2 + ID: "f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b" + OpenStderr: true + OpenStdin: true + OpenStdout: true + ProcessConfig: + arguments: + - "-c" + - "exit 2" + entrypoint: "sh" + privileged: false + tty: true + user: "1000" + Running: false + Pid: 42000 + 404: + description: "No such exec instance" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Exec instance ID" + required: true + type: "string" + tags: ["Exec"] + + /volumes: + get: + summary: "List volumes" + operationId: "VolumeList" + produces: ["application/json"] + responses: + 200: + description: "Summary volume data that matches the query" + schema: + $ref: "#/definitions/VolumeListResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + description: | + JSON encoded value of the filters (a `map[string][]string`) to + process on the volumes list. Available filters: + + - `dangling=` When set to `true` (or `1`), returns all + volumes that are not in use by a container. When set to `false` + (or `0`), only volumes that are in use by one or more + containers are returned. + - `driver=` Matches volumes based on their driver. + - `label=` or `label=:` Matches volumes based on + the presence of a `label` alone or a `label` and a value. + - `name=` Matches all or part of a volume name. + type: "string" + format: "json" + tags: ["Volume"] + + /volumes/create: + post: + summary: "Create a volume" + operationId: "VolumeCreate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 201: + description: "The volume was created successfully" + schema: + $ref: "#/definitions/Volume" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "volumeConfig" + in: "body" + required: true + description: "Volume configuration" + schema: + $ref: "#/definitions/VolumeCreateOptions" + tags: ["Volume"] + + /volumes/{name}: + get: + summary: "Inspect a volume" + operationId: "VolumeInspect" + produces: ["application/json"] + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/Volume" + 404: + description: "No such volume" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + required: true + description: "Volume name or ID" + type: "string" + tags: ["Volume"] + + put: + summary: | + "Update a volume. Valid only for Swarm cluster volumes" + operationId: "VolumeUpdate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such volume" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "The name or ID of the volume" + type: "string" + required: true + - name: "body" + in: "body" + schema: + # though the schema for is an object that contains only a + # ClusterVolumeSpec, wrapping the ClusterVolumeSpec in this object + # means that if, later on, we support things like changing the + # labels, we can do so without duplicating that information to the + # ClusterVolumeSpec. + type: "object" + description: "Volume configuration" + properties: + Spec: + $ref: "#/definitions/ClusterVolumeSpec" + description: | + The spec of the volume to update. Currently, only Availability may + change. All other fields must remain unchanged. + - name: "version" + in: "query" + description: | + The version number of the volume being updated. This is required to + avoid conflicting writes. Found in the volume's `ClusterVolume` + field. + type: "integer" + format: "int64" + required: true + tags: ["Volume"] + + delete: + summary: "Remove a volume" + description: "Instruct the driver to remove the volume." + operationId: "VolumeDelete" + responses: + 204: + description: "The volume was removed" + 404: + description: "No such volume or volume driver" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Volume is in use and cannot be removed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + required: true + description: "Volume name or ID" + type: "string" + - name: "force" + in: "query" + description: "Force the removal of the volume" + type: "boolean" + default: false + tags: ["Volume"] + + /volumes/prune: + post: + summary: "Delete unused volumes" + produces: + - "application/json" + operationId: "VolumePrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. + - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "VolumePruneResponse" + properties: + VolumesDeleted: + description: "Volumes that were deleted" + type: "array" + items: + type: "string" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Volume"] + /networks: + get: + summary: "List networks" + description: | + Returns a list of networks. For details on the format, see the + [network inspect endpoint](#operation/NetworkInspect). + + Note that it uses a different, smaller representation of a network than + inspecting a single network. For example, the list of containers attached + to the network is not propagated in API versions 1.28 and up. + operationId: "NetworkList" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + type: "array" + items: + $ref: "#/definitions/Network" + examples: + application/json: + - Name: "bridge" + Id: "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566" + Created: "2016-10-19T06:21:00.416543526Z" + Scope: "local" + Driver: "bridge" + EnableIPv6: false + Internal: false + Attachable: false + Ingress: false + IPAM: + Driver: "default" + Config: + - + Subnet: "172.17.0.0/16" + Options: + com.docker.network.bridge.default_bridge: "true" + com.docker.network.bridge.enable_icc: "true" + com.docker.network.bridge.enable_ip_masquerade: "true" + com.docker.network.bridge.host_binding_ipv4: "0.0.0.0" + com.docker.network.bridge.name: "docker0" + com.docker.network.driver.mtu: "1500" + - Name: "none" + Id: "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794" + Created: "0001-01-01T00:00:00Z" + Scope: "local" + Driver: "null" + EnableIPv6: false + Internal: false + Attachable: false + Ingress: false + IPAM: + Driver: "default" + Config: [] + Containers: {} + Options: {} + - Name: "host" + Id: "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e" + Created: "0001-01-01T00:00:00Z" + Scope: "local" + Driver: "host" + EnableIPv6: false + Internal: false + Attachable: false + Ingress: false + IPAM: + Driver: "default" + Config: [] + Containers: {} + Options: {} + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + description: | + JSON encoded value of the filters (a `map[string][]string`) to process + on the networks list. + + Available filters: + + - `dangling=` When set to `true` (or `1`), returns all + networks that are not in use by a container. When set to `false` + (or `0`), only networks that are in use by one or more + containers are returned. + - `driver=` Matches a network's driver. + - `id=` Matches all or part of a network ID. + - `label=` or `label==` of a network label. + - `name=` Matches all or part of a network name. + - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`, `global`, or `local`). + - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks. + type: "string" + tags: ["Network"] + + /networks/{id}: + get: + summary: "Inspect a network" + operationId: "NetworkInspect" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/Network" + 404: + description: "Network not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + - name: "verbose" + in: "query" + description: "Detailed inspect output for troubleshooting" + type: "boolean" + default: false + - name: "scope" + in: "query" + description: "Filter the network by scope (swarm, global, or local)" + type: "string" + tags: ["Network"] + + delete: + summary: "Remove a network" + operationId: "NetworkDelete" + responses: + 204: + description: "No error" + 403: + description: "operation not supported for pre-defined networks" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such network" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + tags: ["Network"] + + /networks/create: + post: + summary: "Create a network" + operationId: "NetworkCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "No error" + schema: + type: "object" + title: "NetworkCreateResponse" + properties: + Id: + description: "The ID of the created network." + type: "string" + Warning: + type: "string" + example: + Id: "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30" + Warning: "" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 403: + description: | + Forbidden operation. This happens when trying to create a network named after a pre-defined network, + or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "plugin not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "networkConfig" + in: "body" + description: "Network configuration" + required: true + schema: + type: "object" + title: "NetworkCreateRequest" + required: ["Name"] + properties: + Name: + description: "The network's name." + type: "string" + example: "my_network" + CheckDuplicate: + description: | + Deprecated: CheckDuplicate is now always enabled. + type: "boolean" + example: true + Driver: + description: "Name of the network driver plugin to use." + type: "string" + default: "bridge" + example: "bridge" + Scope: + description: | + The level at which the network exists (e.g. `swarm` for cluster-wide + or `local` for machine level). + type: "string" + Internal: + description: "Restrict external access to the network." + type: "boolean" + Attachable: + description: | + Globally scoped network is manually attachable by regular + containers from workers in swarm mode. + type: "boolean" + example: true + Ingress: + description: | + Ingress network is the network which provides the routing-mesh + in swarm mode. + type: "boolean" + example: false + ConfigOnly: + description: | + Creates a config-only network. Config-only networks are placeholder + networks for network configurations to be used by other networks. + Config-only networks cannot be used directly to run containers + or services. + type: "boolean" + default: false + example: false + ConfigFrom: + description: | + Specifies the source which will provide the configuration for + this network. The specified network must be an existing + config-only network; see ConfigOnly. + $ref: "#/definitions/ConfigReference" + IPAM: + description: "Optional custom IP scheme for the network." + $ref: "#/definitions/IPAM" + EnableIPv6: + description: "Enable IPv6 on the network." + type: "boolean" + example: true + Options: + description: "Network specific options to be used by the drivers." + type: "object" + additionalProperties: + type: "string" + example: + com.docker.network.bridge.default_bridge: "true" + com.docker.network.bridge.enable_icc: "true" + com.docker.network.bridge.enable_ip_masquerade: "true" + com.docker.network.bridge.host_binding_ipv4: "0.0.0.0" + com.docker.network.bridge.name: "docker0" + com.docker.network.driver.mtu: "1500" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + tags: ["Network"] + + /networks/{id}/connect: + post: + summary: "Connect a container to a network" + description: "The network must be either a local-scoped network or a swarm-scoped network with the `attachable` option set. A network cannot be re-attached to a running container" + operationId: "NetworkConnect" + consumes: + - "application/json" + responses: + 200: + description: "No error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 403: + description: "Operation forbidden" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Network or container not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + - name: "container" + in: "body" + required: true + schema: + type: "object" + title: "NetworkConnectRequest" + properties: + Container: + type: "string" + description: "The ID or name of the container to connect to the network." + EndpointConfig: + $ref: "#/definitions/EndpointSettings" + example: + Container: "3613f73ba0e4" + EndpointConfig: + IPAMConfig: + IPv4Address: "172.24.56.89" + IPv6Address: "2001:db8::5689" + MacAddress: "02:42:ac:12:05:02" + tags: ["Network"] + + /networks/{id}/disconnect: + post: + summary: "Disconnect a container from a network" + operationId: "NetworkDisconnect" + consumes: + - "application/json" + responses: + 200: + description: "No error" + 403: + description: "Operation not supported for swarm scoped networks" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Network or container not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + - name: "container" + in: "body" + required: true + schema: + type: "object" + title: "NetworkDisconnectRequest" + properties: + Container: + type: "string" + description: | + The ID or name of the container to disconnect from the network. + Force: + type: "boolean" + description: | + Force the container to disconnect from the network. + tags: ["Network"] + /networks/prune: + post: + summary: "Delete unused networks" + produces: + - "application/json" + operationId: "NetworkPrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "NetworkPruneResponse" + properties: + NetworksDeleted: + description: "Networks that were deleted" + type: "array" + items: + type: "string" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Network"] + /plugins: + get: + summary: "List plugins" + operationId: "PluginList" + description: "Returns information about installed plugins." + produces: ["application/json"] + responses: + 200: + description: "No error" + schema: + type: "array" + items: + $ref: "#/definitions/Plugin" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the plugin list. + + Available filters: + + - `capability=` + - `enable=|` + tags: ["Plugin"] + + /plugins/privileges: + get: + summary: "Get plugin privileges" + operationId: "GetPluginPrivileges" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + example: + - Name: "network" + Description: "" + Value: + - "host" + - Name: "mount" + Description: "" + Value: + - "/data" + - Name: "device" + Description: "" + Value: + - "/dev/cpu_dma_latency" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "remote" + in: "query" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + tags: + - "Plugin" + + /plugins/pull: + post: + summary: "Install a plugin" + operationId: "PluginPull" + description: | + Pulls and installs a plugin. After the plugin is installed, it can be + enabled using the [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable). + produces: + - "application/json" + responses: + 204: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "remote" + in: "query" + description: | + Remote reference for plugin to install. + + The `:latest` tag is optional, and is used as the default if omitted. + required: true + type: "string" + - name: "name" + in: "query" + description: | + Local name for the pulled plugin. + + The `:latest` tag is optional, and is used as the default if omitted. + required: false + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration to use when pulling a plugin + from a registry. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + - name: "body" + in: "body" + schema: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + example: + - Name: "network" + Description: "" + Value: + - "host" + - Name: "mount" + Description: "" + Value: + - "/data" + - Name: "device" + Description: "" + Value: + - "/dev/cpu_dma_latency" + tags: ["Plugin"] + /plugins/{name}/json: + get: + summary: "Inspect a plugin" + operationId: "PluginInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Plugin" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + tags: ["Plugin"] + /plugins/{name}: + delete: + summary: "Remove a plugin" + operationId: "PluginDelete" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Plugin" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "force" + in: "query" + description: | + Disable the plugin before removing. This may result in issues if the + plugin is in use by a container. + type: "boolean" + default: false + tags: ["Plugin"] + /plugins/{name}/enable: + post: + summary: "Enable a plugin" + operationId: "PluginEnable" + responses: + 200: + description: "no error" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "timeout" + in: "query" + description: "Set the HTTP client timeout (in seconds)" + type: "integer" + default: 0 + tags: ["Plugin"] + /plugins/{name}/disable: + post: + summary: "Disable a plugin" + operationId: "PluginDisable" + responses: + 200: + description: "no error" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" + tags: ["Plugin"] + /plugins/{name}/upgrade: + post: + summary: "Upgrade a plugin" + operationId: "PluginUpgrade" + responses: + 204: + description: "no error" + 404: + description: "plugin not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "remote" + in: "query" + description: | + Remote reference to upgrade to. + + The `:latest` tag is optional, and is used as the default if omitted. + required: true + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration to use when pulling a plugin + from a registry. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + - name: "body" + in: "body" + schema: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + example: + - Name: "network" + Description: "" + Value: + - "host" + - Name: "mount" + Description: "" + Value: + - "/data" + - Name: "device" + Description: "" + Value: + - "/dev/cpu_dma_latency" + tags: ["Plugin"] + /plugins/create: + post: + summary: "Create a plugin" + operationId: "PluginCreate" + consumes: + - "application/x-tar" + responses: + 204: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "query" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "tarContext" + in: "body" + description: "Path to tar containing plugin rootfs and manifest" + schema: + type: "string" + format: "binary" + tags: ["Plugin"] + /plugins/{name}/push: + post: + summary: "Push a plugin" + operationId: "PluginPush" + description: | + Push a plugin to the registry. + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + responses: + 200: + description: "no error" + 404: + description: "plugin not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Plugin"] + /plugins/{name}/set: + post: + summary: "Configure a plugin" + operationId: "PluginSet" + consumes: + - "application/json" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "body" + in: "body" + schema: + type: "array" + items: + type: "string" + example: ["DEBUG=1"] + responses: + 204: + description: "No error" + 404: + description: "Plugin not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Plugin"] + /nodes: + get: + summary: "List nodes" + operationId: "NodeList" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Node" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the nodes list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `id=` + - `label=` + - `membership=`(`accepted`|`pending`)` + - `name=` + - `node.label=` + - `role=`(`manager`|`worker`)` + type: "string" + tags: ["Node"] + /nodes/{id}: + get: + summary: "Inspect a node" + operationId: "NodeInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Node" + 404: + description: "no such node" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the node" + type: "string" + required: true + tags: ["Node"] + delete: + summary: "Delete a node" + operationId: "NodeDelete" + responses: + 200: + description: "no error" + 404: + description: "no such node" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the node" + type: "string" + required: true + - name: "force" + in: "query" + description: "Force remove a node from the swarm" + default: false + type: "boolean" + tags: ["Node"] + /nodes/{id}/update: + post: + summary: "Update a node" + operationId: "NodeUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such node" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID of the node" + type: "string" + required: true + - name: "body" + in: "body" + schema: + $ref: "#/definitions/NodeSpec" + - name: "version" + in: "query" + description: | + The version number of the node object being updated. This is required + to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + tags: ["Node"] + /swarm: + get: + summary: "Inspect swarm" + operationId: "SwarmInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Swarm" + 404: + description: "no such swarm" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Swarm"] + /swarm/init: + post: + summary: "Initialize a new swarm" + operationId: "SwarmInit" + produces: + - "application/json" + - "text/plain" + responses: + 200: + description: "no error" + schema: + description: "The node ID" + type: "string" + example: "7v2t30z9blmxuhnyo6s4cpenp" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is already part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + type: "object" + title: "SwarmInitRequest" + properties: + ListenAddr: + description: | + 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. + type: "string" + AdvertiseAddr: + description: | + 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. + type: "string" + DataPathAddr: + 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 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. + type: "string" + DataPathPort: + description: | + 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. + type: "integer" + format: "uint32" + DefaultAddrPool: + description: | + Default Address Pool specifies default subnet pools for global + scope networks. + type: "array" + items: + type: "string" + example: ["10.10.0.0/16", "20.20.0.0/16"] + ForceNewCluster: + description: "Force creation of a new swarm." + type: "boolean" + SubnetSize: + description: | + SubnetSize specifies the subnet size of the networks created + from the default subnet pool. + type: "integer" + format: "uint32" + Spec: + $ref: "#/definitions/SwarmSpec" + example: + ListenAddr: "0.0.0.0:2377" + AdvertiseAddr: "192.168.1.1:2377" + DataPathPort: 4789 + DefaultAddrPool: ["10.10.0.0/8", "20.20.0.0/8"] + SubnetSize: 24 + ForceNewCluster: false + Spec: + Orchestration: {} + Raft: {} + Dispatcher: {} + CAConfig: {} + EncryptionConfig: + AutoLockManagers: false + tags: ["Swarm"] + /swarm/join: + post: + summary: "Join an existing swarm" + operationId: "SwarmJoin" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is already part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + type: "object" + title: "SwarmJoinRequest" + properties: + ListenAddr: + description: | + 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). + type: "string" + AdvertiseAddr: + description: | + 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. + type: "string" + DataPathAddr: + 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 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. + + type: "string" + RemoteAddrs: + description: | + Addresses of manager nodes already participating in the swarm. + type: "array" + items: + type: "string" + JoinToken: + description: "Secret token for joining this swarm." + type: "string" + example: + ListenAddr: "0.0.0.0:2377" + AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" + RemoteAddrs: + - "node1:2377" + JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" + tags: ["Swarm"] + /swarm/leave: + post: + summary: "Leave a swarm" + operationId: "SwarmLeave" + responses: + 200: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "force" + description: | + Force leave swarm, even if this is the last manager or that it will + break the cluster. + in: "query" + type: "boolean" + default: false + tags: ["Swarm"] + /swarm/update: + post: + summary: "Update a swarm" + operationId: "SwarmUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + $ref: "#/definitions/SwarmSpec" + - name: "version" + in: "query" + description: | + The version number of the swarm object being updated. This is + required to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + - name: "rotateWorkerToken" + in: "query" + description: "Rotate the worker join token." + type: "boolean" + default: false + - name: "rotateManagerToken" + in: "query" + description: "Rotate the manager join token." + type: "boolean" + default: false + - name: "rotateManagerUnlockKey" + in: "query" + description: "Rotate the manager unlock key." + type: "boolean" + default: false + tags: ["Swarm"] + /swarm/unlockkey: + get: + summary: "Get the unlock key" + operationId: "SwarmUnlockkey" + consumes: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "object" + title: "UnlockKeyResponse" + properties: + UnlockKey: + description: "The swarm's unlock key." + type: "string" + example: + UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Swarm"] + /swarm/unlock: + post: + summary: "Unlock a locked manager" + operationId: "SwarmUnlock" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "body" + in: "body" + required: true + schema: + type: "object" + title: "SwarmUnlockRequest" + properties: + UnlockKey: + description: "The swarm's unlock key." + type: "string" + example: + UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" + responses: + 200: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Swarm"] + /services: + get: + summary: "List services" + operationId: "ServiceList" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Service" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the services list. + + Available filters: + + - `id=` + - `label=` + - `mode=["replicated"|"global"]` + - `name=` + - name: "status" + in: "query" + type: "boolean" + description: | + Include service status, with count of running and desired tasks. + tags: ["Service"] + /services/create: + post: + summary: "Create a service" + operationId: "ServiceCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/ServiceCreateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 403: + description: "network is not eligible for services" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "name conflicts with an existing service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + allOf: + - $ref: "#/definitions/ServiceSpec" + - type: "object" + example: + Name: "web" + TaskTemplate: + ContainerSpec: + Image: "nginx:alpine" + Mounts: + - + ReadOnly: true + Source: "web-data" + Target: "/usr/share/nginx/html" + Type: "volume" + VolumeOptions: + DriverConfig: {} + Labels: + com.example.something: "something-value" + Hosts: ["10.10.10.10 host1", "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 host2"] + User: "33" + DNSConfig: + Nameservers: ["8.8.8.8"] + Search: ["example.org"] + Options: ["timeout:3"] + Secrets: + - + File: + Name: "www.example.org.key" + UID: "33" + GID: "33" + Mode: 384 + SecretID: "fpjqlhnwb19zds35k8wn80lq9" + SecretName: "example_org_domain_key" + LogDriver: + Name: "json-file" + Options: + max-file: "3" + max-size: "10M" + Placement: {} + Resources: + Limits: + MemoryBytes: 104857600 + Reservations: {} + RestartPolicy: + Condition: "on-failure" + Delay: 10000000000 + MaxAttempts: 10 + Mode: + Replicated: + Replicas: 4 + UpdateConfig: + Parallelism: 2 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + RollbackConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + EndpointSpec: + Ports: + - + Protocol: "tcp" + PublishedPort: 8080 + TargetPort: 80 + Labels: + foo: "bar" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration for pulling from private + registries. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + tags: ["Service"] + /services/{id}: + get: + summary: "Inspect a service" + operationId: "ServiceInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Service" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID or name of service." + required: true + type: "string" + - name: "insertDefaults" + in: "query" + description: "Fill empty fields with default values." + type: "boolean" + default: false + tags: ["Service"] + delete: + summary: "Delete a service" + operationId: "ServiceDelete" + responses: + 200: + description: "no error" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID or name of service." + required: true + type: "string" + tags: ["Service"] + /services/{id}/update: + post: + summary: "Update a service" + operationId: "ServiceUpdate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/ServiceUpdateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID or name of service." + required: true + type: "string" + - name: "body" + in: "body" + required: true + schema: + allOf: + - $ref: "#/definitions/ServiceSpec" + - type: "object" + example: + Name: "top" + TaskTemplate: + ContainerSpec: + Image: "busybox" + Args: + - "top" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ForceUpdate: 0 + Mode: + Replicated: + Replicas: 1 + UpdateConfig: + Parallelism: 2 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + RollbackConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + EndpointSpec: + Mode: "vip" + + - name: "version" + in: "query" + description: | + The version number of the service object being updated. This is + required to avoid conflicting writes. + This version number should be the value as currently set on the + service *before* the update. You can find the current version by + calling `GET /services/{id}` + required: true + type: "integer" + - name: "registryAuthFrom" + in: "query" + description: | + If the `X-Registry-Auth` header is not specified, this parameter + indicates where to find registry authorization credentials. + type: "string" + enum: ["spec", "previous-spec"] + default: "spec" + - name: "rollback" + in: "query" + description: | + Set to this parameter to `previous` to cause a server-side rollback + to the previous service spec. The supplied spec will be ignored in + this case. + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration for pulling from private + registries. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + + tags: ["Service"] + /services/{id}/logs: + get: + summary: "Get service logs" + description: | + Get `stdout` and `stderr` logs from a service. See also + [`/containers/{id}/logs`](#operation/ContainerLogs). + + **Note**: This endpoint works only for services with the `local`, + `json-file` or `journald` logging drivers. + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + operationId: "ServiceLogs" + responses: + 200: + description: "logs returned as a stream in response body" + schema: + type: "string" + format: "binary" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such service: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the service" + type: "string" + - name: "details" + in: "query" + description: "Show service context and extra details provided to logs." + type: "boolean" + default: false + - name: "follow" + in: "query" + description: "Keep connection after returning logs." + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Return logs from `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Return logs from `stderr`" + type: "boolean" + default: false + - name: "since" + in: "query" + description: "Only return logs since this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "timestamps" + in: "query" + description: "Add timestamps to every log line" + type: "boolean" + default: false + - name: "tail" + in: "query" + description: | + Only return this number of log lines from the end of the logs. + Specify as an integer or `all` to output all log lines. + type: "string" + default: "all" + tags: ["Service"] + /tasks: + get: + summary: "List tasks" + operationId: "TaskList" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Task" + example: + - ID: "0kzzo1i0y4jz6027t0k7aezc7" + Version: + Index: 71 + CreatedAt: "2016-06-07T21:07:31.171892745Z" + UpdatedAt: "2016-06-07T21:07:31.376370513Z" + Spec: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Slot: 1 + NodeID: "60gvrl6tm78dmak4yl7srz94v" + Status: + Timestamp: "2016-06-07T21:07:31.290032978Z" + State: "running" + Message: "started" + ContainerStatus: + ContainerID: "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035" + PID: 677 + DesiredState: "running" + NetworksAttachments: + - Network: + ID: "4qvuz4ko70xaltuqbt8956gd1" + Version: + Index: 18 + CreatedAt: "2016-06-07T20:31:11.912919752Z" + UpdatedAt: "2016-06-07T21:07:29.955277358Z" + Spec: + Name: "ingress" + Labels: + com.docker.swarm.internal: "true" + DriverConfiguration: {} + IPAMOptions: + Driver: {} + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + DriverState: + Name: "overlay" + Options: + com.docker.network.driver.overlay.vxlanid_list: "256" + IPAMOptions: + Driver: + Name: "default" + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + Addresses: + - "10.255.0.10/16" + - ID: "1yljwbmlr8er2waf8orvqpwms" + Version: + Index: 30 + CreatedAt: "2016-06-07T21:07:30.019104782Z" + UpdatedAt: "2016-06-07T21:07:30.231958098Z" + Name: "hopeful_cori" + Spec: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Slot: 1 + NodeID: "60gvrl6tm78dmak4yl7srz94v" + Status: + Timestamp: "2016-06-07T21:07:30.202183143Z" + State: "shutdown" + Message: "shutdown" + ContainerStatus: + ContainerID: "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213" + DesiredState: "shutdown" + NetworksAttachments: + - Network: + ID: "4qvuz4ko70xaltuqbt8956gd1" + Version: + Index: 18 + CreatedAt: "2016-06-07T20:31:11.912919752Z" + UpdatedAt: "2016-06-07T21:07:29.955277358Z" + Spec: + Name: "ingress" + Labels: + com.docker.swarm.internal: "true" + DriverConfiguration: {} + IPAMOptions: + Driver: {} + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + DriverState: + Name: "overlay" + Options: + com.docker.network.driver.overlay.vxlanid_list: "256" + IPAMOptions: + Driver: + Name: "default" + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + Addresses: + - "10.255.0.5/16" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the tasks list. + + Available filters: + + - `desired-state=(running | shutdown | accepted)` + - `id=` + - `label=key` or `label="key=value"` + - `name=` + - `node=` + - `service=` + tags: ["Task"] + /tasks/{id}: + get: + summary: "Inspect a task" + operationId: "TaskInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Task" + 404: + description: "no such task" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID of the task" + required: true + type: "string" + tags: ["Task"] + /tasks/{id}/logs: + get: + summary: "Get task logs" + description: | + Get `stdout` and `stderr` logs from a task. + See also [`/containers/{id}/logs`](#operation/ContainerLogs). + + **Note**: This endpoint works only for services with the `local`, + `json-file` or `journald` logging drivers. + operationId: "TaskLogs" + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + responses: + 200: + description: "logs returned as a stream in response body" + schema: + type: "string" + format: "binary" + 404: + description: "no such task" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such task: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID of the task" + type: "string" + - name: "details" + in: "query" + description: "Show task context and extra details provided to logs." + type: "boolean" + default: false + - name: "follow" + in: "query" + description: "Keep connection after returning logs." + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Return logs from `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Return logs from `stderr`" + type: "boolean" + default: false + - name: "since" + in: "query" + description: "Only return logs since this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "timestamps" + in: "query" + description: "Add timestamps to every log line" + type: "boolean" + default: false + - name: "tail" + in: "query" + description: | + Only return this number of log lines from the end of the logs. + Specify as an integer or `all` to output all log lines. + type: "string" + default: "all" + tags: ["Task"] + /secrets: + get: + summary: "List secrets" + operationId: "SecretList" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Secret" + example: + - ID: "blt1owaxmitz71s9v5zh81zun" + Version: + Index: 85 + CreatedAt: "2017-07-20T13:55:28.678958722Z" + UpdatedAt: "2017-07-20T13:55:28.678958722Z" + Spec: + Name: "mysql-passwd" + Labels: + some.label: "some.value" + Driver: + Name: "secret-bucket" + Options: + OptionA: "value for driver option A" + OptionB: "value for driver option B" + - ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "app-dev.crt" + Labels: + foo: "bar" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the secrets list. + + Available filters: + + - `id=` + - `label= or label==value` + - `name=` + - `names=` + tags: ["Secret"] + /secrets/create: + post: + summary: "Create a secret" + operationId: "SecretCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IdResponse" + 409: + description: "name conflicts with an existing object" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + schema: + allOf: + - $ref: "#/definitions/SecretSpec" + - type: "object" + example: + Name: "app-key.crt" + Labels: + foo: "bar" + Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" + Driver: + Name: "secret-bucket" + Options: + OptionA: "value for driver option A" + OptionB: "value for driver option B" + tags: ["Secret"] + /secrets/{id}: + get: + summary: "Inspect a secret" + operationId: "SecretInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Secret" + examples: + application/json: + ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "app-dev.crt" + Labels: + foo: "bar" + Driver: + Name: "secret-bucket" + Options: + OptionA: "value for driver option A" + OptionB: "value for driver option B" + + 404: + description: "secret not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the secret" + tags: ["Secret"] + delete: + summary: "Delete a secret" + operationId: "SecretDelete" + produces: + - "application/json" + responses: + 204: + description: "no error" + 404: + description: "secret not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the secret" + tags: ["Secret"] + /secrets/{id}/update: + post: + summary: "Update a Secret" + operationId: "SecretUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such secret" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the secret" + type: "string" + required: true + - name: "body" + in: "body" + schema: + $ref: "#/definitions/SecretSpec" + description: | + The spec of the secret to update. Currently, only the Labels field + can be updated. All other fields must remain unchanged from the + [SecretInspect endpoint](#operation/SecretInspect) response values. + - name: "version" + in: "query" + description: | + The version number of the secret object being updated. This is + required to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + tags: ["Secret"] + /configs: + get: + summary: "List configs" + operationId: "ConfigList" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Config" + example: + - ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "server.conf" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the configs list. + + Available filters: + + - `id=` + - `label= or label==value` + - `name=` + - `names=` + tags: ["Config"] + /configs/create: + post: + summary: "Create a config" + operationId: "ConfigCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IdResponse" + 409: + description: "name conflicts with an existing object" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + schema: + allOf: + - $ref: "#/definitions/ConfigSpec" + - type: "object" + example: + Name: "server.conf" + Labels: + foo: "bar" + Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" + tags: ["Config"] + /configs/{id}: + get: + summary: "Inspect a config" + operationId: "ConfigInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Config" + examples: + application/json: + ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "app-dev.crt" + 404: + description: "config not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the config" + tags: ["Config"] + delete: + summary: "Delete a config" + operationId: "ConfigDelete" + produces: + - "application/json" + responses: + 204: + description: "no error" + 404: + description: "config not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the config" + tags: ["Config"] + /configs/{id}/update: + post: + summary: "Update a Config" + operationId: "ConfigUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such config" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the config" + type: "string" + required: true + - name: "body" + in: "body" + schema: + $ref: "#/definitions/ConfigSpec" + description: | + The spec of the config to update. Currently, only the Labels field + can be updated. All other fields must remain unchanged from the + [ConfigInspect endpoint](#operation/ConfigInspect) response values. + - name: "version" + in: "query" + description: | + The version number of the config object being updated. This is + required to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + tags: ["Config"] + /distribution/{name}/json: + get: + summary: "Get image information from the registry" + description: | + Return image digest and platform information by contacting the registry. + operationId: "DistributionInspect" + produces: + - "application/json" + responses: + 200: + description: "descriptor and platform information" + schema: + $ref: "#/definitions/DistributionInspect" + 401: + description: "Failed authentication or no image found" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such image: someimage (tag: latest)" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or id" + type: "string" + required: true + tags: ["Distribution"] + /session: + post: + summary: "Initialize interactive session" + description: | + Start a new interactive session with a server. Session allows server to + call back to the client for advanced capabilities. + + ### Hijacking + + This endpoint hijacks the HTTP connection to HTTP2 transport that allows + the client to expose gPRC services on that connection. + + For example, the client sends this request to upgrade the connection: + + ``` + POST /session HTTP/1.1 + Upgrade: h2c + Connection: Upgrade + ``` + + The Docker daemon responds with a `101 UPGRADED` response follow with + the raw stream: + + ``` + HTTP/1.1 101 UPGRADED + Connection: Upgrade + Upgrade: h2c + ``` + operationId: "Session" + produces: + - "application/vnd.docker.raw-stream" + responses: + 101: + description: "no error, hijacking successful" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Session"] diff --git a/api-model-v1-44/docs/Address.md b/api-model-v1-44/docs/Address.md new file mode 100644 index 00000000..0b2b6f74 --- /dev/null +++ b/api-model-v1-44/docs/Address.md @@ -0,0 +1,11 @@ + +# Address + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **addr** | **kotlin.String** | IP address. | [optional] | +| **prefixLen** | **kotlin.Int** | Mask length of the IP address. | [optional] | + + + diff --git a/api-model-v1-44/docs/AuthConfig.md b/api-model-v1-44/docs/AuthConfig.md new file mode 100644 index 00000000..c19f1f35 --- /dev/null +++ b/api-model-v1-44/docs/AuthConfig.md @@ -0,0 +1,13 @@ + +# AuthConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **username** | **kotlin.String** | | [optional] | +| **password** | **kotlin.String** | | [optional] | +| **email** | **kotlin.String** | Email is an optional value associated with the username. > **Deprecated**: This field is deprecated since docker 1.11 (API v1.23) and will be removed in a future release. | [optional] | +| **serveraddress** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/BuildCache.md b/api-model-v1-44/docs/BuildCache.md new file mode 100644 index 00000000..ac8f462a --- /dev/null +++ b/api-model-v1-44/docs/BuildCache.md @@ -0,0 +1,26 @@ + +# BuildCache + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique ID of the build cache record. | [optional] | +| **parents** | **kotlin.collections.MutableList<kotlin.String>** | List of parent build cache record IDs. | [optional] | +| **type** | [**inline**](#Type) | Cache record type. | [optional] | +| **description** | **kotlin.String** | Description of the build-step that produced the build cache. | [optional] | +| **inUse** | **kotlin.Boolean** | Indicates if the build cache is in use. | [optional] | +| **shared** | **kotlin.Boolean** | Indicates if the build cache is shared. | [optional] | +| **propertySize** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **lastUsedAt** | **kotlin.String** | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **usageCount** | **kotlin.Int** | | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | internal, frontend, source.local, source.git.checkout, exec.cachemount, regular | + + + diff --git a/api-model-v1-44/docs/BuildInfo.md b/api-model-v1-44/docs/BuildInfo.md new file mode 100644 index 00000000..7adad3f3 --- /dev/null +++ b/api-model-v1-44/docs/BuildInfo.md @@ -0,0 +1,17 @@ + +# BuildInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **stream** | **kotlin.String** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | +| **aux** | [**ImageID**](ImageID.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/BuildPruneResponse.md b/api-model-v1-44/docs/BuildPruneResponse.md new file mode 100644 index 00000000..99595843 --- /dev/null +++ b/api-model-v1-44/docs/BuildPruneResponse.md @@ -0,0 +1,11 @@ + +# BuildPruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-44/docs/ChangeType.md b/api-model-v1-44/docs/ChangeType.md new file mode 100644 index 00000000..25c1d3e1 --- /dev/null +++ b/api-model-v1-44/docs/ChangeType.md @@ -0,0 +1,14 @@ + +# ChangeType + +## Enum + + + * `T0` (value: `0`) + + * `T1` (value: `1`) + + * `T2` (value: `2`) + + + diff --git a/api-model-v1-44/docs/ClusterInfo.md b/api-model-v1-44/docs/ClusterInfo.md new file mode 100644 index 00000000..c7f6c112 --- /dev/null +++ b/api-model-v1-44/docs/ClusterInfo.md @@ -0,0 +1,19 @@ + +# ClusterInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [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, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | + + + diff --git a/api-model-v1-44/docs/ClusterVolume.md b/api-model-v1-44/docs/ClusterVolume.md new file mode 100644 index 00000000..da0a33cf --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolume.md @@ -0,0 +1,16 @@ + +# ClusterVolume + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | +| **info** | [**ClusterVolumeInfo**](ClusterVolumeInfo.md) | | [optional] | +| **publishStatus** | [**kotlin.collections.MutableList<ClusterVolumePublishStatusInner>**](ClusterVolumePublishStatusInner.md) | The status of the volume as it pertains to its publishing and use on specific nodes | [optional] | + + + diff --git a/api-model-v1-44/docs/ClusterVolumeInfo.md b/api-model-v1-44/docs/ClusterVolumeInfo.md new file mode 100644 index 00000000..55fef034 --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumeInfo.md @@ -0,0 +1,13 @@ + +# ClusterVolumeInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capacityBytes** | **kotlin.Long** | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional] | +| **volumeContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned from the storage plugin when the volume is created. | [optional] | +| **volumeID** | **kotlin.String** | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional] | +| **accessibleTopology** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | The topology this volume is actually accessible from. | [optional] | + + + diff --git a/api-model-v1-44/docs/ClusterVolumePublishStatusInner.md b/api-model-v1-44/docs/ClusterVolumePublishStatusInner.md new file mode 100644 index 00000000..96142792 --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumePublishStatusInner.md @@ -0,0 +1,19 @@ + +# ClusterVolumePublishStatusInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | The ID of the Swarm node the volume is published on. | [optional] | +| **state** | [**inline**](#State) | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional] | +| **publishContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional] | + + + +## Enum: State +| Name | Value | +| ---- | ----- | +| state | pending-publish, published, pending-node-unpublish, pending-controller-unpublish | + + + diff --git a/api-model-v1-44/docs/ClusterVolumeSpec.md b/api-model-v1-44/docs/ClusterVolumeSpec.md new file mode 100644 index 00000000..670b70e0 --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumeSpec.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **group** | **kotlin.String** | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional] | +| **accessMode** | [**ClusterVolumeSpecAccessMode**](ClusterVolumeSpecAccessMode.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ClusterVolumeSpecAccessMode.md b/api-model-v1-44/docs/ClusterVolumeSpecAccessMode.md new file mode 100644 index 00000000..37eb7734 --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumeSpecAccessMode.md @@ -0,0 +1,37 @@ + +# ClusterVolumeSpecAccessMode + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **scope** | [**inline**](#Scope) | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional] | +| **sharing** | [**inline**](#Sharing) | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional] | +| **mountVolume** | [**kotlin.Any**](.md) | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional] | +| **secrets** | [**kotlin.collections.MutableList<ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpecAccessModeSecretsInner.md) | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional] | +| **accessibilityRequirements** | [**ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpecAccessModeAccessibilityRequirements.md) | | [optional] | +| **capacityRange** | [**ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpecAccessModeCapacityRange.md) | | [optional] | +| **availability** | [**inline**](#Availability) | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional] | + + + +## Enum: Scope +| Name | Value | +| ---- | ----- | +| scope | single, multi | + + + +## Enum: Sharing +| Name | Value | +| ---- | ----- | +| sharing | none, readonly, onewriter, all | + + + +## Enum: Availability +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | + + + diff --git a/api-model-v1-44/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md b/api-model-v1-44/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md new file mode 100644 index 00000000..fe071a5d --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpecAccessModeAccessibilityRequirements + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requisite** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of required topologies, at least one of which the volume must be accessible from. | [optional] | +| **preferred** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of topologies that the volume should attempt to be provisioned in. | [optional] | + + + diff --git a/api-model-v1-44/docs/ClusterVolumeSpecAccessModeCapacityRange.md b/api-model-v1-44/docs/ClusterVolumeSpecAccessModeCapacityRange.md new file mode 100644 index 00000000..6ed01224 --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumeSpecAccessModeCapacityRange.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpecAccessModeCapacityRange + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requiredBytes** | **kotlin.Long** | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional] | +| **limitBytes** | **kotlin.Long** | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional] | + + + diff --git a/api-model-v1-44/docs/ClusterVolumeSpecAccessModeSecretsInner.md b/api-model-v1-44/docs/ClusterVolumeSpecAccessModeSecretsInner.md new file mode 100644 index 00000000..608a6876 --- /dev/null +++ b/api-model-v1-44/docs/ClusterVolumeSpecAccessModeSecretsInner.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpecAccessModeSecretsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **key** | **kotlin.String** | Key is the name of the key of the key-value pair passed to the plugin. | [optional] | +| **secret** | **kotlin.String** | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional] | + + + diff --git a/api-model-v1-44/docs/Commit.md b/api-model-v1-44/docs/Commit.md new file mode 100644 index 00000000..db8ec2f9 --- /dev/null +++ b/api-model-v1-44/docs/Commit.md @@ -0,0 +1,11 @@ + +# Commit + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Actual commit ID of external tool. | [optional] | +| **expected** | **kotlin.String** | Commit ID of external tool expected by dockerd as set at build time. | [optional] | + + + diff --git a/api-model-v1-44/docs/Config.md b/api-model-v1-44/docs/Config.md new file mode 100644 index 00000000..5174c406 --- /dev/null +++ b/api-model-v1-44/docs/Config.md @@ -0,0 +1,14 @@ + +# Config + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ConfigSpec**](ConfigSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ConfigCreateRequest.md b/api-model-v1-44/docs/ConfigCreateRequest.md new file mode 100644 index 00000000..ced7b32d --- /dev/null +++ b/api-model-v1-44/docs/ConfigCreateRequest.md @@ -0,0 +1,13 @@ + +# ConfigCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ConfigReference.md b/api-model-v1-44/docs/ConfigReference.md new file mode 100644 index 00000000..02d63956 --- /dev/null +++ b/api-model-v1-44/docs/ConfigReference.md @@ -0,0 +1,10 @@ + +# ConfigReference + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **network** | **kotlin.String** | The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. | [optional] | + + + diff --git a/api-model-v1-44/docs/ConfigSpec.md b/api-model-v1-44/docs/ConfigSpec.md new file mode 100644 index 00000000..2a16d7a9 --- /dev/null +++ b/api-model-v1-44/docs/ConfigSpec.md @@ -0,0 +1,13 @@ + +# ConfigSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerConfig.md b/api-model-v1-44/docs/ContainerConfig.md new file mode 100644 index 00000000..06a2c65b --- /dev/null +++ b/api-model-v1-44/docs/ContainerConfig.md @@ -0,0 +1,34 @@ + +# ContainerConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerCreateRequest.md b/api-model-v1-44/docs/ContainerCreateRequest.md new file mode 100644 index 00000000..14e964f9 --- /dev/null +++ b/api-model-v1-44/docs/ContainerCreateRequest.md @@ -0,0 +1,36 @@ + +# ContainerCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **networkingConfig** | [**NetworkingConfig**](NetworkingConfig.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerCreateResponse.md b/api-model-v1-44/docs/ContainerCreateResponse.md new file mode 100644 index 00000000..2470f713 --- /dev/null +++ b/api-model-v1-44/docs/ContainerCreateResponse.md @@ -0,0 +1,11 @@ + +# ContainerCreateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created container | | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerInspectResponse.md b/api-model-v1-44/docs/ContainerInspectResponse.md new file mode 100644 index 00000000..f4cf96a4 --- /dev/null +++ b/api-model-v1-44/docs/ContainerInspectResponse.md @@ -0,0 +1,34 @@ + +# ContainerInspectResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the container | [optional] | +| **created** | **kotlin.String** | The time the container was created | [optional] | +| **path** | **kotlin.String** | The path to the command being run | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | The arguments to the command being run | [optional] | +| **state** | [**ContainerState**](ContainerState.md) | | [optional] | +| **image** | **kotlin.String** | The container's image ID | [optional] | +| **resolvConfPath** | **kotlin.String** | | [optional] | +| **hostnamePath** | **kotlin.String** | | [optional] | +| **hostsPath** | **kotlin.String** | | [optional] | +| **logPath** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **restartCount** | **kotlin.Int** | | [optional] | +| **driver** | **kotlin.String** | | [optional] | +| **platform** | **kotlin.String** | | [optional] | +| **mountLabel** | **kotlin.String** | | [optional] | +| **processLabel** | **kotlin.String** | | [optional] | +| **appArmorProfile** | **kotlin.String** | | [optional] | +| **execIDs** | **kotlin.collections.MutableList<kotlin.String>** | IDs of exec instances that are running in the container. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [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] | +| **mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | | [optional] | +| **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **networkSettings** | [**NetworkSettings**](NetworkSettings.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerPruneResponse.md b/api-model-v1-44/docs/ContainerPruneResponse.md new file mode 100644 index 00000000..d498e282 --- /dev/null +++ b/api-model-v1-44/docs/ContainerPruneResponse.md @@ -0,0 +1,11 @@ + +# ContainerPruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containersDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Container IDs that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerState.md b/api-model-v1-44/docs/ContainerState.md new file mode 100644 index 00000000..85d232e5 --- /dev/null +++ b/api-model-v1-44/docs/ContainerState.md @@ -0,0 +1,28 @@ + +# ContainerState + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] | +| **running** | **kotlin.Boolean** | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional] | +| **paused** | **kotlin.Boolean** | Whether this container is paused. | [optional] | +| **restarting** | **kotlin.Boolean** | Whether this container is restarting. | [optional] | +| **ooMKilled** | **kotlin.Boolean** | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional] | +| **dead** | **kotlin.Boolean** | | [optional] | +| **pid** | **kotlin.Int** | The process ID of this container | [optional] | +| **exitCode** | **kotlin.Int** | The last exit code of this container | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **startedAt** | **kotlin.String** | The time when this container was last started. | [optional] | +| **finishedAt** | **kotlin.String** | The time when this container last exited. | [optional] | +| **health** | [**Health**](Health.md) | | [optional] | + + + +## Enum: Status +| Name | Value | +| ---- | ----- | +| status | created, running, paused, restarting, removing, exited, dead | + + + diff --git a/api-model-v1-44/docs/ContainerStatus.md b/api-model-v1-44/docs/ContainerStatus.md new file mode 100644 index 00000000..b58e6e86 --- /dev/null +++ b/api-model-v1-44/docs/ContainerStatus.md @@ -0,0 +1,12 @@ + +# ContainerStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | | [optional] | +| **PID** | **kotlin.Int** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerSummary.md b/api-model-v1-44/docs/ContainerSummary.md new file mode 100644 index 00000000..0701022d --- /dev/null +++ b/api-model-v1-44/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.MutableList<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.MutableList<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.MutableMap<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.MutableList<MountPoint>**](MountPoint.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerSummaryHostConfig.md b/api-model-v1-44/docs/ContainerSummaryHostConfig.md new file mode 100644 index 00000000..646ecc02 --- /dev/null +++ b/api-model-v1-44/docs/ContainerSummaryHostConfig.md @@ -0,0 +1,10 @@ + +# ContainerSummaryHostConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkMode** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerSummaryNetworkSettings.md b/api-model-v1-44/docs/ContainerSummaryNetworkSettings.md new file mode 100644 index 00000000..976bd525 --- /dev/null +++ b/api-model-v1-44/docs/ContainerSummaryNetworkSettings.md @@ -0,0 +1,10 @@ + +# ContainerSummaryNetworkSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerTopResponse.md b/api-model-v1-44/docs/ContainerTopResponse.md new file mode 100644 index 00000000..2be83bc3 --- /dev/null +++ b/api-model-v1-44/docs/ContainerTopResponse.md @@ -0,0 +1,11 @@ + +# ContainerTopResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **titles** | **kotlin.collections.MutableList<kotlin.String>** | The ps column titles | [optional] | +| **processes** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Each process running in the container, where each is process is an array of values corresponding to the titles. | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerUpdateRequest.md b/api-model-v1-44/docs/ContainerUpdateRequest.md new file mode 100644 index 00000000..44b57d97 --- /dev/null +++ b/api-model-v1-44/docs/ContainerUpdateRequest.md @@ -0,0 +1,41 @@ + +# ContainerUpdateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerUpdateResponse.md b/api-model-v1-44/docs/ContainerUpdateResponse.md new file mode 100644 index 00000000..d8314d37 --- /dev/null +++ b/api-model-v1-44/docs/ContainerUpdateResponse.md @@ -0,0 +1,10 @@ + +# ContainerUpdateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerWaitExitError.md b/api-model-v1-44/docs/ContainerWaitExitError.md new file mode 100644 index 00000000..42bceba4 --- /dev/null +++ b/api-model-v1-44/docs/ContainerWaitExitError.md @@ -0,0 +1,10 @@ + +# ContainerWaitExitError + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | Details of an error | [optional] | + + + diff --git a/api-model-v1-44/docs/ContainerWaitResponse.md b/api-model-v1-44/docs/ContainerWaitResponse.md new file mode 100644 index 00000000..8e2eea9b --- /dev/null +++ b/api-model-v1-44/docs/ContainerWaitResponse.md @@ -0,0 +1,11 @@ + +# ContainerWaitResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **statusCode** | **kotlin.Long** | Exit code of the container | | +| **error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/CreateImageInfo.md b/api-model-v1-44/docs/CreateImageInfo.md new file mode 100644 index 00000000..1672d321 --- /dev/null +++ b/api-model-v1-44/docs/CreateImageInfo.md @@ -0,0 +1,15 @@ + +# CreateImageInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/DeviceMapping.md b/api-model-v1-44/docs/DeviceMapping.md new file mode 100644 index 00000000..d90a503a --- /dev/null +++ b/api-model-v1-44/docs/DeviceMapping.md @@ -0,0 +1,12 @@ + +# DeviceMapping + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pathOnHost** | **kotlin.String** | | [optional] | +| **pathInContainer** | **kotlin.String** | | [optional] | +| **cgroupPermissions** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/DeviceRequest.md b/api-model-v1-44/docs/DeviceRequest.md new file mode 100644 index 00000000..e54c22ac --- /dev/null +++ b/api-model-v1-44/docs/DeviceRequest.md @@ -0,0 +1,14 @@ + +# DeviceRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | | [optional] | +| **count** | **kotlin.Int** | | [optional] | +| **deviceIDs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **capabilities** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional] | + + + diff --git a/api-model-v1-44/docs/DistributionInspect.md b/api-model-v1-44/docs/DistributionInspect.md new file mode 100644 index 00000000..fef111c5 --- /dev/null +++ b/api-model-v1-44/docs/DistributionInspect.md @@ -0,0 +1,11 @@ + +# DistributionInspect + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | | +| **platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | | + + + diff --git a/api-model-v1-44/docs/Driver.md b/api-model-v1-44/docs/Driver.md new file mode 100644 index 00000000..1d98106e --- /dev/null +++ b/api-model-v1-44/docs/Driver.md @@ -0,0 +1,11 @@ + +# Driver + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] | + + + diff --git a/api-model-v1-44/docs/EndpointIPAMConfig.md b/api-model-v1-44/docs/EndpointIPAMConfig.md new file mode 100644 index 00000000..f12793e4 --- /dev/null +++ b/api-model-v1-44/docs/EndpointIPAMConfig.md @@ -0,0 +1,12 @@ + +# EndpointIPAMConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | +| **linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/EndpointPortConfig.md b/api-model-v1-44/docs/EndpointPortConfig.md new file mode 100644 index 00000000..6dc393a5 --- /dev/null +++ b/api-model-v1-44/docs/EndpointPortConfig.md @@ -0,0 +1,28 @@ + +# EndpointPortConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **protocol** | [**inline**](#Protocol) | | [optional] | +| **targetPort** | **kotlin.Int** | The port inside the container. | [optional] | +| **publishedPort** | **kotlin.Int** | The port on the swarm hosts. | [optional] | +| **publishMode** | [**inline**](#PublishMode) | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional] | + + + +## Enum: Protocol +| Name | Value | +| ---- | ----- | +| protocol | tcp, udp, sctp | + + + +## Enum: PublishMode +| Name | Value | +| ---- | ----- | +| publishMode | ingress, host | + + + diff --git a/api-model-v1-44/docs/EndpointSettings.md b/api-model-v1-44/docs/EndpointSettings.md new file mode 100644 index 00000000..f6968796 --- /dev/null +++ b/api-model-v1-44/docs/EndpointSettings.md @@ -0,0 +1,23 @@ + +# EndpointSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **networkID** | **kotlin.String** | Unique ID of the network. | [optional] | +| **endpointID** | **kotlin.String** | Unique ID for the service endpoint in a Sandbox. | [optional] | +| **gateway** | **kotlin.String** | Gateway address for this network. | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address. | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address. | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **dnSNames** | **kotlin.collections.MutableList<kotlin.String>** | List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.<network-name>`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. | [optional] | + + + diff --git a/api-model-v1-44/docs/EndpointSpec.md b/api-model-v1-44/docs/EndpointSpec.md new file mode 100644 index 00000000..9b02a1e3 --- /dev/null +++ b/api-model-v1-44/docs/EndpointSpec.md @@ -0,0 +1,18 @@ + +# EndpointSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | The mode of resolution to use for internal load balancing between tasks. | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional] | + + + +## Enum: Mode +| Name | Value | +| ---- | ----- | +| mode | vip, dnsrr | + + + diff --git a/api-model-v1-44/docs/EngineDescription.md b/api-model-v1-44/docs/EngineDescription.md new file mode 100644 index 00000000..c9abe8ae --- /dev/null +++ b/api-model-v1-44/docs/EngineDescription.md @@ -0,0 +1,12 @@ + +# EngineDescription + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **engineVersion** | **kotlin.String** | | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | +| **plugins** | [**kotlin.collections.MutableList<EngineDescriptionPluginsInner>**](EngineDescriptionPluginsInner.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/EngineDescriptionPluginsInner.md b/api-model-v1-44/docs/EngineDescriptionPluginsInner.md new file mode 100644 index 00000000..53229a1d --- /dev/null +++ b/api-model-v1-44/docs/EngineDescriptionPluginsInner.md @@ -0,0 +1,11 @@ + +# EngineDescriptionPluginsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ErrorDetail.md b/api-model-v1-44/docs/ErrorDetail.md new file mode 100644 index 00000000..d909c08f --- /dev/null +++ b/api-model-v1-44/docs/ErrorDetail.md @@ -0,0 +1,11 @@ + +# ErrorDetail + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **code** | **kotlin.Int** | | [optional] | +| **message** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ErrorResponse.md b/api-model-v1-44/docs/ErrorResponse.md new file mode 100644 index 00000000..24722b5a --- /dev/null +++ b/api-model-v1-44/docs/ErrorResponse.md @@ -0,0 +1,10 @@ + +# ErrorResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | The error message. | | + + + diff --git a/api-model-v1-44/docs/EventActor.md b/api-model-v1-44/docs/EventActor.md new file mode 100644 index 00000000..62eadd88 --- /dev/null +++ b/api-model-v1-44/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.MutableMap<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] | + + + diff --git a/api-model-v1-44/docs/EventMessage.md b/api-model-v1-44/docs/EventMessage.md new file mode 100644 index 00000000..30e7daf3 --- /dev/null +++ b/api-model-v1-44/docs/EventMessage.md @@ -0,0 +1,29 @@ + +# EventMessage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The type of object emitting the event | [optional] | +| **action** | **kotlin.String** | The type of event | [optional] | +| **actor** | [**EventActor**](EventActor.md) | | [optional] | +| **scope** | [**inline**](#Scope) | 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-v1-44/docs/ExecConfig.md b/api-model-v1-44/docs/ExecConfig.md new file mode 100644 index 00000000..29f9dea7 --- /dev/null +++ b/api-model-v1-44/docs/ExecConfig.md @@ -0,0 +1,20 @@ + +# 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] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [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.MutableList<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] | +| **cmd** | **kotlin.collections.MutableList<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-v1-44/docs/ExecInspectResponse.md b/api-model-v1-44/docs/ExecInspectResponse.md new file mode 100644 index 00000000..17dac875 --- /dev/null +++ b/api-model-v1-44/docs/ExecInspectResponse.md @@ -0,0 +1,20 @@ + +# ExecInspectResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **canRemove** | **kotlin.Boolean** | | [optional] | +| **detachKeys** | **kotlin.String** | | [optional] | +| **ID** | **kotlin.String** | | [optional] | +| **running** | **kotlin.Boolean** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | +| **processConfig** | [**ProcessConfig**](ProcessConfig.md) | | [optional] | +| **openStdin** | **kotlin.Boolean** | | [optional] | +| **openStderr** | **kotlin.Boolean** | | [optional] | +| **openStdout** | **kotlin.Boolean** | | [optional] | +| **containerID** | **kotlin.String** | | [optional] | +| **pid** | **kotlin.Int** | The system process ID for the exec process. | [optional] | + + + diff --git a/api-model-v1-44/docs/ExecStartConfig.md b/api-model-v1-44/docs/ExecStartConfig.md new file mode 100644 index 00000000..8553f097 --- /dev/null +++ b/api-model-v1-44/docs/ExecStartConfig.md @@ -0,0 +1,12 @@ + +# ExecStartConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **detach** | **kotlin.Boolean** | Detach from the command. | [optional] | +| **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | + + + diff --git a/api-model-v1-44/docs/FilesystemChange.md b/api-model-v1-44/docs/FilesystemChange.md new file mode 100644 index 00000000..8354bea7 --- /dev/null +++ b/api-model-v1-44/docs/FilesystemChange.md @@ -0,0 +1,11 @@ + +# FilesystemChange + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Path to file or directory that has changed. | | +| **kind** | [**ChangeType**](ChangeType.md) | | | + + + diff --git a/api-model-v1-44/docs/GenericResourcesInner.md b/api-model-v1-44/docs/GenericResourcesInner.md new file mode 100644 index 00000000..0019d861 --- /dev/null +++ b/api-model-v1-44/docs/GenericResourcesInner.md @@ -0,0 +1,11 @@ + +# GenericResourcesInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **namedResourceSpec** | [**GenericResourcesInnerNamedResourceSpec**](GenericResourcesInnerNamedResourceSpec.md) | | [optional] | +| **discreteResourceSpec** | [**GenericResourcesInnerDiscreteResourceSpec**](GenericResourcesInnerDiscreteResourceSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/GenericResourcesInnerDiscreteResourceSpec.md b/api-model-v1-44/docs/GenericResourcesInnerDiscreteResourceSpec.md new file mode 100644 index 00000000..0b8faebe --- /dev/null +++ b/api-model-v1-44/docs/GenericResourcesInnerDiscreteResourceSpec.md @@ -0,0 +1,11 @@ + +# GenericResourcesInnerDiscreteResourceSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.Long** | | [optional] | + + + diff --git a/api-model-v1-44/docs/GenericResourcesInnerNamedResourceSpec.md b/api-model-v1-44/docs/GenericResourcesInnerNamedResourceSpec.md new file mode 100644 index 00000000..0f5ec50d --- /dev/null +++ b/api-model-v1-44/docs/GenericResourcesInnerNamedResourceSpec.md @@ -0,0 +1,11 @@ + +# GenericResourcesInnerNamedResourceSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/GraphDriverData.md b/api-model-v1-44/docs/GraphDriverData.md new file mode 100644 index 00000000..448e627c --- /dev/null +++ b/api-model-v1-44/docs/GraphDriverData.md @@ -0,0 +1,11 @@ + +# GraphDriverData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the storage driver. | | +| **`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] | + + + diff --git a/api-model-v1-44/docs/Health.md b/api-model-v1-44/docs/Health.md new file mode 100644 index 00000000..e888268e --- /dev/null +++ b/api-model-v1-44/docs/Health.md @@ -0,0 +1,19 @@ + +# Health + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional] | +| **failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] | +| **log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] | + + + +## Enum: Status +| Name | Value | +| ---- | ----- | +| status | none, starting, healthy, unhealthy | + + + diff --git a/api-model-v1-44/docs/HealthConfig.md b/api-model-v1-44/docs/HealthConfig.md new file mode 100644 index 00000000..a6d4e19c --- /dev/null +++ b/api-model-v1-44/docs/HealthConfig.md @@ -0,0 +1,15 @@ + +# HealthConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **test** | **kotlin.collections.MutableList<kotlin.String>** | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional] | +| **interval** | **kotlin.Long** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **timeout** | **kotlin.Long** | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **retries** | **kotlin.Int** | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional] | +| **startPeriod** | **kotlin.Long** | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **startInterval** | **kotlin.Long** | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | + + + diff --git a/api-model-v1-44/docs/HealthcheckResult.md b/api-model-v1-44/docs/HealthcheckResult.md new file mode 100644 index 00000000..1f0ab025 --- /dev/null +++ b/api-model-v1-44/docs/HealthcheckResult.md @@ -0,0 +1,13 @@ + +# HealthcheckResult + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **start** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **end** | **kotlin.String** | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **exitCode** | **kotlin.Int** | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional] | +| **output** | **kotlin.String** | Output from last check | [optional] | + + + diff --git a/api-model-v1-44/docs/HistoryResponseItem.md b/api-model-v1-44/docs/HistoryResponseItem.md new file mode 100644 index 00000000..dbbce217 --- /dev/null +++ b/api-model-v1-44/docs/HistoryResponseItem.md @@ -0,0 +1,15 @@ + +# HistoryResponseItem + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | | +| **created** | **kotlin.Long** | | | +| **createdBy** | **kotlin.String** | | | +| **tags** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **propertySize** | **kotlin.Long** | | | +| **comment** | **kotlin.String** | | | + + + diff --git a/api-model-v1-44/docs/HostConfig.md b/api-model-v1-44/docs/HostConfig.md new file mode 100644 index 00000000..e9466f69 --- /dev/null +++ b/api-model-v1-44/docs/HostConfig.md @@ -0,0 +1,93 @@ + +# HostConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **binds** | **kotlin.collections.MutableList<kotlin.String>** | A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. | [optional] | +| **containerIDFile** | **kotlin.String** | Path to a file where the container ID is written | [optional] | +| **logConfig** | [**HostConfigAllOfLogConfig**](HostConfigAllOfLogConfig.md) | | [optional] | +| **networkMode** | **kotlin.String** | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional] | +| **portBindings** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | +| **autoRemove** | **kotlin.Boolean** | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional] | +| **volumeDriver** | **kotlin.String** | Driver that this container uses to mount volumes. | [optional] | +| **volumesFrom** | **kotlin.collections.MutableList<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | +| **annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional] | +| **capAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] | +| **capDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] | +| **cgroupnsMode** | [**inline**](#CgroupnsMode) | cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. | [optional] | +| **dns** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS servers for the container to use. | [optional] | +| **dnsOptions** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS options. | [optional] | +| **dnsSearch** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS search domains. | [optional] | +| **extraHosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional] | +| **groupAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **ipcMode** | **kotlin.String** | IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:<name|id>\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. | [optional] | +| **cgroup** | **kotlin.String** | Cgroup to use for the container. | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [optional] | +| **oomScoreAdj** | **kotlin.Int** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] | +| **pidMode** | **kotlin.String** | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional] | +| **privileged** | **kotlin.Boolean** | Gives the container full access to the host. | [optional] | +| **publishAllPorts** | **kotlin.Boolean** | Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. | [optional] | +| **readonlyRootfs** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **securityOpt** | **kotlin.collections.MutableList<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] | +| **storageOpt** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] | +| **tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` | [optional] | +| **utSMode** | **kotlin.String** | UTS namespace to use for the container. | [optional] | +| **usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional] | +| **shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [optional] | +| **runtime** | **kotlin.String** | Runtime to use with this container. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the container. (Windows only) | [optional] | +| **maskedPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] | +| **readonlyPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] | + + + +## Enum: CgroupnsMode +| Name | Value | +| ---- | ----- | +| cgroupnsMode | private, host | + + + +## Enum: Isolation +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv, | + + + diff --git a/api-model-v1-44/docs/HostConfigAllOfLogConfig.md b/api-model-v1-44/docs/HostConfigAllOfLogConfig.md new file mode 100644 index 00000000..9b4d0b20 --- /dev/null +++ b/api-model-v1-44/docs/HostConfigAllOfLogConfig.md @@ -0,0 +1,18 @@ + +# HostConfigAllOfLogConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | | [optional] | +| **config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | json-file, syslog, journald, gelf, fluentd, awslogs, splunk, etwlogs, none | + + + diff --git a/api-model-v1-44/docs/IPAM.md b/api-model-v1-44/docs/IPAM.md new file mode 100644 index 00000000..0dcc133a --- /dev/null +++ b/api-model-v1-44/docs/IPAM.md @@ -0,0 +1,12 @@ + +# IPAM + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] | +| **config** | [**kotlin.collections.MutableList<IPAMConfig>**](IPAMConfig.md) | List of IPAM configuration options, specified as a map: ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ``` | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] | + + + diff --git a/api-model-v1-44/docs/IPAMConfig.md b/api-model-v1-44/docs/IPAMConfig.md new file mode 100644 index 00000000..f667c688 --- /dev/null +++ b/api-model-v1-44/docs/IPAMConfig.md @@ -0,0 +1,13 @@ + +# IPAMConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **subnet** | **kotlin.String** | | [optional] | +| **ipRange** | **kotlin.String** | | [optional] | +| **gateway** | **kotlin.String** | | [optional] | +| **auxiliaryAddresses** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/IdResponse.md b/api-model-v1-44/docs/IdResponse.md new file mode 100644 index 00000000..7f34c29a --- /dev/null +++ b/api-model-v1-44/docs/IdResponse.md @@ -0,0 +1,10 @@ + +# IdResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The id of the newly created object. | | + + + diff --git a/api-model-v1-44/docs/ImageConfig.md b/api-model-v1-44/docs/ImageConfig.md new file mode 100644 index 00000000..de8bcb1c --- /dev/null +++ b/api-model-v1-44/docs/ImageConfig.md @@ -0,0 +1,34 @@ + +# ImageConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. <p><br /></p> > **Note**: this field is always empty and must not be used. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. <p><br /></p> > **Note**: this field is always empty and must not be used. | [optional] | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. <p><br /></p> > **Note**: this field is always false and must not be used. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. <p><br /></p> > **Note**: this field is always false and must not be used. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. <p><br /></p> > **Note**: this field is always false and must not be used. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. <p><br /></p> > **Note**: this field is always false and must not be used. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` <p><br /></p> > **Note**: this field is always false and must not be used. | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects. <p><br /></p> > **Note**: this field is always false and must not be used. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. <p><br /></p> > **Note**: this field is always empty and must not be used. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. <p><br /></p> > **Note**: this field is always omitted and must not be used. | [optional] | +| **macAddress** | **kotlin.String** | MAC address of the container. <p><br /></p> > **Deprecated**: this field is deprecated in API v1.44 and up. It is always omitted. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. <p><br /></p> > **Note**: this field is always omitted and must not be used. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageDeleteResponseItem.md b/api-model-v1-44/docs/ImageDeleteResponseItem.md new file mode 100644 index 00000000..a5ea281f --- /dev/null +++ b/api-model-v1-44/docs/ImageDeleteResponseItem.md @@ -0,0 +1,11 @@ + +# ImageDeleteResponseItem + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **untagged** | **kotlin.String** | The image ID of an image that was untagged | [optional] | +| **deleted** | **kotlin.String** | The image ID of an image that was deleted | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageID.md b/api-model-v1-44/docs/ImageID.md new file mode 100644 index 00000000..6717d92f --- /dev/null +++ b/api-model-v1-44/docs/ImageID.md @@ -0,0 +1,10 @@ + +# ImageID + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageInspect.md b/api-model-v1-44/docs/ImageInspect.md new file mode 100644 index 00000000..d47fa9fd --- /dev/null +++ b/api-model-v1-44/docs/ImageInspect.md @@ -0,0 +1,28 @@ + +# ImageInspect + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional] | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **parent** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | [optional] | +| **comment** | **kotlin.String** | Optional message that was set when committing or importing the image. | [optional] | +| **created** | **kotlin.String** | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. | [optional] | +| **container** | **kotlin.String** | The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. | [optional] | +| **containerConfig** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **dockerVersion** | **kotlin.String** | The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. | [optional] | +| **author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional] | +| **config** | [**ImageConfig**](ImageConfig.md) | | [optional] | +| **architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on. | [optional] | +| **variant** | **kotlin.String** | CPU architecture variant (presently ARM-only). | [optional] | +| **os** | **kotlin.String** | Operating System the image is built to run on. | [optional] | +| **osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows). | [optional] | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | [optional] | +| **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | [optional] | +| **rootFS** | [**ImageInspectRootFS**](ImageInspectRootFS.md) | | [optional] | +| **metadata** | [**ImageInspectMetadata**](ImageInspectMetadata.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageInspectMetadata.md b/api-model-v1-44/docs/ImageInspectMetadata.md new file mode 100644 index 00000000..4a2386cd --- /dev/null +++ b/api-model-v1-44/docs/ImageInspectMetadata.md @@ -0,0 +1,10 @@ + +# ImageInspectMetadata + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **lastTagTime** | **kotlin.String** | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageInspectRootFS.md b/api-model-v1-44/docs/ImageInspectRootFS.md new file mode 100644 index 00000000..503e2a52 --- /dev/null +++ b/api-model-v1-44/docs/ImageInspectRootFS.md @@ -0,0 +1,11 @@ + +# ImageInspectRootFS + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | +| **layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ImagePruneResponse.md b/api-model-v1-44/docs/ImagePruneResponse.md new file mode 100644 index 00000000..79320b4a --- /dev/null +++ b/api-model-v1-44/docs/ImagePruneResponse.md @@ -0,0 +1,11 @@ + +# ImagePruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **imagesDeleted** | [**kotlin.collections.MutableList<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageSearchResponseItem.md b/api-model-v1-44/docs/ImageSearchResponseItem.md new file mode 100644 index 00000000..dd28db28 --- /dev/null +++ b/api-model-v1-44/docs/ImageSearchResponseItem.md @@ -0,0 +1,14 @@ + +# ImageSearchResponseItem + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | [optional] | +| **official** | **kotlin.Boolean** | | [optional] | +| **automated** | **kotlin.Boolean** | Whether this repository has automated builds enabled. <p><br /></p> > **Deprecated**: This field is deprecated and will always > be \"false\" in future. | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **starCount** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ImageSummary.md b/api-model-v1-44/docs/ImageSummary.md new file mode 100644 index 00000000..8bd95fe3 --- /dev/null +++ b/api-model-v1-44/docs/ImageSummary.md @@ -0,0 +1,18 @@ + +# ImageSummary + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | | +| **parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | | +| **created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). | | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | | +| **sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. | | +| **containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. | | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | + + + diff --git a/api-model-v1-44/docs/IndexInfo.md b/api-model-v1-44/docs/IndexInfo.md new file mode 100644 index 00000000..6b714641 --- /dev/null +++ b/api-model-v1-44/docs/IndexInfo.md @@ -0,0 +1,13 @@ + +# IndexInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of mirrors, expressed as URIs. | [optional] | +| **secure** | **kotlin.Boolean** | Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. | [optional] | +| **official** | **kotlin.Boolean** | Indicates whether this is an official registry (i.e., Docker Hub / docker.io) | [optional] | + + + diff --git a/api-model-v1-44/docs/JoinTokens.md b/api-model-v1-44/docs/JoinTokens.md new file mode 100644 index 00000000..5055d1c0 --- /dev/null +++ b/api-model-v1-44/docs/JoinTokens.md @@ -0,0 +1,11 @@ + +# JoinTokens + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **worker** | **kotlin.String** | The token workers can use to join the swarm. | [optional] | +| **manager** | **kotlin.String** | The token managers can use to join the swarm. | [optional] | + + + diff --git a/api-model-v1-44/docs/Limit.md b/api-model-v1-44/docs/Limit.md new file mode 100644 index 00000000..09c047eb --- /dev/null +++ b/api-model-v1-44/docs/Limit.md @@ -0,0 +1,12 @@ + +# Limit + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **pids** | **kotlin.Long** | Limits the maximum number of PIDs in the container. Set `0` for unlimited. | [optional] | + + + diff --git a/api-model-v1-44/docs/LocalNodeState.md b/api-model-v1-44/docs/LocalNodeState.md new file mode 100644 index 00000000..addf82f9 --- /dev/null +++ b/api-model-v1-44/docs/LocalNodeState.md @@ -0,0 +1,20 @@ + +# LocalNodeState + +## Enum + + + * `EMPTY` (value: `""`) + + * `Inactive` (value: `"inactive"`) + + * `Pending` (value: `"pending"`) + + * `Active` (value: `"active"`) + + * `Error` (value: `"error"`) + + * `Locked` (value: `"locked"`) + + + diff --git a/api-model-v1-44/docs/ManagerStatus.md b/api-model-v1-44/docs/ManagerStatus.md new file mode 100644 index 00000000..bfaa004e --- /dev/null +++ b/api-model-v1-44/docs/ManagerStatus.md @@ -0,0 +1,12 @@ + +# ManagerStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **leader** | **kotlin.Boolean** | | [optional] | +| **reachability** | [**Reachability**](Reachability.md) | | [optional] | +| **addr** | **kotlin.String** | The IP address and port at which the manager is reachable. | [optional] | + + + diff --git a/api-model-v1-44/docs/Mount.md b/api-model-v1-44/docs/Mount.md new file mode 100644 index 00000000..53eaf65c --- /dev/null +++ b/api-model-v1-44/docs/Mount.md @@ -0,0 +1,24 @@ + +# Mount + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | Container path. | [optional] | +| **source** | **kotlin.String** | Mount source (e.g. a volume name, a host path). | [optional] | +| **type** | [**inline**](#Type) | The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume | [optional] | +| **readOnly** | **kotlin.Boolean** | Whether the mount should be read-only. | [optional] | +| **consistency** | **kotlin.String** | The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. | [optional] | +| **bindOptions** | [**MountBindOptions**](MountBindOptions.md) | | [optional] | +| **volumeOptions** | [**MountVolumeOptions**](MountVolumeOptions.md) | | [optional] | +| **tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | bind, volume, tmpfs, npipe, cluster | + + + diff --git a/api-model-v1-44/docs/MountBindOptions.md b/api-model-v1-44/docs/MountBindOptions.md new file mode 100644 index 00000000..cf0dba27 --- /dev/null +++ b/api-model-v1-44/docs/MountBindOptions.md @@ -0,0 +1,21 @@ + +# MountBindOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propagation** | [**inline**](#Propagation) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] | +| **nonRecursive** | **kotlin.Boolean** | Disable recursive bind mount. | [optional] | +| **createMountpoint** | **kotlin.Boolean** | Create mount point on host if missing | [optional] | +| **readOnlyNonRecursive** | **kotlin.Boolean** | Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction). | [optional] | +| **readOnlyForceRecursive** | **kotlin.Boolean** | Raise an error if the mount cannot be made recursively read-only. | [optional] | + + + +## Enum: Propagation +| Name | Value | +| ---- | ----- | +| propagation | private, rprivate, shared, rshared, slave, rslave | + + + diff --git a/api-model-v1-44/docs/MountPoint.md b/api-model-v1-44/docs/MountPoint.md new file mode 100644 index 00000000..58fe87ce --- /dev/null +++ b/api-model-v1-44/docs/MountPoint.md @@ -0,0 +1,24 @@ + +# MountPoint + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume | [optional] | +| **name** | **kotlin.String** | Name is the name reference to the underlying data defined by `Source` e.g., the volume name. | [optional] | +| **source** | **kotlin.String** | Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. | [optional] | +| **destination** | **kotlin.String** | Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. | [optional] | +| **driver** | **kotlin.String** | Driver is the volume driver used to create the volume (if it is a volume). | [optional] | +| **mode** | **kotlin.String** | Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). | [optional] | +| **RW** | **kotlin.Boolean** | Whether the mount is mounted writable (read-write). | [optional] | +| **propagation** | **kotlin.String** | Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | bind, volume, tmpfs, npipe, cluster | + + + diff --git a/api-model-v1-44/docs/MountTmpfsOptions.md b/api-model-v1-44/docs/MountTmpfsOptions.md new file mode 100644 index 00000000..47a839a1 --- /dev/null +++ b/api-model-v1-44/docs/MountTmpfsOptions.md @@ -0,0 +1,11 @@ + +# MountTmpfsOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **sizeBytes** | **kotlin.Long** | The size for the tmpfs mount in bytes. | [optional] | +| **mode** | **kotlin.Int** | The permission mode for the tmpfs mount in an integer. | [optional] | + + + diff --git a/api-model-v1-44/docs/MountVolumeOptions.md b/api-model-v1-44/docs/MountVolumeOptions.md new file mode 100644 index 00000000..cf000f7f --- /dev/null +++ b/api-model-v1-44/docs/MountVolumeOptions.md @@ -0,0 +1,12 @@ + +# MountVolumeOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **driverConfig** | [**MountVolumeOptionsDriverConfig**](MountVolumeOptionsDriverConfig.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/MountVolumeOptionsDriverConfig.md b/api-model-v1-44/docs/MountVolumeOptionsDriverConfig.md new file mode 100644 index 00000000..3cb98230 --- /dev/null +++ b/api-model-v1-44/docs/MountVolumeOptionsDriverConfig.md @@ -0,0 +1,11 @@ + +# MountVolumeOptionsDriverConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] | + + + diff --git a/api-model-v1-44/docs/Network.md b/api-model-v1-44/docs/Network.md new file mode 100644 index 00000000..53d8acf6 --- /dev/null +++ b/api-model-v1-44/docs/Network.md @@ -0,0 +1,25 @@ + +# Network + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the network. | [optional] | +| **id** | **kotlin.String** | ID that uniquely identifies a network on a single machine. | [optional] | +| **created** | **kotlin.String** | Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **scope** | **kotlin.String** | The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) | [optional] | +| **driver** | **kotlin.String** | The name of the driver used to create the network (e.g. `bridge`, `overlay`). | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Whether the network was created with IPv6 enabled. | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **`internal`** | **kotlin.Boolean** | Whether the network is created to only allow internal networking connectivity. | [optional] | +| **attachable** | **kotlin.Boolean** | Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. | [optional] | +| **ingress** | **kotlin.Boolean** | Whether the network is providing the routing-mesh for the swarm cluster. | [optional] | +| **configFrom** | [**ConfigReference**](ConfigReference.md) | | [optional] | +| **configOnly** | **kotlin.Boolean** | Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. | [optional] | +| **containers** | [**kotlin.collections.MutableMap<kotlin.String, NetworkContainer>**](NetworkContainer.md) | Contains endpoints attached to the network. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network-specific options uses when creating the network. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **peers** | [**kotlin.collections.MutableList<PeerInfo>**](PeerInfo.md) | List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkAttachmentConfig.md b/api-model-v1-44/docs/NetworkAttachmentConfig.md new file mode 100644 index 00000000..3f9c3cc4 --- /dev/null +++ b/api-model-v1-44/docs/NetworkAttachmentConfig.md @@ -0,0 +1,12 @@ + +# NetworkAttachmentConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkConnectRequest.md b/api-model-v1-44/docs/NetworkConnectRequest.md new file mode 100644 index 00000000..ae2c9438 --- /dev/null +++ b/api-model-v1-44/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-v1-44/docs/NetworkContainer.md b/api-model-v1-44/docs/NetworkContainer.md new file mode 100644 index 00000000..5da790f2 --- /dev/null +++ b/api-model-v1-44/docs/NetworkContainer.md @@ -0,0 +1,14 @@ + +# NetworkContainer + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **endpointID** | **kotlin.String** | | [optional] | +| **macAddress** | **kotlin.String** | | [optional] | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkCreateRequest.md b/api-model-v1-44/docs/NetworkCreateRequest.md new file mode 100644 index 00000000..c52c865b --- /dev/null +++ b/api-model-v1-44/docs/NetworkCreateRequest.md @@ -0,0 +1,22 @@ + +# NetworkCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The network's name. | | +| **checkDuplicate** | **kotlin.Boolean** | Deprecated: CheckDuplicate is now always enabled. | [optional] | +| **driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] | +| **scope** | **kotlin.String** | The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level). | [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] | +| **configOnly** | **kotlin.Boolean** | Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. | [optional] | +| **configFrom** | [**ConfigReference**](ConfigReference.md) | | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkCreateResponse.md b/api-model-v1-44/docs/NetworkCreateResponse.md new file mode 100644 index 00000000..319cddb2 --- /dev/null +++ b/api-model-v1-44/docs/NetworkCreateResponse.md @@ -0,0 +1,11 @@ + +# NetworkCreateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created network. | [optional] | +| **warning** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkDisconnectRequest.md b/api-model-v1-44/docs/NetworkDisconnectRequest.md new file mode 100644 index 00000000..c5d297fd --- /dev/null +++ b/api-model-v1-44/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-v1-44/docs/NetworkPruneResponse.md b/api-model-v1-44/docs/NetworkPruneResponse.md new file mode 100644 index 00000000..9458d15f --- /dev/null +++ b/api-model-v1-44/docs/NetworkPruneResponse.md @@ -0,0 +1,10 @@ + +# NetworkPruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkSettings.md b/api-model-v1-44/docs/NetworkSettings.md new file mode 100644 index 00000000..405e34ae --- /dev/null +++ b/api-model-v1-44/docs/NetworkSettings.md @@ -0,0 +1,27 @@ + +# NetworkSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **bridge** | **kotlin.String** | Name of the default bridge interface when dockerd's --bridge flag is set. | [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. Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **linkLocalIPv6PrefixLen** | **kotlin.Int** | Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **ports** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **sandboxKey** | **kotlin.String** | SandboxKey is the full path of the netns handle | [optional] | +| **secondaryIPAddresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **secondaryIPv6Addresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | Deprecated: This field is never set and will be removed in a future release. | [optional] | +| **endpointID** | **kotlin.String** | EndpointID uniquely represents a service endpoint in a Sandbox. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **gateway** | **kotlin.String** | Gateway address for the default \"bridge\" network. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address for the default \"bridge\" network. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Int** | Mask length of the global IPv6 address. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address for the default \"bridge\" network. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address for this network. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the container on the default \"bridge\" network. <p><br /></p> > **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 | [optional] | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [optional] | + + + diff --git a/api-model-v1-44/docs/NetworkingConfig.md b/api-model-v1-44/docs/NetworkingConfig.md new file mode 100644 index 00000000..72814533 --- /dev/null +++ b/api-model-v1-44/docs/NetworkingConfig.md @@ -0,0 +1,10 @@ + +# NetworkingConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. | [optional] | + + + diff --git a/api-model-v1-44/docs/Node.md b/api-model-v1-44/docs/Node.md new file mode 100644 index 00000000..8c180d58 --- /dev/null +++ b/api-model-v1-44/docs/Node.md @@ -0,0 +1,17 @@ + +# Node + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**NodeSpec**](NodeSpec.md) | | [optional] | +| **description** | [**NodeDescription**](NodeDescription.md) | | [optional] | +| **status** | [**NodeStatus**](NodeStatus.md) | | [optional] | +| **managerStatus** | [**ManagerStatus**](ManagerStatus.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/NodeDescription.md b/api-model-v1-44/docs/NodeDescription.md new file mode 100644 index 00000000..9f9e1538 --- /dev/null +++ b/api-model-v1-44/docs/NodeDescription.md @@ -0,0 +1,14 @@ + +# NodeDescription + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | | [optional] | +| **platform** | [**Platform**](Platform.md) | | [optional] | +| **resources** | [**ResourceObject**](ResourceObject.md) | | [optional] | +| **engine** | [**EngineDescription**](EngineDescription.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/NodeSpec.md b/api-model-v1-44/docs/NodeSpec.md new file mode 100644 index 00000000..c4bf3121 --- /dev/null +++ b/api-model-v1-44/docs/NodeSpec.md @@ -0,0 +1,27 @@ + +# NodeSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name for the node. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **role** | [**inline**](#Role) | Role of the node. | [optional] | +| **availability** | [**inline**](#Availability) | Availability of the node. | [optional] | + + + +## Enum: Role +| Name | Value | +| ---- | ----- | +| role | worker, manager | + + + +## Enum: Availability +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | + + + diff --git a/api-model-v1-44/docs/NodeState.md b/api-model-v1-44/docs/NodeState.md new file mode 100644 index 00000000..b075d3fa --- /dev/null +++ b/api-model-v1-44/docs/NodeState.md @@ -0,0 +1,16 @@ + +# NodeState + +## Enum + + + * `Unknown` (value: `"unknown"`) + + * `Down` (value: `"down"`) + + * `Ready` (value: `"ready"`) + + * `Disconnected` (value: `"disconnected"`) + + + diff --git a/api-model-v1-44/docs/NodeStatus.md b/api-model-v1-44/docs/NodeStatus.md new file mode 100644 index 00000000..426c3f2d --- /dev/null +++ b/api-model-v1-44/docs/NodeStatus.md @@ -0,0 +1,12 @@ + +# NodeStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**NodeState**](NodeState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | IP address of the node. | [optional] | + + + diff --git a/api-model-v1-44/docs/OCIDescriptor.md b/api-model-v1-44/docs/OCIDescriptor.md new file mode 100644 index 00000000..76474758 --- /dev/null +++ b/api-model-v1-44/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] | +| **propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] | + + + diff --git a/api-model-v1-44/docs/OCIPlatform.md b/api-model-v1-44/docs/OCIPlatform.md new file mode 100644 index 00000000..606c4124 --- /dev/null +++ b/api-model-v1-44/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.MutableList<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-v1-44/docs/ObjectVersion.md b/api-model-v1-44/docs/ObjectVersion.md new file mode 100644 index 00000000..a2584d76 --- /dev/null +++ b/api-model-v1-44/docs/ObjectVersion.md @@ -0,0 +1,10 @@ + +# ObjectVersion + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **index** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-44/docs/PeerInfo.md b/api-model-v1-44/docs/PeerInfo.md new file mode 100644 index 00000000..b83ec38a --- /dev/null +++ b/api-model-v1-44/docs/PeerInfo.md @@ -0,0 +1,11 @@ + +# PeerInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | ID of the peer-node in the Swarm cluster. | [optional] | +| **IP** | **kotlin.String** | IP-address of the peer-node in the Swarm cluster. | [optional] | + + + diff --git a/api-model-v1-44/docs/PeerNode.md b/api-model-v1-44/docs/PeerNode.md new file mode 100644 index 00000000..e3954b83 --- /dev/null +++ b/api-model-v1-44/docs/PeerNode.md @@ -0,0 +1,11 @@ + +# PeerNode + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **addr** | **kotlin.String** | IP address and ports at which this node can be reached. | [optional] | + + + diff --git a/api-model-v1-44/docs/Platform.md b/api-model-v1-44/docs/Platform.md new file mode 100644 index 00000000..d8a705d2 --- /dev/null +++ b/api-model-v1-44/docs/Platform.md @@ -0,0 +1,11 @@ + +# Platform + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **architecture** | **kotlin.String** | Architecture represents the hardware architecture (for example, `x86_64`). | [optional] | +| **OS** | **kotlin.String** | OS represents the Operating System (for example, `linux` or `windows`). | [optional] | + + + diff --git a/api-model-v1-44/docs/Plugin.md b/api-model-v1-44/docs/Plugin.md new file mode 100644 index 00000000..cd67ed8a --- /dev/null +++ b/api-model-v1-44/docs/Plugin.md @@ -0,0 +1,15 @@ + +# Plugin + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **enabled** | **kotlin.Boolean** | True if the plugin is running. False if the plugin is not running, only installed. | | +| **settings** | [**PluginSettings**](PluginSettings.md) | | | +| **config** | [**PluginConfig**](PluginConfig.md) | | | +| **id** | **kotlin.String** | | [optional] | +| **pluginReference** | **kotlin.String** | plugin remote reference used to push/pull the plugin | [optional] | + + + diff --git a/api-model-v1-44/docs/PluginConfig.md b/api-model-v1-44/docs/PluginConfig.md new file mode 100644 index 00000000..064225fb --- /dev/null +++ b/api-model-v1-44/docs/PluginConfig.md @@ -0,0 +1,25 @@ + +# PluginConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | | +| **documentation** | **kotlin.String** | | | +| **`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **workDir** | **kotlin.String** | | | +| **network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | | +| **linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | | +| **propagatedMount** | **kotlin.String** | | | +| **ipcHost** | **kotlin.Boolean** | | | +| **pidHost** | **kotlin.Boolean** | | | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | [**kotlin.collections.MutableList<PluginEnv>**](PluginEnv.md) | | | +| **args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | | +| **dockerVersion** | **kotlin.String** | Docker Version used to create the plugin | [optional] | +| **user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] | +| **rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/PluginConfigArgs.md b/api-model-v1-44/docs/PluginConfigArgs.md new file mode 100644 index 00000000..77ce533c --- /dev/null +++ b/api-model-v1-44/docs/PluginConfigArgs.md @@ -0,0 +1,13 @@ + +# PluginConfigArgs + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | | + + + diff --git a/api-model-v1-44/docs/PluginConfigInterface.md b/api-model-v1-44/docs/PluginConfigInterface.md new file mode 100644 index 00000000..2c930f60 --- /dev/null +++ b/api-model-v1-44/docs/PluginConfigInterface.md @@ -0,0 +1,19 @@ + +# PluginConfigInterface + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **types** | [**kotlin.collections.MutableList<PluginInterfaceType>**](PluginInterfaceType.md) | | | +| **socket** | **kotlin.String** | | | +| **protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] | + + + +## Enum: ProtocolScheme +| Name | Value | +| ---- | ----- | +| protocolScheme | , moby.plugins.http/v1 | + + + diff --git a/api-model-v1-44/docs/PluginConfigLinux.md b/api-model-v1-44/docs/PluginConfigLinux.md new file mode 100644 index 00000000..f3ca6ce8 --- /dev/null +++ b/api-model-v1-44/docs/PluginConfigLinux.md @@ -0,0 +1,12 @@ + +# PluginConfigLinux + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **allowAllDevices** | **kotlin.Boolean** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | + + + diff --git a/api-model-v1-44/docs/PluginConfigNetwork.md b/api-model-v1-44/docs/PluginConfigNetwork.md new file mode 100644 index 00000000..4b0e40e5 --- /dev/null +++ b/api-model-v1-44/docs/PluginConfigNetwork.md @@ -0,0 +1,10 @@ + +# PluginConfigNetwork + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | + + + diff --git a/api-model-v1-44/docs/PluginConfigRootfs.md b/api-model-v1-44/docs/PluginConfigRootfs.md new file mode 100644 index 00000000..4f17530b --- /dev/null +++ b/api-model-v1-44/docs/PluginConfigRootfs.md @@ -0,0 +1,11 @@ + +# PluginConfigRootfs + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/PluginConfigUser.md b/api-model-v1-44/docs/PluginConfigUser.md new file mode 100644 index 00000000..1d3973c2 --- /dev/null +++ b/api-model-v1-44/docs/PluginConfigUser.md @@ -0,0 +1,11 @@ + +# PluginConfigUser + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **UID** | **kotlin.Int** | | [optional] | +| **GID** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-44/docs/PluginDevice.md b/api-model-v1-44/docs/PluginDevice.md new file mode 100644 index 00000000..9ca354a5 --- /dev/null +++ b/api-model-v1-44/docs/PluginDevice.md @@ -0,0 +1,13 @@ + +# PluginDevice + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **path** | **kotlin.String** | | | + + + diff --git a/api-model-v1-44/docs/PluginEnv.md b/api-model-v1-44/docs/PluginEnv.md new file mode 100644 index 00000000..ff31d08b --- /dev/null +++ b/api-model-v1-44/docs/PluginEnv.md @@ -0,0 +1,13 @@ + +# PluginEnv + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.String** | | | + + + diff --git a/api-model-v1-44/docs/PluginInterfaceType.md b/api-model-v1-44/docs/PluginInterfaceType.md new file mode 100644 index 00000000..de46fee9 --- /dev/null +++ b/api-model-v1-44/docs/PluginInterfaceType.md @@ -0,0 +1,12 @@ + +# PluginInterfaceType + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **prefix** | **kotlin.String** | | | +| **capability** | **kotlin.String** | | | +| **version** | **kotlin.String** | | | + + + diff --git a/api-model-v1-44/docs/PluginMount.md b/api-model-v1-44/docs/PluginMount.md new file mode 100644 index 00000000..77eaf741 --- /dev/null +++ b/api-model-v1-44/docs/PluginMount.md @@ -0,0 +1,16 @@ + +# PluginMount + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **source** | **kotlin.String** | | | +| **destination** | **kotlin.String** | | | +| **type** | **kotlin.String** | | | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | | | + + + diff --git a/api-model-v1-44/docs/PluginPrivilege.md b/api-model-v1-44/docs/PluginPrivilege.md new file mode 100644 index 00000000..5c384bb6 --- /dev/null +++ b/api-model-v1-44/docs/PluginPrivilege.md @@ -0,0 +1,12 @@ + +# PluginPrivilege + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **description** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/PluginSettings.md b/api-model-v1-44/docs/PluginSettings.md new file mode 100644 index 00000000..1797e9c5 --- /dev/null +++ b/api-model-v1-44/docs/PluginSettings.md @@ -0,0 +1,13 @@ + +# PluginSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | + + + diff --git a/api-model-v1-44/docs/PluginsInfo.md b/api-model-v1-44/docs/PluginsInfo.md new file mode 100644 index 00000000..6f726d26 --- /dev/null +++ b/api-model-v1-44/docs/PluginsInfo.md @@ -0,0 +1,13 @@ + +# PluginsInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volume** | **kotlin.collections.MutableList<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] | +| **network** | **kotlin.collections.MutableList<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] | +| **authorization** | **kotlin.collections.MutableList<kotlin.String>** | Names of available authorization plugins. | [optional] | +| **log** | **kotlin.collections.MutableList<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] | + + + diff --git a/api-model-v1-44/docs/Port.md b/api-model-v1-44/docs/Port.md new file mode 100644 index 00000000..5f73834c --- /dev/null +++ b/api-model-v1-44/docs/Port.md @@ -0,0 +1,20 @@ + +# Port + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privatePort** | **kotlin.Int** | Port on the container | | +| **type** | [**inline**](#Type) | | | +| **IP** | **kotlin.String** | Host IP address that the container's port is mapped to | [optional] | +| **publicPort** | **kotlin.Int** | Port exposed on the host | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | tcp, udp, sctp | + + + diff --git a/api-model-v1-44/docs/PortBinding.md b/api-model-v1-44/docs/PortBinding.md new file mode 100644 index 00000000..0cf0dea5 --- /dev/null +++ b/api-model-v1-44/docs/PortBinding.md @@ -0,0 +1,11 @@ + +# PortBinding + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostIp** | **kotlin.String** | Host IP address that the container's port is mapped to. | [optional] | +| **hostPort** | **kotlin.String** | Host port number that the container's port is mapped to. | [optional] | + + + diff --git a/api-model-v1-44/docs/PortStatus.md b/api-model-v1-44/docs/PortStatus.md new file mode 100644 index 00000000..24def5e3 --- /dev/null +++ b/api-model-v1-44/docs/PortStatus.md @@ -0,0 +1,10 @@ + +# PortStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ProcessConfig.md b/api-model-v1-44/docs/ProcessConfig.md new file mode 100644 index 00000000..921ea328 --- /dev/null +++ b/api-model-v1-44/docs/ProcessConfig.md @@ -0,0 +1,14 @@ + +# ProcessConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privileged** | **kotlin.Boolean** | | [optional] | +| **user** | **kotlin.String** | | [optional] | +| **tty** | **kotlin.Boolean** | | [optional] | +| **entrypoint** | **kotlin.String** | | [optional] | +| **arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ProgressDetail.md b/api-model-v1-44/docs/ProgressDetail.md new file mode 100644 index 00000000..17d327a3 --- /dev/null +++ b/api-model-v1-44/docs/ProgressDetail.md @@ -0,0 +1,11 @@ + +# ProgressDetail + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **current** | **kotlin.Int** | | [optional] | +| **total** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-44/docs/PushImageInfo.md b/api-model-v1-44/docs/PushImageInfo.md new file mode 100644 index 00000000..35a5e13f --- /dev/null +++ b/api-model-v1-44/docs/PushImageInfo.md @@ -0,0 +1,13 @@ + +# PushImageInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **error** | **kotlin.String** | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progress** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/Reachability.md b/api-model-v1-44/docs/Reachability.md new file mode 100644 index 00000000..a33ce341 --- /dev/null +++ b/api-model-v1-44/docs/Reachability.md @@ -0,0 +1,14 @@ + +# Reachability + +## Enum + + + * `Unknown` (value: `"unknown"`) + + * `Unreachable` (value: `"unreachable"`) + + * `Reachable` (value: `"reachable"`) + + + diff --git a/api-model-v1-44/docs/RegistryServiceConfig.md b/api-model-v1-44/docs/RegistryServiceConfig.md new file mode 100644 index 00000000..78fa73e0 --- /dev/null +++ b/api-model-v1-44/docs/RegistryServiceConfig.md @@ -0,0 +1,14 @@ + +# RegistryServiceConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **allowNondistributableArtifactsCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). <p><br /></p> > **Deprecated**: Pushing nondistributable artifacts is now always enabled > and this field is always `null`. | [optional] | +| **allowNondistributableArtifactsHostnames** | **kotlin.collections.MutableList<kotlin.String>** | List of registry hostnames to which nondistributable artifacts can be pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. <p><br /></p> > **Deprecated**: Pushing nondistributable artifacts is now always enabled > and this field is always `null`. | [optional] | +| **insecureRegistryCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. | [optional] | +| **indexConfigs** | [**kotlin.collections.MutableMap<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] | + + + diff --git a/api-model-v1-44/docs/ResourceObject.md b/api-model-v1-44/docs/ResourceObject.md new file mode 100644 index 00000000..b4652bf8 --- /dev/null +++ b/api-model-v1-44/docs/ResourceObject.md @@ -0,0 +1,12 @@ + +# ResourceObject + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | + + + diff --git a/api-model-v1-44/docs/Resources.md b/api-model-v1-44/docs/Resources.md new file mode 100644 index 00000000..f18a199b --- /dev/null +++ b/api-model-v1-44/docs/Resources.md @@ -0,0 +1,40 @@ + +# Resources + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | + + + diff --git a/api-model-v1-44/docs/ResourcesBlkioWeightDeviceInner.md b/api-model-v1-44/docs/ResourcesBlkioWeightDeviceInner.md new file mode 100644 index 00000000..8adad1d4 --- /dev/null +++ b/api-model-v1-44/docs/ResourcesBlkioWeightDeviceInner.md @@ -0,0 +1,11 @@ + +# ResourcesBlkioWeightDeviceInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | | [optional] | +| **weight** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ResourcesUlimitsInner.md b/api-model-v1-44/docs/ResourcesUlimitsInner.md new file mode 100644 index 00000000..8ad484f1 --- /dev/null +++ b/api-model-v1-44/docs/ResourcesUlimitsInner.md @@ -0,0 +1,12 @@ + +# ResourcesUlimitsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of ulimit | [optional] | +| **soft** | **kotlin.Int** | Soft limit | [optional] | +| **hard** | **kotlin.Int** | Hard limit | [optional] | + + + diff --git a/api-model-v1-44/docs/RestartPolicy.md b/api-model-v1-44/docs/RestartPolicy.md new file mode 100644 index 00000000..09a0e982 --- /dev/null +++ b/api-model-v1-44/docs/RestartPolicy.md @@ -0,0 +1,18 @@ + +# RestartPolicy + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | [**inline**](#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 | [optional] | +| **maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] | + + + +## Enum: Name +| Name | Value | +| ---- | ----- | +| name | , no, always, unless-stopped, on-failure | + + + diff --git a/api-model-v1-44/docs/Runtime.md b/api-model-v1-44/docs/Runtime.md new file mode 100644 index 00000000..e244ad7c --- /dev/null +++ b/api-model-v1-44/docs/Runtime.md @@ -0,0 +1,12 @@ + +# Runtime + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] | +| **status** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | + + + diff --git a/api-model-v1-44/docs/Secret.md b/api-model-v1-44/docs/Secret.md new file mode 100644 index 00000000..9a87a568 --- /dev/null +++ b/api-model-v1-44/docs/Secret.md @@ -0,0 +1,14 @@ + +# Secret + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**SecretSpec**](SecretSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SecretCreateRequest.md b/api-model-v1-44/docs/SecretCreateRequest.md new file mode 100644 index 00000000..ee3cbab0 --- /dev/null +++ b/api-model-v1-44/docs/SecretCreateRequest.md @@ -0,0 +1,14 @@ + +# SecretCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SecretSpec.md b/api-model-v1-44/docs/SecretSpec.md new file mode 100644 index 00000000..bd4a7229 --- /dev/null +++ b/api-model-v1-44/docs/SecretSpec.md @@ -0,0 +1,14 @@ + +# SecretSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/Service.md b/api-model-v1-44/docs/Service.md new file mode 100644 index 00000000..d2e0c3c9 --- /dev/null +++ b/api-model-v1-44/docs/Service.md @@ -0,0 +1,18 @@ + +# Service + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ServiceSpec**](ServiceSpec.md) | | [optional] | +| **endpoint** | [**ServiceEndpoint**](ServiceEndpoint.md) | | [optional] | +| **updateStatus** | [**ServiceUpdateStatus**](ServiceUpdateStatus.md) | | [optional] | +| **serviceStatus** | [**ServiceServiceStatus**](ServiceServiceStatus.md) | | [optional] | +| **jobStatus** | [**ServiceJobStatus**](ServiceJobStatus.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceCreateRequest.md b/api-model-v1-44/docs/ServiceCreateRequest.md new file mode 100644 index 00000000..e13b9730 --- /dev/null +++ b/api-model-v1-44/docs/ServiceCreateRequest.md @@ -0,0 +1,17 @@ + +# ServiceCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceCreateResponse.md b/api-model-v1-44/docs/ServiceCreateResponse.md new file mode 100644 index 00000000..bccceaa6 --- /dev/null +++ b/api-model-v1-44/docs/ServiceCreateResponse.md @@ -0,0 +1,11 @@ + +# ServiceCreateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the created service. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceEndpoint.md b/api-model-v1-44/docs/ServiceEndpoint.md new file mode 100644 index 00000000..e0f1c900 --- /dev/null +++ b/api-model-v1-44/docs/ServiceEndpoint.md @@ -0,0 +1,12 @@ + +# ServiceEndpoint + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | +| **virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPsInner>**](ServiceEndpointVirtualIPsInner.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceEndpointVirtualIPsInner.md b/api-model-v1-44/docs/ServiceEndpointVirtualIPsInner.md new file mode 100644 index 00000000..f893c9c6 --- /dev/null +++ b/api-model-v1-44/docs/ServiceEndpointVirtualIPsInner.md @@ -0,0 +1,11 @@ + +# ServiceEndpointVirtualIPsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkID** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceJobStatus.md b/api-model-v1-44/docs/ServiceJobStatus.md new file mode 100644 index 00000000..8227bff6 --- /dev/null +++ b/api-model-v1-44/docs/ServiceJobStatus.md @@ -0,0 +1,11 @@ + +# ServiceJobStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **lastExecution** | **kotlin.String** | The last time, as observed by the server, that this job was started. | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceServiceStatus.md b/api-model-v1-44/docs/ServiceServiceStatus.md new file mode 100644 index 00000000..79fd1de2 --- /dev/null +++ b/api-model-v1-44/docs/ServiceServiceStatus.md @@ -0,0 +1,12 @@ + +# ServiceServiceStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **runningTasks** | **kotlin.Int** | The number of tasks for the service currently in the Running state. | [optional] | +| **desiredTasks** | **kotlin.Int** | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. | [optional] | +| **completedTasks** | **kotlin.Int** | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceSpec.md b/api-model-v1-44/docs/ServiceSpec.md new file mode 100644 index 00000000..2c5c547c --- /dev/null +++ b/api-model-v1-44/docs/ServiceSpec.md @@ -0,0 +1,17 @@ + +# ServiceSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceSpecMode.md b/api-model-v1-44/docs/ServiceSpecMode.md new file mode 100644 index 00000000..7b9ddebd --- /dev/null +++ b/api-model-v1-44/docs/ServiceSpecMode.md @@ -0,0 +1,13 @@ + +# ServiceSpecMode + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicated** | [**ServiceSpecModeReplicated**](ServiceSpecModeReplicated.md) | | [optional] | +| **global** | [**kotlin.Any**](.md) | | [optional] | +| **replicatedJob** | [**ServiceSpecModeReplicatedJob**](ServiceSpecModeReplicatedJob.md) | | [optional] | +| **globalJob** | [**kotlin.Any**](.md) | The mode used for services which run a task to the completed state on each valid node. | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceSpecModeReplicated.md b/api-model-v1-44/docs/ServiceSpecModeReplicated.md new file mode 100644 index 00000000..9e2617c0 --- /dev/null +++ b/api-model-v1-44/docs/ServiceSpecModeReplicated.md @@ -0,0 +1,10 @@ + +# ServiceSpecModeReplicated + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicas** | **kotlin.Long** | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceSpecModeReplicatedJob.md b/api-model-v1-44/docs/ServiceSpecModeReplicatedJob.md new file mode 100644 index 00000000..215cf92f --- /dev/null +++ b/api-model-v1-44/docs/ServiceSpecModeReplicatedJob.md @@ -0,0 +1,11 @@ + +# ServiceSpecModeReplicatedJob + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **maxConcurrent** | **kotlin.Long** | The maximum number of replicas to run simultaneously. | [optional] | +| **totalCompletions** | **kotlin.Long** | The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceSpecRollbackConfig.md b/api-model-v1-44/docs/ServiceSpecRollbackConfig.md new file mode 100644 index 00000000..109ce61a --- /dev/null +++ b/api-model-v1-44/docs/ServiceSpecRollbackConfig.md @@ -0,0 +1,29 @@ + +# ServiceSpecRollbackConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between rollback iterations, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each rolled back task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | + + + +## Enum: FailureAction +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause | + + + +## Enum: Order +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | + + + diff --git a/api-model-v1-44/docs/ServiceSpecUpdateConfig.md b/api-model-v1-44/docs/ServiceSpecUpdateConfig.md new file mode 100644 index 00000000..b8a267a7 --- /dev/null +++ b/api-model-v1-44/docs/ServiceSpecUpdateConfig.md @@ -0,0 +1,29 @@ + +# ServiceSpecUpdateConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between updates, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an updated task fails to run, or stops running during the update. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each updated task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | + + + +## Enum: FailureAction +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause, rollback | + + + +## Enum: Order +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | + + + diff --git a/api-model-v1-44/docs/ServiceUpdateRequest.md b/api-model-v1-44/docs/ServiceUpdateRequest.md new file mode 100644 index 00000000..17c4c804 --- /dev/null +++ b/api-model-v1-44/docs/ServiceUpdateRequest.md @@ -0,0 +1,17 @@ + +# ServiceUpdateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceUpdateResponse.md b/api-model-v1-44/docs/ServiceUpdateResponse.md new file mode 100644 index 00000000..d131f923 --- /dev/null +++ b/api-model-v1-44/docs/ServiceUpdateResponse.md @@ -0,0 +1,10 @@ + +# ServiceUpdateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] | + + + diff --git a/api-model-v1-44/docs/ServiceUpdateStatus.md b/api-model-v1-44/docs/ServiceUpdateStatus.md new file mode 100644 index 00000000..be528d9c --- /dev/null +++ b/api-model-v1-44/docs/ServiceUpdateStatus.md @@ -0,0 +1,20 @@ + +# ServiceUpdateStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**inline**](#State) | | [optional] | +| **startedAt** | **kotlin.String** | | [optional] | +| **completedAt** | **kotlin.String** | | [optional] | +| **message** | **kotlin.String** | | [optional] | + + + +## Enum: State +| Name | Value | +| ---- | ----- | +| state | updating, paused, completed | + + + diff --git a/api-model-v1-44/docs/Swarm.md b/api-model-v1-44/docs/Swarm.md new file mode 100644 index 00000000..6c752000 --- /dev/null +++ b/api-model-v1-44/docs/Swarm.md @@ -0,0 +1,20 @@ + +# Swarm + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [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, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | +| **joinTokens** | [**JoinTokens**](JoinTokens.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmInfo.md b/api-model-v1-44/docs/SwarmInfo.md new file mode 100644 index 00000000..cb655c0b --- /dev/null +++ b/api-model-v1-44/docs/SwarmInfo.md @@ -0,0 +1,18 @@ + +# SwarmInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **nodeAddr** | **kotlin.String** | IP address at which this node can be reached by other nodes in the swarm. | [optional] | +| **localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] | +| **controlAvailable** | **kotlin.Boolean** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **remoteManagers** | [**kotlin.collections.MutableList<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [optional] | +| **nodes** | **kotlin.Int** | Total number of nodes in the swarm. | [optional] | +| **managers** | **kotlin.Int** | Total number of managers in the swarm. | [optional] | +| **cluster** | [**ClusterInfo**](ClusterInfo.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmInitRequest.md b/api-model-v1-44/docs/SwarmInitRequest.md new file mode 100644 index 00000000..f4503ae3 --- /dev/null +++ b/api-model-v1-44/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.MutableList<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-v1-44/docs/SwarmJoinRequest.md b/api-model-v1-44/docs/SwarmJoinRequest.md new file mode 100644 index 00000000..854e0fc2 --- /dev/null +++ b/api-model-v1-44/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.MutableList<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-v1-44/docs/SwarmSpec.md b/api-model-v1-44/docs/SwarmSpec.md new file mode 100644 index 00000000..55042008 --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpec.md @@ -0,0 +1,17 @@ + +# SwarmSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the swarm. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **orchestration** | [**SwarmSpecOrchestration**](SwarmSpecOrchestration.md) | | [optional] | +| **raft** | [**SwarmSpecRaft**](SwarmSpecRaft.md) | | [optional] | +| **dispatcher** | [**SwarmSpecDispatcher**](SwarmSpecDispatcher.md) | | [optional] | +| **caConfig** | [**SwarmSpecCAConfig**](SwarmSpecCAConfig.md) | | [optional] | +| **encryptionConfig** | [**SwarmSpecEncryptionConfig**](SwarmSpecEncryptionConfig.md) | | [optional] | +| **taskDefaults** | [**SwarmSpecTaskDefaults**](SwarmSpecTaskDefaults.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecCAConfig.md b/api-model-v1-44/docs/SwarmSpecCAConfig.md new file mode 100644 index 00000000..72a0dca2 --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecCAConfig.md @@ -0,0 +1,14 @@ + +# SwarmSpecCAConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] | +| **externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAsInner>**](SwarmSpecCAConfigExternalCAsInner.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] | +| **signingCACert** | **kotlin.String** | The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **signingCAKey** | **kotlin.String** | The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **forceRotate** | **kotlin.Int** | An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecCAConfigExternalCAsInner.md b/api-model-v1-44/docs/SwarmSpecCAConfigExternalCAsInner.md new file mode 100644 index 00000000..d4e29b6c --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecCAConfigExternalCAsInner.md @@ -0,0 +1,20 @@ + +# SwarmSpecCAConfigExternalCAsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **protocol** | [**inline**](#Protocol) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] | +| **URL** | **kotlin.String** | URL where certificate signing requests should be sent. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [optional] | +| **caCert** | **kotlin.String** | The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). | [optional] | + + + +## Enum: Protocol +| Name | Value | +| ---- | ----- | +| protocol | cfssl | + + + diff --git a/api-model-v1-44/docs/SwarmSpecDispatcher.md b/api-model-v1-44/docs/SwarmSpecDispatcher.md new file mode 100644 index 00000000..281781e0 --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecDispatcher.md @@ -0,0 +1,10 @@ + +# SwarmSpecDispatcher + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **heartbeatPeriod** | **kotlin.Long** | The delay for an agent to send a heartbeat to the dispatcher. | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecEncryptionConfig.md b/api-model-v1-44/docs/SwarmSpecEncryptionConfig.md new file mode 100644 index 00000000..f26480bf --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecEncryptionConfig.md @@ -0,0 +1,10 @@ + +# SwarmSpecEncryptionConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **autoLockManagers** | **kotlin.Boolean** | If set, generate a key and use it to lock data stored on the managers. | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecOrchestration.md b/api-model-v1-44/docs/SwarmSpecOrchestration.md new file mode 100644 index 00000000..1152816f --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecOrchestration.md @@ -0,0 +1,10 @@ + +# SwarmSpecOrchestration + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **taskHistoryRetentionLimit** | **kotlin.Long** | The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecRaft.md b/api-model-v1-44/docs/SwarmSpecRaft.md new file mode 100644 index 00000000..c31ecfa2 --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecRaft.md @@ -0,0 +1,14 @@ + +# SwarmSpecRaft + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **snapshotInterval** | **kotlin.Int** | The number of log entries between snapshots. | [optional] | +| **keepOldSnapshots** | **kotlin.Int** | The number of snapshots to keep beyond the current snapshot. | [optional] | +| **logEntriesForSlowFollowers** | **kotlin.Int** | The number of log entries to keep around to sync up slow followers after a snapshot is created. | [optional] | +| **electionTick** | **kotlin.Int** | The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | +| **heartbeatTick** | **kotlin.Int** | The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecTaskDefaults.md b/api-model-v1-44/docs/SwarmSpecTaskDefaults.md new file mode 100644 index 00000000..acb39d26 --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecTaskDefaults.md @@ -0,0 +1,10 @@ + +# SwarmSpecTaskDefaults + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **logDriver** | [**SwarmSpecTaskDefaultsLogDriver**](SwarmSpecTaskDefaultsLogDriver.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmSpecTaskDefaultsLogDriver.md b/api-model-v1-44/docs/SwarmSpecTaskDefaultsLogDriver.md new file mode 100644 index 00000000..e1b7526f --- /dev/null +++ b/api-model-v1-44/docs/SwarmSpecTaskDefaultsLogDriver.md @@ -0,0 +1,11 @@ + +# SwarmSpecTaskDefaultsLogDriver + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selected log driver, specified as key/value pairs. | [optional] | + + + diff --git a/api-model-v1-44/docs/SwarmUnlockRequest.md b/api-model-v1-44/docs/SwarmUnlockRequest.md new file mode 100644 index 00000000..0f2b14e8 --- /dev/null +++ b/api-model-v1-44/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-v1-44/docs/SystemAuthResponse.md b/api-model-v1-44/docs/SystemAuthResponse.md new file mode 100644 index 00000000..8681c17e --- /dev/null +++ b/api-model-v1-44/docs/SystemAuthResponse.md @@ -0,0 +1,11 @@ + +# SystemAuthResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | **kotlin.String** | The status of the authentication | | +| **identityToken** | **kotlin.String** | An opaque token used to authenticate a user after a successful login | [optional] | + + + diff --git a/api-model-v1-44/docs/SystemDataUsageResponse.md b/api-model-v1-44/docs/SystemDataUsageResponse.md new file mode 100644 index 00000000..36515e99 --- /dev/null +++ b/api-model-v1-44/docs/SystemDataUsageResponse.md @@ -0,0 +1,14 @@ + +# SystemDataUsageResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **layersSize** | **kotlin.Long** | | [optional] | +| **images** | [**kotlin.collections.MutableList<ImageSummary>**](ImageSummary.md) | | [optional] | +| **containers** | [**kotlin.collections.MutableList<ContainerSummary>**](ContainerSummary.md) | | [optional] | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | | [optional] | +| **buildCache** | [**kotlin.collections.MutableList<BuildCache>**](BuildCache.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/SystemInfo.md b/api-model-v1-44/docs/SystemInfo.md new file mode 100644 index 00000000..675ed224 --- /dev/null +++ b/api-model-v1-44/docs/SystemInfo.md @@ -0,0 +1,91 @@ + +# SystemInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique identifier of the daemon. <p><br /></p> > **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. | [optional] | +| **containers** | **kotlin.Int** | Total number of containers on the host. | [optional] | +| **containersRunning** | **kotlin.Int** | Number of containers with status `\"running\"`. | [optional] | +| **containersPaused** | **kotlin.Int** | Number of containers with status `\"paused\"`. | [optional] | +| **containersStopped** | **kotlin.Int** | Number of containers with status `\"stopped\"`. | [optional] | +| **images** | **kotlin.Int** | Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. | [optional] | +| **driver** | **kotlin.String** | Name of the storage driver in use. | [optional] | +| **driverStatus** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | +| **dockerRootDir** | **kotlin.String** | Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. | [optional] | +| **plugins** | [**PluginsInfo**](PluginsInfo.md) | | [optional] | +| **memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. | [optional] | +| **swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. | [optional] | +| **kernelMemoryTCP** | **kotlin.Boolean** | Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. | [optional] | +| **cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | [optional] | +| **cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | [optional] | +| **cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host. | [optional] | +| **cpUSet** | **kotlin.Boolean** | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) | [optional] | +| **pidsLimit** | **kotlin.Boolean** | Indicates if the host kernel has PID limit support enabled. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Indicates if OOM killer disable is supported on the host. | [optional] | +| **ipv4Forwarding** | **kotlin.Boolean** | Indicates IPv4 forwarding is enabled. | [optional] | +| **bridgeNfIptables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-iptables` is available on the host. | [optional] | +| **bridgeNfIp6tables** | **kotlin.Boolean** | Indicates if `bridge-nf-call-ip6tables` is available on the host. | [optional] | +| **debug** | **kotlin.Boolean** | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | [optional] | +| **nfd** | **kotlin.Int** | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | [optional] | +| **ngoroutines** | **kotlin.Int** | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | [optional] | +| **systemTime** | **kotlin.String** | Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **loggingDriver** | **kotlin.String** | The logging driver to use as a default for new containers. | [optional] | +| **cgroupDriver** | [**inline**](#CgroupDriver) | The driver to use for managing cgroups. | [optional] | +| **cgroupVersion** | [**inline**](#CgroupVersion) | The version of the cgroup. | [optional] | +| **neventsListener** | **kotlin.Int** | Number of event listeners subscribed. | [optional] | +| **kernelVersion** | **kotlin.String** | Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd> registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. | [optional] | +| **operatingSystem** | **kotlin.String** | Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" | [optional] | +| **osVersion** | **kotlin.String** | Version of the host's operating system <p><br /></p> > **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. | [optional] | +| **osType** | **kotlin.String** | Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **architecture** | **kotlin.String** | Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **NCPU** | **kotlin.Int** | The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | [optional] | +| **memTotal** | **kotlin.Long** | Total amount of physical memory available on the host, in bytes. | [optional] | +| **indexServerAddress** | **kotlin.String** | Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | [optional] | +| **registryConfig** | [**RegistryServiceConfig**](RegistryServiceConfig.md) | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **httpProxy** | **kotlin.String** | HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **httpsProxy** | **kotlin.String** | HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **noProxy** | **kotlin.String** | Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. | [optional] | +| **name** | **kotlin.String** | Hostname of the host. | [optional] | +| **labels** | **kotlin.collections.MutableList<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. | [optional] | +| **runtimes** | [**kotlin.collections.MutableMap<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] | +| **defaultRuntime** | **kotlin.String** | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | [optional] | +| **swarm** | [**SwarmInfo**](SwarmInfo.md) | | [optional] | +| **liveRestoreEnabled** | **kotlin.Boolean** | Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | [optional] | +| **isolation** | [**inline**](#Isolation) | Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. | [optional] | +| **initBinary** | **kotlin.String** | Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **containerdCommit** | [**Commit**](Commit.md) | | [optional] | +| **runcCommit** | [**Commit**](Commit.md) | | [optional] | +| **initCommit** | [**Commit**](Commit.md) | | [optional] | +| **securityOptions** | **kotlin.collections.MutableList<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [optional] | +| **productLicense** | **kotlin.String** | Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | [optional] | +| **defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner>**](SystemInfoDefaultAddressPoolsInner.md) | List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | [optional] | +| **cdISpecDirs** | **kotlin.collections.MutableList<kotlin.String>** | List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. | [optional] | + + + +## Enum: CgroupDriver +| Name | Value | +| ---- | ----- | +| cgroupDriver | cgroupfs, systemd, none | + + + +## Enum: CgroupVersion +| Name | Value | +| ---- | ----- | +| cgroupVersion | 1, 2 | + + + +## Enum: Isolation +| Name | Value | +| ---- | ----- | +| isolation | default, hyperv, process, | + + + diff --git a/api-model-v1-44/docs/SystemInfoDefaultAddressPoolsInner.md b/api-model-v1-44/docs/SystemInfoDefaultAddressPoolsInner.md new file mode 100644 index 00000000..1db98475 --- /dev/null +++ b/api-model-v1-44/docs/SystemInfoDefaultAddressPoolsInner.md @@ -0,0 +1,11 @@ + +# SystemInfoDefaultAddressPoolsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **base** | **kotlin.String** | The network address in CIDR format | [optional] | +| **propertySize** | **kotlin.Int** | The network pool size | [optional] | + + + diff --git a/api-model-v1-44/docs/SystemVersion.md b/api-model-v1-44/docs/SystemVersion.md new file mode 100644 index 00000000..cead3f34 --- /dev/null +++ b/api-model-v1-44/docs/SystemVersion.md @@ -0,0 +1,21 @@ + +# SystemVersion + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] | +| **components** | [**kotlin.collections.MutableList<SystemVersionComponentsInner>**](SystemVersionComponentsInner.md) | Information about system components | [optional] | +| **version** | **kotlin.String** | The version of the daemon | [optional] | +| **apiVersion** | **kotlin.String** | The default (and highest) API version that is supported by the daemon | [optional] | +| **minAPIVersion** | **kotlin.String** | The minimum API version that is supported by the daemon | [optional] | +| **gitCommit** | **kotlin.String** | The Git commit of the source code that was used to build the daemon | [optional] | +| **goVersion** | **kotlin.String** | The version Go used to compile the daemon, and the version of the Go runtime in use. | [optional] | +| **os** | **kotlin.String** | The operating system that the daemon is running on (\"linux\" or \"windows\") | [optional] | +| **arch** | **kotlin.String** | The architecture that the daemon is running on | [optional] | +| **kernelVersion** | **kotlin.String** | The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. | [optional] | +| **experimental** | **kotlin.Boolean** | Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. | [optional] | +| **buildTime** | **kotlin.String** | The date and time that the daemon was compiled. | [optional] | + + + diff --git a/api-model-v1-44/docs/SystemVersionComponentsInner.md b/api-model-v1-44/docs/SystemVersionComponentsInner.md new file mode 100644 index 00000000..804428ca --- /dev/null +++ b/api-model-v1-44/docs/SystemVersionComponentsInner.md @@ -0,0 +1,12 @@ + +# SystemVersionComponentsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the component | | +| **version** | **kotlin.String** | Version of the component | | +| **details** | [**kotlin.Any**](.md) | Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. | [optional] | + + + diff --git a/api-model-v1-44/docs/SystemVersionPlatform.md b/api-model-v1-44/docs/SystemVersionPlatform.md new file mode 100644 index 00000000..285b4a47 --- /dev/null +++ b/api-model-v1-44/docs/SystemVersionPlatform.md @@ -0,0 +1,10 @@ + +# SystemVersionPlatform + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | + + + diff --git a/api-model-v1-44/docs/TLSInfo.md b/api-model-v1-44/docs/TLSInfo.md new file mode 100644 index 00000000..27168d2c --- /dev/null +++ b/api-model-v1-44/docs/TLSInfo.md @@ -0,0 +1,12 @@ + +# TLSInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **trustRoot** | **kotlin.String** | The root CA certificate(s) that are used to validate leaf TLS certificates. | [optional] | +| **certIssuerSubject** | **kotlin.String** | The base64-url-safe-encoded raw subject bytes of the issuer. | [optional] | +| **certIssuerPublicKey** | **kotlin.String** | The base64-url-safe-encoded raw public key bytes of the issuer. | [optional] | + + + diff --git a/api-model-v1-44/docs/Task.md b/api-model-v1-44/docs/Task.md new file mode 100644 index 00000000..f68e5e2f --- /dev/null +++ b/api-model-v1-44/docs/Task.md @@ -0,0 +1,23 @@ + +# Task + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the task. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | Name of the task. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **spec** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **serviceID** | **kotlin.String** | The ID of the service this task is part of. | [optional] | +| **slot** | **kotlin.Int** | | [optional] | +| **nodeID** | **kotlin.String** | The ID of the node that this task is on. | [optional] | +| **assignedGenericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **status** | [**TaskStatus**](TaskStatus.md) | | [optional] | +| **desiredState** | [**TaskState**](TaskState.md) | | [optional] | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpec.md b/api-model-v1-44/docs/TaskSpec.md new file mode 100644 index 00000000..bf55bec5 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpec.md @@ -0,0 +1,19 @@ + +# TaskSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pluginSpec** | [**TaskSpecPluginSpec**](TaskSpecPluginSpec.md) | | [optional] | +| **containerSpec** | [**TaskSpecContainerSpec**](TaskSpecContainerSpec.md) | | [optional] | +| **networkAttachmentSpec** | [**TaskSpecNetworkAttachmentSpec**](TaskSpecNetworkAttachmentSpec.md) | | [optional] | +| **resources** | [**TaskSpecResources**](TaskSpecResources.md) | | [optional] | +| **restartPolicy** | [**TaskSpecRestartPolicy**](TaskSpecRestartPolicy.md) | | [optional] | +| **placement** | [**TaskSpecPlacement**](TaskSpecPlacement.md) | | [optional] | +| **forceUpdate** | **kotlin.Int** | A counter that triggers an update even if no relevant parameters have been changed. | [optional] | +| **runtime** | **kotlin.String** | Runtime is the type of runtime specified for the task executor. | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] | +| **logDriver** | [**TaskSpecLogDriver**](TaskSpecLogDriver.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpec.md b/api-model-v1-44/docs/TaskSpecContainerSpec.md new file mode 100644 index 00000000..7d4be537 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpec.md @@ -0,0 +1,43 @@ + +# TaskSpecContainerSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **image** | **kotlin.String** | The image name to use for the container | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] | +| **command** | **kotlin.collections.MutableList<kotlin.String>** | The command to be run in the image. | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | Arguments to the command. | [optional] | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [optional] | +| **dir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **user** | **kotlin.String** | The user inside the container. | [optional] | +| **groups** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **privileges** | [**TaskSpecContainerSpecPrivileges**](TaskSpecContainerSpecPrivileges.md) | | [optional] | +| **TTY** | **kotlin.Boolean** | Whether a pseudo-TTY should be allocated. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **readOnly** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop the container. | [optional] | +| **stopGracePeriod** | **kotlin.Long** | Amount of time to wait for the container to terminate before forcefully killing it. | [optional] | +| **healthCheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **hosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] | [optional] | +| **dnSConfig** | [**TaskSpecContainerSpecDNSConfig**](TaskSpecContainerSpecDNSConfig.md) | | [optional] | +| **secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecretsInner>**](TaskSpecContainerSpecSecretsInner.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] | +| **configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigsInner>**](TaskSpecContainerSpecConfigsInner.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the containers running the service. (Windows only) | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. | [optional] | +| **capabilityAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] | +| **capabilityDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] | + + + +## Enum: Isolation +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv, | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecConfigsInner.md b/api-model-v1-44/docs/TaskSpecContainerSpecConfigsInner.md new file mode 100644 index 00000000..b3fd4ce2 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecConfigsInner.md @@ -0,0 +1,13 @@ + +# TaskSpecContainerSpecConfigsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecConfigsInnerFile**](TaskSpecContainerSpecConfigsInnerFile.md) | | [optional] | +| **runtime** | [**kotlin.Any**](.md) | Runtime represents a target that is not mounted into the container but is used by the task <p><br /><p> > **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive | [optional] | +| **configID** | **kotlin.String** | ConfigID represents the ID of the specific config that we're referencing. | [optional] | +| **configName** | **kotlin.String** | ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecConfigsInnerFile.md b/api-model-v1-44/docs/TaskSpecContainerSpecConfigsInnerFile.md new file mode 100644 index 00000000..8d06a999 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecConfigsInnerFile.md @@ -0,0 +1,13 @@ + +# TaskSpecContainerSpecConfigsInnerFile + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecDNSConfig.md b/api-model-v1-44/docs/TaskSpecContainerSpecDNSConfig.md new file mode 100644 index 00000000..e2f2192a --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecDNSConfig.md @@ -0,0 +1,12 @@ + +# TaskSpecContainerSpecDNSConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nameservers** | **kotlin.collections.MutableList<kotlin.String>** | The IP addresses of the name servers. | [optional] | +| **search** | **kotlin.collections.MutableList<kotlin.String>** | A search list for host-name lookup. | [optional] | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecPrivileges.md b/api-model-v1-44/docs/TaskSpecContainerSpecPrivileges.md new file mode 100644 index 00000000..03edb15c --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecPrivileges.md @@ -0,0 +1,14 @@ + +# TaskSpecContainerSpecPrivileges + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **credentialSpec** | [**TaskSpecContainerSpecPrivilegesCredentialSpec**](TaskSpecContainerSpecPrivilegesCredentialSpec.md) | | [optional] | +| **seLinuxContext** | [**TaskSpecContainerSpecPrivilegesSELinuxContext**](TaskSpecContainerSpecPrivilegesSELinuxContext.md) | | [optional] | +| **seccomp** | [**TaskSpecContainerSpecPrivilegesSeccomp**](TaskSpecContainerSpecPrivilegesSeccomp.md) | | [optional] | +| **appArmor** | [**TaskSpecContainerSpecPrivilegesAppArmor**](TaskSpecContainerSpecPrivilegesAppArmor.md) | | [optional] | +| **noNewPrivileges** | **kotlin.Boolean** | Configuration of the no_new_privs bit in the container | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesAppArmor.md b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesAppArmor.md new file mode 100644 index 00000000..9551f4bc --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesAppArmor.md @@ -0,0 +1,17 @@ + +# TaskSpecContainerSpecPrivilegesAppArmor + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | | [optional] | + + + +## Enum: Mode +| Name | Value | +| ---- | ----- | +| mode | default, disabled | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md new file mode 100644 index 00000000..427e0c31 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md @@ -0,0 +1,12 @@ + +# TaskSpecContainerSpecPrivilegesCredentialSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **config** | **kotlin.String** | Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **file** | **kotlin.String** | Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **registry** | **kotlin.String** | Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs` <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md new file mode 100644 index 00000000..996b8470 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md @@ -0,0 +1,14 @@ + +# TaskSpecContainerSpecPrivilegesSELinuxContext + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **disable** | **kotlin.Boolean** | Disable SELinux | [optional] | +| **user** | **kotlin.String** | SELinux user label | [optional] | +| **role** | **kotlin.String** | SELinux role label | [optional] | +| **type** | **kotlin.String** | SELinux type label | [optional] | +| **level** | **kotlin.String** | SELinux level label | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesSeccomp.md b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesSeccomp.md new file mode 100644 index 00000000..8eb1cf79 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecPrivilegesSeccomp.md @@ -0,0 +1,18 @@ + +# TaskSpecContainerSpecPrivilegesSeccomp + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | | [optional] | +| **profile** | **kotlin.String** | The custom seccomp profile as a json object | [optional] | + + + +## Enum: Mode +| Name | Value | +| ---- | ----- | +| mode | default, unconfined, custom | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecSecretsInner.md b/api-model-v1-44/docs/TaskSpecContainerSpecSecretsInner.md new file mode 100644 index 00000000..11d5721e --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecSecretsInner.md @@ -0,0 +1,12 @@ + +# TaskSpecContainerSpecSecretsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecSecretsInnerFile**](TaskSpecContainerSpecSecretsInnerFile.md) | | [optional] | +| **secretID** | **kotlin.String** | SecretID represents the ID of the specific secret that we're referencing. | [optional] | +| **secretName** | **kotlin.String** | SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecContainerSpecSecretsInnerFile.md b/api-model-v1-44/docs/TaskSpecContainerSpecSecretsInnerFile.md new file mode 100644 index 00000000..c90d914f --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecContainerSpecSecretsInnerFile.md @@ -0,0 +1,13 @@ + +# TaskSpecContainerSpecSecretsInnerFile + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecLogDriver.md b/api-model-v1-44/docs/TaskSpecLogDriver.md new file mode 100644 index 00000000..be81c423 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecLogDriver.md @@ -0,0 +1,11 @@ + +# TaskSpecLogDriver + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecNetworkAttachmentSpec.md b/api-model-v1-44/docs/TaskSpecNetworkAttachmentSpec.md new file mode 100644 index 00000000..ae098a2f --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecNetworkAttachmentSpec.md @@ -0,0 +1,10 @@ + +# TaskSpecNetworkAttachmentSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | ID of the container represented by this task | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecPlacement.md b/api-model-v1-44/docs/TaskSpecPlacement.md new file mode 100644 index 00000000..0b5caddb --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecPlacement.md @@ -0,0 +1,13 @@ + +# TaskSpecPlacement + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **constraints** | **kotlin.collections.MutableList<kotlin.String>** | An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). | [optional] | +| **preferences** | [**kotlin.collections.MutableList<TaskSpecPlacementPreferencesInner>**](TaskSpecPlacementPreferencesInner.md) | Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. | [optional] | +| **maxReplicas** | **kotlin.Long** | Maximum number of replicas for per node (default value is 0, which is unlimited) | [optional] | +| **platforms** | [**kotlin.collections.MutableList<Platform>**](Platform.md) | Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecPlacementPreferencesInner.md b/api-model-v1-44/docs/TaskSpecPlacementPreferencesInner.md new file mode 100644 index 00000000..2894f7e5 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecPlacementPreferencesInner.md @@ -0,0 +1,10 @@ + +# TaskSpecPlacementPreferencesInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spread** | [**TaskSpecPlacementPreferencesInnerSpread**](TaskSpecPlacementPreferencesInnerSpread.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecPlacementPreferencesInnerSpread.md b/api-model-v1-44/docs/TaskSpecPlacementPreferencesInnerSpread.md new file mode 100644 index 00000000..9643c6ae --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecPlacementPreferencesInnerSpread.md @@ -0,0 +1,10 @@ + +# TaskSpecPlacementPreferencesInnerSpread + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spreadDescriptor** | **kotlin.String** | label descriptor, such as `engine.labels.az`. | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecPluginSpec.md b/api-model-v1-44/docs/TaskSpecPluginSpec.md new file mode 100644 index 00000000..45eb9382 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecPluginSpec.md @@ -0,0 +1,13 @@ + +# TaskSpecPluginSpec + +## Properties +| 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.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecResources.md b/api-model-v1-44/docs/TaskSpecResources.md new file mode 100644 index 00000000..531e9943 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecResources.md @@ -0,0 +1,11 @@ + +# TaskSpecResources + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **limits** | [**Limit**](Limit.md) | | [optional] | +| **reservations** | [**ResourceObject**](ResourceObject.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/TaskSpecRestartPolicy.md b/api-model-v1-44/docs/TaskSpecRestartPolicy.md new file mode 100644 index 00000000..d139ec81 --- /dev/null +++ b/api-model-v1-44/docs/TaskSpecRestartPolicy.md @@ -0,0 +1,20 @@ + +# TaskSpecRestartPolicy + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **condition** | [**inline**](#Condition) | Condition for restart. | [optional] | +| **delay** | **kotlin.Long** | Delay between restart attempts. | [optional] | +| **maxAttempts** | **kotlin.Long** | Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). | [optional] | +| **window** | **kotlin.Long** | Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). | [optional] | + + + +## Enum: Condition +| Name | Value | +| ---- | ----- | +| condition | none, on-failure, any | + + + diff --git a/api-model-v1-44/docs/TaskState.md b/api-model-v1-44/docs/TaskState.md new file mode 100644 index 00000000..5652eb48 --- /dev/null +++ b/api-model-v1-44/docs/TaskState.md @@ -0,0 +1,38 @@ + +# TaskState + +## Enum + + + * `New` (value: `"new"`) + + * `Allocated` (value: `"allocated"`) + + * `Pending` (value: `"pending"`) + + * `Assigned` (value: `"assigned"`) + + * `Accepted` (value: `"accepted"`) + + * `Preparing` (value: `"preparing"`) + + * `Ready` (value: `"ready"`) + + * `Starting` (value: `"starting"`) + + * `Running` (value: `"running"`) + + * `Complete` (value: `"complete"`) + + * `Shutdown` (value: `"shutdown"`) + + * `Failed` (value: `"failed"`) + + * `Rejected` (value: `"rejected"`) + + * `Remove` (value: `"remove"`) + + * `Orphaned` (value: `"orphaned"`) + + + diff --git a/api-model-v1-44/docs/TaskStatus.md b/api-model-v1-44/docs/TaskStatus.md new file mode 100644 index 00000000..347db437 --- /dev/null +++ b/api-model-v1-44/docs/TaskStatus.md @@ -0,0 +1,15 @@ + +# TaskStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **timestamp** | **kotlin.String** | | [optional] | +| **state** | [**TaskState**](TaskState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **err** | **kotlin.String** | | [optional] | +| **containerStatus** | [**ContainerStatus**](ContainerStatus.md) | | [optional] | +| **portStatus** | [**PortStatus**](PortStatus.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/ThrottleDevice.md b/api-model-v1-44/docs/ThrottleDevice.md new file mode 100644 index 00000000..a4dbeb34 --- /dev/null +++ b/api-model-v1-44/docs/ThrottleDevice.md @@ -0,0 +1,11 @@ + +# ThrottleDevice + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Device path | [optional] | +| **rate** | **kotlin.Long** | Rate | [optional] | + + + diff --git a/api-model-v1-44/docs/UnlockKeyResponse.md b/api-model-v1-44/docs/UnlockKeyResponse.md new file mode 100644 index 00000000..e530f063 --- /dev/null +++ b/api-model-v1-44/docs/UnlockKeyResponse.md @@ -0,0 +1,10 @@ + +# UnlockKeyResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] | + + + diff --git a/api-model-v1-44/docs/Volume.md b/api-model-v1-44/docs/Volume.md new file mode 100644 index 00000000..25fce51e --- /dev/null +++ b/api-model-v1-44/docs/Volume.md @@ -0,0 +1,26 @@ + +# Volume + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the volume. | | +| **driver** | **kotlin.String** | Name of the volume driver used by the volume. | | +| **mountpoint** | **kotlin.String** | Mount path of the volume on the host. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | | +| **createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] | +| **status** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | [optional] | +| **clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] | +| **usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] | + + + +## Enum: Scope +| Name | Value | +| ---- | ----- | +| scope | local, global | + + + diff --git a/api-model-v1-44/docs/VolumeCreateOptions.md b/api-model-v1-44/docs/VolumeCreateOptions.md new file mode 100644 index 00000000..e6402768 --- /dev/null +++ b/api-model-v1-44/docs/VolumeCreateOptions.md @@ -0,0 +1,14 @@ + +# VolumeCreateOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The new volume's name. If not specified, Docker generates a name. | [optional] | +| **driver** | **kotlin.String** | Name of the volume driver to use. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **clusterVolumeSpec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/VolumeListResponse.md b/api-model-v1-44/docs/VolumeListResponse.md new file mode 100644 index 00000000..832e8349 --- /dev/null +++ b/api-model-v1-44/docs/VolumeListResponse.md @@ -0,0 +1,11 @@ + +# VolumeListResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | [optional] | + + + diff --git a/api-model-v1-44/docs/VolumePruneResponse.md b/api-model-v1-44/docs/VolumePruneResponse.md new file mode 100644 index 00000000..e1b6e248 --- /dev/null +++ b/api-model-v1-44/docs/VolumePruneResponse.md @@ -0,0 +1,11 @@ + +# VolumePruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Volumes that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-44/docs/VolumeUpdateRequest.md b/api-model-v1-44/docs/VolumeUpdateRequest.md new file mode 100644 index 00000000..8988303b --- /dev/null +++ b/api-model-v1-44/docs/VolumeUpdateRequest.md @@ -0,0 +1,10 @@ + +# VolumeUpdateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | + + + diff --git a/api-model-v1-44/docs/VolumeUsageData.md b/api-model-v1-44/docs/VolumeUsageData.md new file mode 100644 index 00000000..442e3a02 --- /dev/null +++ b/api-model-v1-44/docs/VolumeUsageData.md @@ -0,0 +1,11 @@ + +# VolumeUsageData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | | +| **refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | | + + + diff --git a/api-model-v1-44/openapi-generator-config.yaml b/api-model-v1-44/openapi-generator-config.yaml new file mode 100644 index 00000000..8e856927 --- /dev/null +++ b/api-model-v1-44/openapi-generator-config.yaml @@ -0,0 +1,19 @@ +inputSpec: https://docs.docker.com/reference/api/engine/version/v1.44/ +additionalProperties: + hideGenerationTimestamp: true +generatorName: kotlin +packageName: de.gesellix.docker.remote.api +#invokerPackage: de.gesellix.docker.remote.invoker +apiPackage: de.gesellix.docker.remote.client.api +modelPackage: de.gesellix.docker.remote.api +enumPropertyNaming: PascalCase +nameMappings: + is_official: official + is_automated: automated +groupId: de.gesellix +artifactId: docker-remote-api-model +artifactVersion: 1.44 +outputDir: api-model-v1-44 +dateLibrary: java8 +moshiCodeGen: true +modelMutable: true diff --git a/api-model-v1-44/src/main/java/.gitkeep b/api-model-v1-44/src/main/java/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt new file mode 100644 index 00000000..241b422a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Address represents an IPv4 or IPv6 IP address. + * + * @param addr IP address. + * @param prefixLen Mask length of the IP address. + */ +@JsonClass(generateAdapter = true) +data class Address( + // IP address. + @Json(name = "Addr") + var addr: kotlin.String? = null, + // Mask length of the IP address. + @Json(name = "PrefixLen") + var prefixLen: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt new file mode 100644 index 00000000..1f61c3b7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt @@ -0,0 +1,40 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param username + * @param password + * @param email Email is an optional value associated with the username. > **Deprecated**: This field is deprecated since docker 1.11 (API v1.23) and will be removed in a future release. + * @param serveraddress + */ +@JsonClass(generateAdapter = true) +data class AuthConfig( + @Json(name = "username") + var username: kotlin.String? = null, + @Json(name = "password") + var password: kotlin.String? = null, + // Email is an optional value associated with the username. > **Deprecated**: This field is deprecated since docker 1.11 (API v1.23) and will be removed in a future release. + @Json(name = "email") + var email: kotlin.String? = null, + @Json(name = "serveraddress") + var serveraddress: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt new file mode 100644 index 00000000..80a48034 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt @@ -0,0 +1,92 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * BuildCache contains information about a build cache record. + * + * @param ID Unique ID of the build cache record. + * @param parents List of parent build cache record IDs. + * @param type Cache record type. + * @param description Description of the build-step that produced the build cache. + * @param inUse Indicates if the build cache is in use. + * @param shared Indicates if the build cache is shared. + * @param propertySize Amount of disk space used by the build cache (in bytes). + * @param createdAt Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param lastUsedAt Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param usageCount + */ +@JsonClass(generateAdapter = true) +data class BuildCache( + // Unique ID of the build cache record. + @Json(name = "ID") + var ID: kotlin.String? = null, + // List of parent build cache record IDs. + @Json(name = "Parents") + var parents: kotlin.collections.MutableList? = null, + // Cache record type. + @Json(name = "Type") + var type: BuildCache.Type? = null, + // Description of the build-step that produced the build cache. + @Json(name = "Description") + var description: kotlin.String? = null, + // Indicates if the build cache is in use. + @Json(name = "InUse") + var inUse: kotlin.Boolean? = null, + // Indicates if the build cache is shared. + @Json(name = "Shared") + var shared: kotlin.Boolean? = null, + // Amount of disk space used by the build cache (in bytes). + @Json(name = "Size") + var propertySize: kotlin.Int? = null, + // Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "LastUsedAt") + var lastUsedAt: kotlin.String? = null, + @Json(name = "UsageCount") + var usageCount: kotlin.Int? = null, +) { + /** + * Cache record type. + * + * Values: Internal,Frontend,SourcePeriodLocal,SourcePeriodGitPeriodCheckout,ExecPeriodCachemount,Regular + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "internal") + Internal("internal"), + + @Json(name = "frontend") + Frontend("frontend"), + + @Json(name = "source.local") + SourcePeriodLocal("source.local"), + + @Json(name = "source.git.checkout") + SourcePeriodGitPeriodCheckout("source.git.checkout"), + + @Json(name = "exec.cachemount") + ExecPeriodCachemount("exec.cachemount"), + + @Json(name = "regular") + Regular("regular"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt new file mode 100644 index 00000000..8deed701 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id + * @param stream + * @param error + * @param errorDetail + * @param status + * @param progress + * @param progressDetail + * @param aux + */ +@JsonClass(generateAdapter = true) +data class BuildInfo( + @Json(name = "id") + var id: kotlin.String? = null, + @Json(name = "stream") + var stream: kotlin.String? = null, + @Json(name = "error") + var error: kotlin.String? = null, + @Json(name = "errorDetail") + var errorDetail: ErrorDetail? = null, + @Json(name = "status") + var status: kotlin.String? = null, + @Json(name = "progress") + var progress: kotlin.String? = null, + @Json(name = "progressDetail") + var progressDetail: ProgressDetail? = null, + @Json(name = "aux") + var aux: ImageID? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt new file mode 100644 index 00000000..b0be3cb6 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param cachesDeleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class BuildPruneResponse( + @Json(name = "CachesDeleted") + var cachesDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt new file mode 100644 index 00000000..c76d0e50 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt @@ -0,0 +1,65 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Kind of change Can be one of: - `0`: Modified (\"C\") - `1`: Added (\"A\") - `2`: Deleted (\"D\") + * + * Values: T0,T1,T2 + */ + +@JsonClass(generateAdapter = false) +enum class ChangeType(val value: kotlin.Int) { + @Json(name = "0") + T0(0), + + @Json(name = "1") + T1(1), + + @Json(name = "2") + T2(2), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value.toString() + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is ChangeType) "$data" else null + + /** + * Returns a valid [ChangeType] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): ChangeType? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt new file mode 100644 index 00000000..15db9529 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt @@ -0,0 +1,64 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ClusterInfo represents information about the swarm as is returned by the \"/info\" endpoint. Join-tokens are not included. + * + * @param ID The ID of the swarm. + * @param version + * @param createdAt Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param updatedAt Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param spec + * @param tlSInfo + * @param rootRotationInProgress Whether there is currently a root CA rotation in progress for the swarm + * @param dataPathPort 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, the default port (4789) is used. + * @param defaultAddrPool Default Address Pool specifies default subnet pools for global scope networks. + * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. + */ +@JsonClass(generateAdapter = true) +data class ClusterInfo( + // The ID of the swarm. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + // Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: SwarmSpec? = null, + @Json(name = "TLSInfo") + var tlSInfo: TLSInfo? = null, + // Whether there is currently a root CA rotation in progress for the swarm + @Json(name = "RootRotationInProgress") + var rootRotationInProgress: kotlin.Boolean? = null, + // 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, the default port (4789) is used. + @Json(name = "DataPathPort") + var dataPathPort: kotlin.Int? = null, + // Default Address Pool specifies default subnet pools for global scope networks. + @Json(name = "DefaultAddrPool") + var defaultAddrPool: kotlin.collections.MutableList? = null, + // SubnetSize specifies the subnet size of the networks created from the default subnet pool. + @Json(name = "SubnetSize") + var subnetSize: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt new file mode 100644 index 00000000..3056cbe3 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt @@ -0,0 +1,50 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Options and information specific to, and only present on, Swarm CSI cluster volumes. + * + * @param ID The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. + * @param version + * @param createdAt + * @param updatedAt + * @param spec + * @param info + * @param publishStatus The status of the volume as it pertains to its publishing and use on specific nodes + */ +@JsonClass(generateAdapter = true) +data class ClusterVolume( + // The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: ClusterVolumeSpec? = null, + @Json(name = "Info") + var info: ClusterVolumeInfo? = null, + // The status of the volume as it pertains to its publishing and use on specific nodes + @Json(name = "PublishStatus") + var publishStatus: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt new file mode 100644 index 00000000..020c0822 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the global status of the volume. + * + * @param capacityBytes The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. + * @param volumeContext A map of strings to strings returned from the storage plugin when the volume is created. + * @param volumeID The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. + * @param accessibleTopology The topology this volume is actually accessible from. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeInfo( + // The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. + @Json(name = "CapacityBytes") + var capacityBytes: kotlin.Long? = null, + // A map of strings to strings returned from the storage plugin when the volume is created. + @Json(name = "VolumeContext") + var volumeContext: kotlin.collections.MutableMap? = null, + // The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. + @Json(name = "VolumeID") + var volumeID: kotlin.String? = null, + // The topology this volume is actually accessible from. + @Json(name = "AccessibleTopology") + var accessibleTopology: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt new file mode 100644 index 00000000..2bdb091b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param nodeID The ID of the Swarm node the volume is published on. + * @param state The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + * @param publishContext A map of strings to strings returned by the CSI controller plugin when a volume is published. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumePublishStatusInner( + // The ID of the Swarm node the volume is published on. + @Json(name = "NodeID") + var nodeID: kotlin.String? = null, + // The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + @Json(name = "State") + var state: ClusterVolumePublishStatusInner.State? = null, + // A map of strings to strings returned by the CSI controller plugin when a volume is published. + @Json(name = "PublishContext") + var publishContext: kotlin.collections.MutableMap? = null, +) { + /** + * The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + * + * Values: PendingPublish,Published,PendingNodeUnpublish,PendingControllerUnpublish + */ + @JsonClass(generateAdapter = false) + enum class State(val value: kotlin.String) { + @Json(name = "pending-publish") + PendingPublish("pending-publish"), + + @Json(name = "published") + Published("published"), + + @Json(name = "pending-node-unpublish") + PendingNodeUnpublish("pending-node-unpublish"), + + @Json(name = "pending-controller-unpublish") + PendingControllerUnpublish("pending-controller-unpublish"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt new file mode 100644 index 00000000..ee4034cc --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Cluster-specific options used to create the volume. + * + * @param group Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. + * @param accessMode + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpec( + // Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. + @Json(name = "Group") + var group: kotlin.String? = null, + @Json(name = "AccessMode") + var accessMode: ClusterVolumeSpecAccessMode? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt new file mode 100644 index 00000000..75c554ec --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt @@ -0,0 +1,104 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Defines how the volume is used by tasks. + * + * @param scope The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. + * @param sharing The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. + * @param mountVolume Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. + * @param secrets Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. + * @param accessibilityRequirements + * @param capacityRange + * @param availability The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessMode( + // The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. + @Json(name = "Scope") + var scope: ClusterVolumeSpecAccessMode.Scope? = Scope.Single, + // The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. + @Json(name = "Sharing") + var sharing: ClusterVolumeSpecAccessMode.Sharing? = Sharing.None, + // Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. + @Json(name = "MountVolume") + var mountVolume: kotlin.Any? = null, + // Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. + @Json(name = "Secrets") + var secrets: kotlin.collections.MutableList? = null, + @Json(name = "AccessibilityRequirements") + var accessibilityRequirements: ClusterVolumeSpecAccessModeAccessibilityRequirements? = null, + @Json(name = "CapacityRange") + var capacityRange: ClusterVolumeSpecAccessModeCapacityRange? = null, + // The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + @Json(name = "Availability") + var availability: ClusterVolumeSpecAccessMode.Availability? = Availability.Active, +) { + /** + * The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. + * + * Values: Single,Multi + */ + @JsonClass(generateAdapter = false) + enum class Scope(val value: kotlin.String) { + @Json(name = "single") + Single("single"), + + @Json(name = "multi") + Multi("multi"), + } + + /** + * The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. + * + * Values: None,Readonly,Onewriter,All + */ + @JsonClass(generateAdapter = false) + enum class Sharing(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "readonly") + Readonly("readonly"), + + @Json(name = "onewriter") + Onewriter("onewriter"), + + @Json(name = "all") + All("all"), + } + + /** + * The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + * + * Values: Active,Pause,Drain + */ + @JsonClass(generateAdapter = false) + enum class Availability(val value: kotlin.String) { + @Json(name = "active") + Active("active"), + + @Json(name = "pause") + Pause("pause"), + + @Json(name = "drain") + Drain("drain"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt new file mode 100644 index 00000000..c3768ebc --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Requirements for the accessible topology of the volume. These fields are optional. For an in-depth description of what these fields mean, see the CSI specification. + * + * @param requisite A list of required topologies, at least one of which the volume must be accessible from. + * @param preferred A list of topologies that the volume should attempt to be provisioned in. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessModeAccessibilityRequirements( + // A list of required topologies, at least one of which the volume must be accessible from. + @Json(name = "Requisite") + var requisite: kotlin.collections.MutableList>? = null, + // A list of topologies that the volume should attempt to be provisioned in. + @Json(name = "Preferred") + var preferred: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt new file mode 100644 index 00000000..96340413 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity. + * + * @param requiredBytes The volume must be at least this big. The value of 0 indicates an unspecified minimum + * @param limitBytes The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessModeCapacityRange( + // The volume must be at least this big. The value of 0 indicates an unspecified minimum + @Json(name = "RequiredBytes") + var requiredBytes: kotlin.Long? = null, + // The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. + @Json(name = "LimitBytes") + var limitBytes: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt new file mode 100644 index 00000000..d6a4f13f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * One cluster volume secret entry. Defines a key-value pair that is passed to the plugin. + * + * @param key Key is the name of the key of the key-value pair passed to the plugin. + * @param secret Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessModeSecretsInner( + // Key is the name of the key of the key-value pair passed to the plugin. + @Json(name = "Key") + var key: kotlin.String? = null, + // Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. + @Json(name = "Secret") + var secret: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt new file mode 100644 index 00000000..77ce7446 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`. + * + * @param ID Actual commit ID of external tool. + * @param expected Commit ID of external tool expected by dockerd as set at build time. + */ +@JsonClass(generateAdapter = true) +data class Commit( + // Actual commit ID of external tool. + @Json(name = "ID") + var ID: kotlin.String? = null, + // Commit ID of external tool expected by dockerd as set at build time. + @Json(name = "Expected") + var expected: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt new file mode 100644 index 00000000..d1ac38ed --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt + * @param updatedAt + * @param spec + */ +@JsonClass(generateAdapter = true) +data class Config( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: ConfigSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt new file mode 100644 index 00000000..2551f34c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the config. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + * @param templating + */ +@JsonClass(generateAdapter = true) +data class ConfigCreateRequest( + // User-defined name of the config. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt new file mode 100644 index 00000000..5bd0bdd8 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The config-only network source to provide the configuration for this network. + * + * @param network The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. + */ +@JsonClass(generateAdapter = true) +data class ConfigReference( + // The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. + @Json(name = "Network") + var network: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt new file mode 100644 index 00000000..20ae0c3b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the config. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + * @param templating + */ +@JsonClass(generateAdapter = true) +data class ConfigSpec( + // User-defined name of the config. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt new file mode 100644 index 00000000..a1ac7b41 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt @@ -0,0 +1,126 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Configuration for a container that is portable between hosts. When used as `ContainerConfig` field in an image, `ContainerConfig` is an optional field containing the configuration of the container that was last committed when creating the image. Previous versions of Docker builder used this field to store build cache, and it is not in active use anymore. + * + * @param hostname The hostname to use for the container, as a valid RFC 1123 hostname. + * @param domainname The domain name to use for the container. + * @param user The user that commands are run as inside the container. + * @param attachStdin Whether to attach to `stdin`. + * @param attachStdout Whether to attach to `stdout`. + * @param attachStderr Whether to attach to `stderr`. + * @param exposedPorts An object mapping ports to an empty object in the form: `{\"/\": {}}` + * @param tty Attach standard streams to a TTY, including `stdin` if it is not closed. + * @param openStdin Open `stdin` + * @param stdinOnce Close `stdin` after one attached client disconnects + * @param env A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + * @param cmd Command to run specified as a string or an array of strings. + * @param healthcheck + * @param argsEscaped Command is already escaped (Windows only) + * @param image The name (or reference) of the image to use when creating the container, or which was used when the container was created. + * @param volumes An object mapping mount point paths inside the container to empty objects. + * @param workingDir The working directory for commands to run in. + * @param entrypoint The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + * @param networkDisabled Disable networking for the container. + * @param macAddress MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. + * @param onBuild `ONBUILD` metadata that were defined in the image's `Dockerfile`. + * @param labels User-defined key/value metadata. + * @param stopSignal Signal to stop a container as a string or unsigned integer. + * @param stopTimeout Timeout to stop a container in seconds. + * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + */ +@JsonClass(generateAdapter = true) +data class ContainerConfig( + // The hostname to use for the container, as a valid RFC 1123 hostname. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // The domain name to use for the container. + @Json(name = "Domainname") + var domainname: kotlin.String? = null, + // The user that commands are run as inside the container. + @Json(name = "User") + var user: kotlin.String? = null, + // Whether to attach to `stdin`. + @Json(name = "AttachStdin") + var attachStdin: kotlin.Boolean? = false, + // Whether to attach to `stdout`. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = true, + // Whether to attach to `stderr`. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = true, + // An object mapping ports to an empty object in the form: `{\"/\": {}}` + @Json(name = "ExposedPorts") + var exposedPorts: kotlin.collections.MutableMap? = null, + // Attach standard streams to a TTY, including `stdin` if it is not closed. + @Json(name = "Tty") + var tty: kotlin.Boolean? = false, + // Open `stdin` + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = false, + // Close `stdin` after one attached client disconnects + @Json(name = "StdinOnce") + var stdinOnce: kotlin.Boolean? = false, + // A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run specified as a string or an array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + @Json(name = "Healthcheck") + var healthcheck: HealthConfig? = null, + // Command is already escaped (Windows only) + @Json(name = "ArgsEscaped") + var argsEscaped: kotlin.Boolean? = null, + // The name (or reference) of the image to use when creating the container, or which was used when the container was created. + @Json(name = "Image") + var image: kotlin.String? = null, + // An object mapping mount point paths inside the container to empty objects. + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableMap? = null, + // The working directory for commands to run in. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, + // The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList? = null, + // Disable networking for the container. + @Json(name = "NetworkDisabled") + var networkDisabled: kotlin.Boolean? = null, + // MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + // `ONBUILD` metadata that were defined in the image's `Dockerfile`. + @Json(name = "OnBuild") + var onBuild: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Signal to stop a container as a string or unsigned integer. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = "SIGTERM", + // Timeout to stop a container in seconds. + @Json(name = "StopTimeout") + var stopTimeout: kotlin.Int? = null, + // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + @Json(name = "Shell") + var shell: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt new file mode 100644 index 00000000..425d73ce --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt @@ -0,0 +1,132 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param hostname The hostname to use for the container, as a valid RFC 1123 hostname. + * @param domainname The domain name to use for the container. + * @param user The user that commands are run as inside the container. + * @param attachStdin Whether to attach to `stdin`. + * @param attachStdout Whether to attach to `stdout`. + * @param attachStderr Whether to attach to `stderr`. + * @param exposedPorts An object mapping ports to an empty object in the form: `{\"/\": {}}` + * @param tty Attach standard streams to a TTY, including `stdin` if it is not closed. + * @param openStdin Open `stdin` + * @param stdinOnce Close `stdin` after one attached client disconnects + * @param env A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + * @param cmd Command to run specified as a string or an array of strings. + * @param healthcheck + * @param argsEscaped Command is already escaped (Windows only) + * @param image The name (or reference) of the image to use when creating the container, or which was used when the container was created. + * @param volumes An object mapping mount point paths inside the container to empty objects. + * @param workingDir The working directory for commands to run in. + * @param entrypoint The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + * @param networkDisabled Disable networking for the container. + * @param macAddress MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. + * @param onBuild `ONBUILD` metadata that were defined in the image's `Dockerfile`. + * @param labels User-defined key/value metadata. + * @param stopSignal Signal to stop a container as a string or unsigned integer. + * @param stopTimeout Timeout to stop a container in seconds. + * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + * @param hostConfig + * @param networkingConfig + */ +@JsonClass(generateAdapter = true) +data class ContainerCreateRequest( + // The hostname to use for the container, as a valid RFC 1123 hostname. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // The domain name to use for the container. + @Json(name = "Domainname") + var domainname: kotlin.String? = null, + // The user that commands are run as inside the container. + @Json(name = "User") + var user: kotlin.String? = null, + // Whether to attach to `stdin`. + @Json(name = "AttachStdin") + var attachStdin: kotlin.Boolean? = false, + // Whether to attach to `stdout`. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = true, + // Whether to attach to `stderr`. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = true, + // An object mapping ports to an empty object in the form: `{\"/\": {}}` + @Json(name = "ExposedPorts") + var exposedPorts: kotlin.collections.MutableMap? = null, + // Attach standard streams to a TTY, including `stdin` if it is not closed. + @Json(name = "Tty") + var tty: kotlin.Boolean? = false, + // Open `stdin` + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = false, + // Close `stdin` after one attached client disconnects + @Json(name = "StdinOnce") + var stdinOnce: kotlin.Boolean? = false, + // A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run specified as a string or an array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + @Json(name = "Healthcheck") + var healthcheck: HealthConfig? = null, + // Command is already escaped (Windows only) + @Json(name = "ArgsEscaped") + var argsEscaped: kotlin.Boolean? = null, + // The name (or reference) of the image to use when creating the container, or which was used when the container was created. + @Json(name = "Image") + var image: kotlin.String? = null, + // An object mapping mount point paths inside the container to empty objects. + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableMap? = null, + // The working directory for commands to run in. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, + // The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList? = null, + // Disable networking for the container. + @Json(name = "NetworkDisabled") + var networkDisabled: kotlin.Boolean? = null, + // MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + // `ONBUILD` metadata that were defined in the image's `Dockerfile`. + @Json(name = "OnBuild") + var onBuild: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Signal to stop a container as a string or unsigned integer. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = "SIGTERM", + // Timeout to stop a container in seconds. + @Json(name = "StopTimeout") + var stopTimeout: kotlin.Int? = null, + // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + @Json(name = "Shell") + var shell: kotlin.collections.MutableList? = null, + @Json(name = "HostConfig") + var hostConfig: HostConfig? = null, + @Json(name = "NetworkingConfig") + var networkingConfig: NetworkingConfig? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt new file mode 100644 index 00000000..88307467 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to ContainerCreate operation + * + * @param id The ID of the created container + * @param warnings Warnings encountered when creating the container + */ +@JsonClass(generateAdapter = true) +data class ContainerCreateResponse( + // The ID of the created container + @Json(name = "Id") + var id: kotlin.String, + // Warnings encountered when creating the container + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt new file mode 100644 index 00000000..f3f13cef --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt @@ -0,0 +1,110 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id The ID of the container + * @param created The time the container was created + * @param path The path to the command being run + * @param args The arguments to the command being run + * @param state + * @param image The container's image ID + * @param resolvConfPath + * @param hostnamePath + * @param hostsPath + * @param logPath + * @param name + * @param restartCount + * @param driver + * @param platform + * @param mountLabel + * @param processLabel + * @param appArmorProfile + * @param execIDs IDs of exec instances that are running in the container. + * @param hostConfig + * @param graphDriver + * @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 mounts + * @param config + * @param networkSettings + */ +@JsonClass(generateAdapter = true) +data class ContainerInspectResponse( + // The ID of the container + @Json(name = "Id") + var id: kotlin.String? = null, + // The time the container was created + @Json(name = "Created") + var created: kotlin.String? = null, + // The path to the command being run + @Json(name = "Path") + var path: kotlin.String? = null, + // The arguments to the command being run + @Json(name = "Args") + var args: kotlin.collections.MutableList? = null, + @Json(name = "State") + var state: ContainerState? = null, + // The container's image ID + @Json(name = "Image") + var image: kotlin.String? = null, + @Json(name = "ResolvConfPath") + var resolvConfPath: kotlin.String? = null, + @Json(name = "HostnamePath") + var hostnamePath: kotlin.String? = null, + @Json(name = "HostsPath") + var hostsPath: kotlin.String? = null, + @Json(name = "LogPath") + var logPath: kotlin.String? = null, + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "RestartCount") + var restartCount: kotlin.Int? = null, + @Json(name = "Driver") + var driver: kotlin.String? = null, + @Json(name = "Platform") + var platform: kotlin.String? = null, + @Json(name = "MountLabel") + var mountLabel: kotlin.String? = null, + @Json(name = "ProcessLabel") + var processLabel: kotlin.String? = null, + @Json(name = "AppArmorProfile") + var appArmorProfile: kotlin.String? = null, + // IDs of exec instances that are running in the container. + @Json(name = "ExecIDs") + var execIDs: kotlin.collections.MutableList? = null, + @Json(name = "HostConfig") + var hostConfig: HostConfig? = null, + @Json(name = "GraphDriver") + var graphDriver: GraphDriverData? = null, + // The size of files that have been created or changed by this container. + @Json(name = "SizeRw") + var sizeRw: kotlin.Long? = null, + // The total size of all the files in this container. + @Json(name = "SizeRootFs") + var sizeRootFs: kotlin.Long? = null, + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + @Json(name = "Config") + var config: ContainerConfig? = null, + @Json(name = "NetworkSettings") + var networkSettings: NetworkSettings? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt new file mode 100644 index 00000000..944ed8b5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param containersDeleted Container IDs that were deleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class ContainerPruneResponse( + // Container IDs that were deleted + @Json(name = "ContainersDeleted") + var containersDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt new file mode 100644 index 00000000..aa168c4c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt @@ -0,0 +1,101 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the \"inspect\" command. + * + * @param status String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". + * @param running Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". + * @param paused Whether this container is paused. + * @param restarting Whether this container is restarting. + * @param ooMKilled Whether a process within this container has been killed because it ran out of memory since the container was last started. + * @param dead + * @param pid The process ID of this container + * @param exitCode The last exit code of this container + * @param error + * @param startedAt The time when this container was last started. + * @param finishedAt The time when this container last exited. + * @param health + */ +@JsonClass(generateAdapter = true) +data class ContainerState( + // String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". + @Json(name = "Status") + var status: ContainerState.Status? = null, + // Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". + @Json(name = "Running") + var running: kotlin.Boolean? = null, + // Whether this container is paused. + @Json(name = "Paused") + var paused: kotlin.Boolean? = null, + // Whether this container is restarting. + @Json(name = "Restarting") + var restarting: kotlin.Boolean? = null, + // Whether a process within this container has been killed because it ran out of memory since the container was last started. + @Json(name = "OOMKilled") + var ooMKilled: kotlin.Boolean? = null, + @Json(name = "Dead") + var dead: kotlin.Boolean? = null, + // The process ID of this container + @Json(name = "Pid") + var pid: kotlin.Int? = null, + // The last exit code of this container + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, + @Json(name = "Error") + var error: kotlin.String? = null, + // The time when this container was last started. + @Json(name = "StartedAt") + var startedAt: kotlin.String? = null, + // The time when this container last exited. + @Json(name = "FinishedAt") + var finishedAt: kotlin.String? = null, + @Json(name = "Health") + var health: Health? = null, +) { + /** + * String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". + * + * Values: Created,Running,Paused,Restarting,Removing,Exited,Dead + */ + @JsonClass(generateAdapter = false) + enum class Status(val value: kotlin.String) { + @Json(name = "created") + Created("created"), + + @Json(name = "running") + Running("running"), + + @Json(name = "paused") + Paused("paused"), + + @Json(name = "restarting") + Restarting("restarting"), + + @Json(name = "removing") + Removing("removing"), + + @Json(name = "exited") + Exited("exited"), + + @Json(name = "dead") + Dead("dead"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt new file mode 100644 index 00000000..da1bef16 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents the status of a container. + * + * @param containerID + * @param PID + * @param exitCode + */ +@JsonClass(generateAdapter = true) +data class ContainerStatus( + @Json(name = "ContainerID") + var containerID: kotlin.String? = null, + @Json(name = "PID") + var PID: kotlin.Int? = null, + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt new file mode 100644 index 00000000..3049813e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt @@ -0,0 +1,84 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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") + var id: kotlin.String? = null, + // The names that this container has been given + @Json(name = "Names") + var names: kotlin.collections.MutableList? = null, + // The name of the image used when creating this container + @Json(name = "Image") + var image: kotlin.String? = null, + // The ID of the image that this container was created from + @Json(name = "ImageID") + var imageID: kotlin.String? = null, + // Command to run when starting the container + @Json(name = "Command") + var command: kotlin.String? = null, + // When the container was created + @Json(name = "Created") + var created: kotlin.Long? = null, + // The ports exposed by this container + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, + // The size of files that have been created or changed by this container + @Json(name = "SizeRw") + var sizeRw: kotlin.Long? = null, + // The total size of all the files in this container + @Json(name = "SizeRootFs") + var sizeRootFs: kotlin.Long? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // The state of this container (e.g. `Exited`) + @Json(name = "State") + var state: kotlin.String? = null, + // Additional human-readable status of this container (e.g. `Exit 0`) + @Json(name = "Status") + var status: kotlin.String? = null, + @Json(name = "HostConfig") + var hostConfig: ContainerSummaryHostConfig? = null, + @Json(name = "NetworkSettings") + var networkSettings: ContainerSummaryNetworkSettings? = null, + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt new file mode 100644 index 00000000..b0d14ad7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param networkMode + */ +@JsonClass(generateAdapter = true) +data class ContainerSummaryHostConfig( + @Json(name = "NetworkMode") + var networkMode: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt new file mode 100644 index 00000000..7f50ed85 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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") + var networks: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt new file mode 100644 index 00000000..7fb3c675 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to ContainerTop operation + * + * @param titles The ps column titles + * @param processes Each process running in the container, where each is process is an array of values corresponding to the titles. + */ +@JsonClass(generateAdapter = true) +data class ContainerTopResponse( + // The ps column titles + @Json(name = "Titles") + var titles: kotlin.collections.MutableList? = null, + // Each process running in the container, where each is process is an array of values corresponding to the titles. + @Json(name = "Processes") + var processes: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt new file mode 100644 index 00000000..a6264b11 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt @@ -0,0 +1,154 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param cpuShares An integer value representing this container's relative CPU weight versus other containers. + * @param memory Memory limit in bytes. + * @param cgroupParent Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + * @param blkioWeight Block IO weight (relative weight). + * @param blkioWeightDevice Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + * @param blkioDeviceReadBps Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteBps Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceReadIOps Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteIOps Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param cpuPeriod The length of a CPU period in microseconds. + * @param cpuQuota Microseconds of CPU time that the container can get in a CPU period. + * @param cpuRealtimePeriod The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpuRealtimeRuntime The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpusetCpus CPUs in which to allow execution (e.g., `0-3`, `0,1`). + * @param cpusetMems Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + * @param devices A list of devices to add to the container. + * @param deviceCgroupRules a list of cgroup rules to apply to the container + * @param deviceRequests A list of requests for devices to be sent to device drivers. + * @param kernelMemoryTCP Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. + * @param memoryReservation Memory soft limit in bytes. + * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + * @param nanoCpus CPU quota in units of 10-9 CPUs. + * @param oomKillDisable Disable OOM Killer for the container. + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param pidsLimit Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + * @param ulimits A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + * @param cpuCount The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param cpuPercent The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param ioMaximumIOps Maximum IOps for the container system drive (Windows only) + * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). + * @param restartPolicy + */ +@JsonClass(generateAdapter = true) +data class ContainerUpdateRequest( + // An integer value representing this container's relative CPU weight versus other containers. + @Json(name = "CpuShares") + var cpuShares: kotlin.Int? = null, + // Memory limit in bytes. + @Json(name = "Memory") + var memory: kotlin.Long? = 0L, + // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + @Json(name = "CgroupParent") + var cgroupParent: kotlin.String? = null, + // Block IO weight (relative weight). + @Json(name = "BlkioWeight") + var blkioWeight: kotlin.Int? = null, + // Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + @Json(name = "BlkioWeightDevice") + var blkioWeightDevice: kotlin.collections.MutableList? = null, + // Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadBps") + var blkioDeviceReadBps: kotlin.collections.MutableList? = null, + // Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteBps") + var blkioDeviceWriteBps: kotlin.collections.MutableList? = null, + // Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadIOps") + var blkioDeviceReadIOps: kotlin.collections.MutableList? = null, + // Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteIOps") + var blkioDeviceWriteIOps: kotlin.collections.MutableList? = null, + // The length of a CPU period in microseconds. + @Json(name = "CpuPeriod") + var cpuPeriod: kotlin.Long? = null, + // Microseconds of CPU time that the container can get in a CPU period. + @Json(name = "CpuQuota") + var cpuQuota: kotlin.Long? = null, + // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimePeriod") + var cpuRealtimePeriod: kotlin.Long? = null, + // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimeRuntime") + var cpuRealtimeRuntime: kotlin.Long? = null, + // CPUs in which to allow execution (e.g., `0-3`, `0,1`). + @Json(name = "CpusetCpus") + var cpusetCpus: kotlin.String? = null, + // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + @Json(name = "CpusetMems") + var cpusetMems: kotlin.String? = null, + // A list of devices to add to the container. + @Json(name = "Devices") + var devices: kotlin.collections.MutableList? = null, + // a list of cgroup rules to apply to the container + @Json(name = "DeviceCgroupRules") + var deviceCgroupRules: kotlin.collections.MutableList? = null, + // A list of requests for devices to be sent to device drivers. + @Json(name = "DeviceRequests") + var deviceRequests: kotlin.collections.MutableList? = null, + // Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. + @Json(name = "KernelMemoryTCP") + var kernelMemoryTCP: kotlin.Long? = null, + // Memory soft limit in bytes. + @Json(name = "MemoryReservation") + var memoryReservation: kotlin.Long? = null, + // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + @Json(name = "MemorySwap") + var memorySwap: kotlin.Long? = null, + // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, + // CPU quota in units of 10-9 CPUs. + @Json(name = "NanoCpus") + var nanoCpus: kotlin.Long? = null, + // Disable OOM Killer for the container. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Long? = null, + // A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, + // The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuCount") + var cpuCount: kotlin.Long? = null, + // The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuPercent") + var cpuPercent: kotlin.Long? = null, + // Maximum IOps for the container system drive (Windows only) + @Json(name = "IOMaximumIOps") + var ioMaximumIOps: kotlin.Long? = null, + // Maximum IO in bytes per second for the container system drive (Windows only). + @Json(name = "IOMaximumBandwidth") + var ioMaximumBandwidth: kotlin.Long? = null, + @Json(name = "RestartPolicy") + var restartPolicy: RestartPolicy? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt new file mode 100644 index 00000000..95e7f7a2 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to ContainerUpdate operation + * + * @param warnings + */ +@JsonClass(generateAdapter = true) +data class ContainerUpdateResponse( + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt new file mode 100644 index 00000000..e58142f7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * container waiting error, if any + * + * @param message Details of an error + */ +@JsonClass(generateAdapter = true) +data class ContainerWaitExitError( + // Details of an error + @Json(name = "Message") + var message: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt new file mode 100644 index 00000000..68d6dd7b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to ContainerWait operation + * + * @param statusCode Exit code of the container + * @param error + */ +@JsonClass(generateAdapter = true) +data class ContainerWaitResponse( + // Exit code of the container + @Json(name = "StatusCode") + var statusCode: kotlin.Long, + @Json(name = "Error") + var error: ContainerWaitExitError? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt new file mode 100644 index 00000000..27d105e5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id + * @param error + * @param errorDetail + * @param status + * @param progress + * @param progressDetail + */ +@JsonClass(generateAdapter = true) +data class CreateImageInfo( + @Json(name = "id") + var id: kotlin.String? = null, + @Json(name = "error") + var error: kotlin.String? = null, + @Json(name = "errorDetail") + var errorDetail: ErrorDetail? = null, + @Json(name = "status") + var status: kotlin.String? = null, + @Json(name = "progress") + var progress: kotlin.String? = null, + @Json(name = "progressDetail") + var progressDetail: ProgressDetail? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt new file mode 100644 index 00000000..72ca8fdb --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A device mapping between the host and container + * + * @param pathOnHost + * @param pathInContainer + * @param cgroupPermissions + */ +@JsonClass(generateAdapter = true) +data class DeviceMapping( + @Json(name = "PathOnHost") + var pathOnHost: kotlin.String? = null, + @Json(name = "PathInContainer") + var pathInContainer: kotlin.String? = null, + @Json(name = "CgroupPermissions") + var cgroupPermissions: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt new file mode 100644 index 00000000..4eead052 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt @@ -0,0 +1,44 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A request for devices to be sent to device drivers + * + * @param driver + * @param count + * @param deviceIDs + * @param capabilities A list of capabilities; an OR list of AND lists of capabilities. + * @param options Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. + */ +@JsonClass(generateAdapter = true) +data class DeviceRequest( + @Json(name = "Driver") + var driver: kotlin.String? = null, + @Json(name = "Count") + var count: kotlin.Int? = null, + @Json(name = "DeviceIDs") + var deviceIDs: kotlin.collections.MutableList? = null, + // A list of capabilities; an OR list of AND lists of capabilities. + @Json(name = "Capabilities") + var capabilities: kotlin.collections.MutableList>? = null, + // Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt new file mode 100644 index 00000000..845598dd --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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 DistributionInspect( + @Json(name = "Descriptor") + var descriptor: OCIDescriptor, + // An array containing all platforms supported by the image. + @Json(name = "Platforms") + var platforms: kotlin.collections.MutableList, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt new file mode 100644 index 00000000..a4f83256 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Driver represents a driver (network, logging, secrets). + * + * @param name Name of the driver. + * @param options Key/value map of driver-specific options. + */ +@JsonClass(generateAdapter = true) +data class Driver( + // Name of the driver. + @Json(name = "Name") + var name: kotlin.String, + // Key/value map of driver-specific options. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt new file mode 100644 index 00000000..12dfe787 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * EndpointIPAMConfig represents an endpoint's IPAM configuration. + * + * @param ipv4Address + * @param ipv6Address + * @param linkLocalIPs + */ +@JsonClass(generateAdapter = true) +data class EndpointIPAMConfig( + @Json(name = "IPv4Address") + var ipv4Address: kotlin.String? = null, + @Json(name = "IPv6Address") + var ipv6Address: kotlin.String? = null, + @Json(name = "LinkLocalIPs") + var linkLocalIPs: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt new file mode 100644 index 00000000..983ff67f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt @@ -0,0 +1,76 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param protocol + * @param targetPort The port inside the container. + * @param publishedPort The port on the swarm hosts. + * @param publishMode The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. + */ +@JsonClass(generateAdapter = true) +data class EndpointPortConfig( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "Protocol") + var protocol: EndpointPortConfig.Protocol? = null, + // The port inside the container. + @Json(name = "TargetPort") + var targetPort: kotlin.Int? = null, + // The port on the swarm hosts. + @Json(name = "PublishedPort") + var publishedPort: kotlin.Int? = null, + // The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. + @Json(name = "PublishMode") + var publishMode: EndpointPortConfig.PublishMode? = PublishMode.Ingress, +) { + /** + * + * + * Values: Tcp,Udp,Sctp + */ + @JsonClass(generateAdapter = false) + enum class Protocol(val value: kotlin.String) { + @Json(name = "tcp") + Tcp("tcp"), + + @Json(name = "udp") + Udp("udp"), + + @Json(name = "sctp") + Sctp("sctp"), + } + + /** + * The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. + * + * Values: Ingress,Host + */ + @JsonClass(generateAdapter = false) + enum class PublishMode(val value: kotlin.String) { + @Json(name = "ingress") + Ingress("ingress"), + + @Json(name = "host") + Host("host"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt new file mode 100644 index 00000000..bcd260c8 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt @@ -0,0 +1,80 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Configuration for a network endpoint. + * + * @param ipAMConfig + * @param links + * @param macAddress MAC address for the endpoint on this network. The network driver might ignore this parameter. + * @param aliases + * @param networkID Unique ID of the network. + * @param endpointID Unique ID for the service endpoint in a Sandbox. + * @param gateway Gateway address for this network. + * @param ipAddress IPv4 address. + * @param ipPrefixLen Mask length of the IPv4 address. + * @param ipv6Gateway IPv6 gateway address. + * @param globalIPv6Address Global IPv6 address. + * @param globalIPv6PrefixLen Mask length of the global IPv6 address. + * @param driverOpts DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. + * @param dnSNames List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. + */ +@JsonClass(generateAdapter = true) +data class EndpointSettings( + @Json(name = "IPAMConfig") + var ipAMConfig: EndpointIPAMConfig? = null, + @Json(name = "Links") + var links: kotlin.collections.MutableList? = null, + // MAC address for the endpoint on this network. The network driver might ignore this parameter. + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + @Json(name = "Aliases") + var aliases: kotlin.collections.MutableList? = null, + // Unique ID of the network. + @Json(name = "NetworkID") + var networkID: kotlin.String? = null, + // Unique ID for the service endpoint in a Sandbox. + @Json(name = "EndpointID") + var endpointID: kotlin.String? = null, + // Gateway address for this network. + @Json(name = "Gateway") + var gateway: kotlin.String? = null, + // IPv4 address. + @Json(name = "IPAddress") + var ipAddress: kotlin.String? = null, + // Mask length of the IPv4 address. + @Json(name = "IPPrefixLen") + var ipPrefixLen: kotlin.Int? = null, + // IPv6 gateway address. + @Json(name = "IPv6Gateway") + var ipv6Gateway: kotlin.String? = null, + // Global IPv6 address. + @Json(name = "GlobalIPv6Address") + var globalIPv6Address: kotlin.String? = null, + // Mask length of the global IPv6 address. + @Json(name = "GlobalIPv6PrefixLen") + var globalIPv6PrefixLen: kotlin.Long? = null, + // DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. + @Json(name = "DriverOpts") + var driverOpts: kotlin.collections.MutableMap? = null, + // List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. + @Json(name = "DNSNames") + var dnSNames: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt new file mode 100644 index 00000000..a9887b7a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt @@ -0,0 +1,49 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Properties that can be configured to access and load balance a service. + * + * @param mode The mode of resolution to use for internal load balancing between tasks. + * @param ports List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. + */ +@JsonClass(generateAdapter = true) +data class EndpointSpec( + // The mode of resolution to use for internal load balancing between tasks. + @Json(name = "Mode") + var mode: EndpointSpec.Mode? = Mode.Vip, + // List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, +) { + /** + * The mode of resolution to use for internal load balancing between tasks. + * + * Values: Vip,Dnsrr + */ + @JsonClass(generateAdapter = false) + enum class Mode(val value: kotlin.String) { + @Json(name = "vip") + Vip("vip"), + + @Json(name = "dnsrr") + Dnsrr("dnsrr"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt new file mode 100644 index 00000000..f16ef09c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * EngineDescription provides information about an engine. + * + * @param engineVersion + * @param labels + * @param plugins + */ +@JsonClass(generateAdapter = true) +data class EngineDescription( + @Json(name = "EngineVersion") + var engineVersion: kotlin.String? = null, + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Plugins") + var plugins: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt new file mode 100644 index 00000000..e6c9f02c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param type + * @param name + */ +@JsonClass(generateAdapter = true) +data class EngineDescriptionPluginsInner( + @Json(name = "Type") + var type: kotlin.String? = null, + @Json(name = "Name") + var name: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt new file mode 100644 index 00000000..fa5fdb13 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param code + * @param message + */ +@JsonClass(generateAdapter = true) +data class ErrorDetail( + @Json(name = "code") + var code: kotlin.Int? = null, + @Json(name = "message") + var message: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt new file mode 100644 index 00000000..facdf1d2 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Represents an error. + * + * @param message The error message. + */ +@JsonClass(generateAdapter = true) +data class ErrorResponse( + // The error message. + @Json(name = "message") + var message: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt new file mode 100644 index 00000000..e391e21b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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. + */ +@JsonClass(generateAdapter = true) +data class EventActor( + // The ID of the object emitting the event + @Json(name = "ID") + var ID: kotlin.String? = null, + // Various key/value attributes of the object, depending on its type. + @Json(name = "Attributes") + var attributes: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt new file mode 100644 index 00000000..d43978a0 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt @@ -0,0 +1,105 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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 EventMessage( + // The type of object emitting the event + @Json(name = "Type") + var type: EventMessage.Type? = null, + // The type of event + @Json(name = "Action") + var action: kotlin.String? = null, + @Json(name = "Actor") + var actor: EventActor? = null, + // Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. + @Json(name = "scope") + var scope: EventMessage.Scope? = null, + // Timestamp of event + @Json(name = "time") + var time: kotlin.Long? = null, + // Timestamp of event, with nanosecond accuracy + @Json(name = "timeNano") + var timeNano: kotlin.Long? = null, +) { + /** + * The type of object emitting the event + * + * Values: Builder,Config,Container,Daemon,Image,Network,Node,Plugin,Secret,Service,Volume + */ + @JsonClass(generateAdapter = false) + 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 + */ + @JsonClass(generateAdapter = false) + enum class Scope(val value: kotlin.String) { + @Json(name = "local") + Local("local"), + + @Json(name = "swarm") + Swarm("swarm"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt new file mode 100644 index 00000000..26059794 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt @@ -0,0 +1,71 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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 consoleSize Initial console size, as an `[height, width]` array. + * @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") + var attachStdin: kotlin.Boolean? = null, + // Attach to `stdout` of the exec command. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = null, + // Attach to `stderr` of the exec command. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = null, + // Initial console size, as an `[height, width]` array. + @Json(name = "ConsoleSize") + var consoleSize: kotlin.collections.MutableList? = 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") + var detachKeys: kotlin.String? = null, + // Allocate a pseudo-TTY. + @Json(name = "Tty") + var tty: kotlin.Boolean? = null, + // A list of environment variables in the form `[\"VAR=value\", ...]`. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run, as a string or array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + // Runs the exec process with extended privileges. + @Json(name = "Privileged") + var privileged: kotlin.Boolean? = false, + // 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") + var user: kotlin.String? = null, + // The working directory for the exec process inside the container. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt new file mode 100644 index 00000000..a41fb785 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt @@ -0,0 +1,61 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param canRemove + * @param detachKeys + * @param ID + * @param running + * @param exitCode + * @param processConfig + * @param openStdin + * @param openStderr + * @param openStdout + * @param containerID + * @param pid The system process ID for the exec process. + */ +@JsonClass(generateAdapter = true) +data class ExecInspectResponse( + @Json(name = "CanRemove") + var canRemove: kotlin.Boolean? = null, + @Json(name = "DetachKeys") + var detachKeys: kotlin.String? = null, + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Running") + var running: kotlin.Boolean? = null, + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, + @Json(name = "ProcessConfig") + var processConfig: ProcessConfig? = null, + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = null, + @Json(name = "OpenStderr") + var openStderr: kotlin.Boolean? = null, + @Json(name = "OpenStdout") + var openStdout: kotlin.Boolean? = null, + @Json(name = "ContainerID") + var containerID: kotlin.String? = null, + // The system process ID for the exec process. + @Json(name = "Pid") + var pid: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt new file mode 100644 index 00000000..a9961553 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param detach Detach from the command. + * @param tty Allocate a pseudo-TTY. + * @param consoleSize Initial console size, as an `[height, width]` array. + */ +@JsonClass(generateAdapter = true) +data class ExecStartConfig( + // Detach from the command. + @Json(name = "Detach") + var detach: kotlin.Boolean? = null, + // Allocate a pseudo-TTY. + @Json(name = "Tty") + var tty: kotlin.Boolean? = null, + // Initial console size, as an `[height, width]` array. + @Json(name = "ConsoleSize") + var consoleSize: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt new file mode 100644 index 00000000..a5a03b95 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Change in the container's filesystem. + * + * @param path Path to file or directory that has changed. + * @param kind + */ +@JsonClass(generateAdapter = true) +data class FilesystemChange( + // Path to file or directory that has changed. + @Json(name = "Path") + var path: kotlin.String, + @Json(name = "Kind") + var kind: ChangeType, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt new file mode 100644 index 00000000..9224058e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param namedResourceSpec + * @param discreteResourceSpec + */ +@JsonClass(generateAdapter = true) +data class GenericResourcesInner( + @Json(name = "NamedResourceSpec") + var namedResourceSpec: GenericResourcesInnerNamedResourceSpec? = null, + @Json(name = "DiscreteResourceSpec") + var discreteResourceSpec: GenericResourcesInnerDiscreteResourceSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt new file mode 100644 index 00000000..7cb81d23 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param kind + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class GenericResourcesInnerDiscreteResourceSpec( + @Json(name = "Kind") + var kind: kotlin.String? = null, + @Json(name = "Value") + var `value`: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt new file mode 100644 index 00000000..3de0fa30 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param kind + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class GenericResourcesInnerNamedResourceSpec( + @Json(name = "Kind") + var kind: kotlin.String? = null, + @Json(name = "Value") + var `value`: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt new file mode 100644 index 00000000..35181f16 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the storage driver used to store the container's and image's filesystem. + * + * @param name Name of the storage driver. + * @param `data` Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. + */ +@JsonClass(generateAdapter = true) +data class GraphDriverData( + // Name of the storage driver. + @Json(name = "Name") + var name: kotlin.String, + // Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. + @Json(name = "Data") + var `data`: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt new file mode 100644 index 00000000..87142b26 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Health stores information about the container's healthcheck results. + * + * @param status Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem + * @param failingStreak FailingStreak is the number of consecutive failures + * @param log Log contains the last few results (oldest first) + */ +@JsonClass(generateAdapter = true) +data class Health( + // Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem + @Json(name = "Status") + var status: Health.Status? = null, + // FailingStreak is the number of consecutive failures + @Json(name = "FailingStreak") + var failingStreak: kotlin.Int? = null, + // Log contains the last few results (oldest first) + @Json(name = "Log") + var log: kotlin.collections.MutableList? = null, +) { + /** + * Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem + * + * Values: None,Starting,Healthy,Unhealthy + */ + @JsonClass(generateAdapter = false) + enum class Status(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "starting") + Starting("starting"), + + @Json(name = "healthy") + Healthy("healthy"), + + @Json(name = "unhealthy") + Unhealthy("unhealthy"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt new file mode 100644 index 00000000..4e22085f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A test to perform to check that the container is healthy. + * + * @param test The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell + * @param interval The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + * @param timeout The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + * @param retries The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. + * @param startPeriod Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + * @param startInterval The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + */ +@JsonClass(generateAdapter = true) +data class HealthConfig( + // The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell + @Json(name = "Test") + var test: kotlin.collections.MutableList? = null, + // The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "Interval") + var interval: kotlin.Long? = null, + // The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "Timeout") + var timeout: kotlin.Long? = null, + // The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. + @Json(name = "Retries") + var retries: kotlin.Int? = null, + // Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "StartPeriod") + var startPeriod: kotlin.Long? = null, + // The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "StartInterval") + var startInterval: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt new file mode 100644 index 00000000..73ef988e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * HealthcheckResult stores information about a single run of a healthcheck probe + * + * @param start Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param end Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param exitCode ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe + * @param output Output from last check + */ +@JsonClass(generateAdapter = true) +data class HealthcheckResult( + // Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Start") + var start: java.time.OffsetDateTime? = null, + // Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "End") + var end: kotlin.String? = null, + // ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, + // Output from last check + @Json(name = "Output") + var output: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt new file mode 100644 index 00000000..55f0c7fb --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * individual image layer information in response to ImageHistory operation + * + * @param id + * @param created + * @param createdBy + * @param tags + * @param propertySize + * @param comment + */ +@JsonClass(generateAdapter = true) +data class HistoryResponseItem( + @Json(name = "Id") + var id: kotlin.String, + @Json(name = "Created") + var created: kotlin.Long, + @Json(name = "CreatedBy") + var createdBy: kotlin.String, + @Json(name = "Tags") + var tags: kotlin.collections.MutableList?, + @Json(name = "Size") + var propertySize: kotlin.Long, + @Json(name = "Comment") + var comment: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt new file mode 100644 index 00000000..be166ca5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt @@ -0,0 +1,339 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Container configuration that depends on the host we are running on + * + * @param cpuShares An integer value representing this container's relative CPU weight versus other containers. + * @param memory Memory limit in bytes. + * @param cgroupParent Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + * @param blkioWeight Block IO weight (relative weight). + * @param blkioWeightDevice Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + * @param blkioDeviceReadBps Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteBps Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceReadIOps Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteIOps Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param cpuPeriod The length of a CPU period in microseconds. + * @param cpuQuota Microseconds of CPU time that the container can get in a CPU period. + * @param cpuRealtimePeriod The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpuRealtimeRuntime The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpusetCpus CPUs in which to allow execution (e.g., `0-3`, `0,1`). + * @param cpusetMems Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + * @param devices A list of devices to add to the container. + * @param deviceCgroupRules a list of cgroup rules to apply to the container + * @param deviceRequests A list of requests for devices to be sent to device drivers. + * @param kernelMemoryTCP Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. + * @param memoryReservation Memory soft limit in bytes. + * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + * @param nanoCpus CPU quota in units of 10-9 CPUs. + * @param oomKillDisable Disable OOM Killer for the container. + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param pidsLimit Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + * @param ulimits A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + * @param cpuCount The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param cpuPercent The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param ioMaximumIOps Maximum IOps for the container system drive (Windows only) + * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). + * @param binds A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. + * @param containerIDFile Path to a file where the container ID is written + * @param logConfig + * @param networkMode Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:`. Any other value is taken as a custom network's name to which this container should connect to. + * @param portBindings PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + * @param restartPolicy + * @param autoRemove Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. + * @param volumeDriver Driver that this container uses to mount volumes. + * @param volumesFrom A list of volumes to inherit from another container, specified in the form `[:]`. + * @param mounts Specification for mounts to be added to the container. + * @param consoleSize Initial console size, as an `[height, width]` array. + * @param annotations Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. + * @param capAdd A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. + * @param capDrop A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. + * @param cgroupnsMode cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. + * @param dns A list of DNS servers for the container to use. + * @param dnsOptions A list of DNS options. + * @param dnsSearch A list of DNS search domains. + * @param extraHosts A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. + * @param groupAdd A list of additional groups that the container process will run as. + * @param ipcMode IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. + * @param cgroup Cgroup to use for the container. + * @param links A list of links for the container in the form `container_name:alias`. + * @param oomScoreAdj An integer value containing the score given to the container in order to tune OOM killer preferences. + * @param pidMode Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container + * @param privileged Gives the container full access to the host. + * @param publishAllPorts Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. + * @param readonlyRootfs Mount the container's root filesystem as read only. + * @param securityOpt A list of string values to customize labels for MLS systems, such as SELinux. + * @param storageOpt Storage driver options for this container, in the form `{\"size\": \"120G\"}`. + * @param tmpfs A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` + * @param utSMode UTS namespace to use for the container. + * @param usernsMode Sets the usernamespace mode for the container when usernamespace remapping option is enabled. + * @param shmSize Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. + * @param sysctls A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` + * @param runtime Runtime to use with this container. + * @param isolation Isolation technology of the container. (Windows only) + * @param maskedPaths The list of paths to be masked inside the container (this overrides the default set of paths). + * @param readonlyPaths The list of paths to be set as read-only inside the container (this overrides the default set of paths). + */ +@JsonClass(generateAdapter = true) +data class HostConfig( + // An integer value representing this container's relative CPU weight versus other containers. + @Json(name = "CpuShares") + var cpuShares: kotlin.Int? = null, + // Memory limit in bytes. + @Json(name = "Memory") + var memory: kotlin.Long? = 0L, + // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + @Json(name = "CgroupParent") + var cgroupParent: kotlin.String? = null, + // Block IO weight (relative weight). + @Json(name = "BlkioWeight") + var blkioWeight: kotlin.Int? = null, + // Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + @Json(name = "BlkioWeightDevice") + var blkioWeightDevice: kotlin.collections.MutableList? = null, + // Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadBps") + var blkioDeviceReadBps: kotlin.collections.MutableList? = null, + // Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteBps") + var blkioDeviceWriteBps: kotlin.collections.MutableList? = null, + // Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadIOps") + var blkioDeviceReadIOps: kotlin.collections.MutableList? = null, + // Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteIOps") + var blkioDeviceWriteIOps: kotlin.collections.MutableList? = null, + // The length of a CPU period in microseconds. + @Json(name = "CpuPeriod") + var cpuPeriod: kotlin.Long? = null, + // Microseconds of CPU time that the container can get in a CPU period. + @Json(name = "CpuQuota") + var cpuQuota: kotlin.Long? = null, + // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimePeriod") + var cpuRealtimePeriod: kotlin.Long? = null, + // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimeRuntime") + var cpuRealtimeRuntime: kotlin.Long? = null, + // CPUs in which to allow execution (e.g., `0-3`, `0,1`). + @Json(name = "CpusetCpus") + var cpusetCpus: kotlin.String? = null, + // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + @Json(name = "CpusetMems") + var cpusetMems: kotlin.String? = null, + // A list of devices to add to the container. + @Json(name = "Devices") + var devices: kotlin.collections.MutableList? = null, + // a list of cgroup rules to apply to the container + @Json(name = "DeviceCgroupRules") + var deviceCgroupRules: kotlin.collections.MutableList? = null, + // A list of requests for devices to be sent to device drivers. + @Json(name = "DeviceRequests") + var deviceRequests: kotlin.collections.MutableList? = null, + // Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. + @Json(name = "KernelMemoryTCP") + var kernelMemoryTCP: kotlin.Long? = null, + // Memory soft limit in bytes. + @Json(name = "MemoryReservation") + var memoryReservation: kotlin.Long? = null, + // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + @Json(name = "MemorySwap") + var memorySwap: kotlin.Long? = null, + // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, + // CPU quota in units of 10-9 CPUs. + @Json(name = "NanoCpus") + var nanoCpus: kotlin.Long? = null, + // Disable OOM Killer for the container. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Long? = null, + // A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, + // The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuCount") + var cpuCount: kotlin.Long? = null, + // The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuPercent") + var cpuPercent: kotlin.Long? = null, + // Maximum IOps for the container system drive (Windows only) + @Json(name = "IOMaximumIOps") + var ioMaximumIOps: kotlin.Long? = null, + // Maximum IO in bytes per second for the container system drive (Windows only). + @Json(name = "IOMaximumBandwidth") + var ioMaximumBandwidth: kotlin.Long? = null, + // A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. + @Json(name = "Binds") + var binds: kotlin.collections.MutableList? = null, + // Path to a file where the container ID is written + @Json(name = "ContainerIDFile") + var containerIDFile: kotlin.String? = null, + @Json(name = "LogConfig") + var logConfig: HostConfigAllOfLogConfig? = null, + // Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:`. Any other value is taken as a custom network's name to which this container should connect to. + @Json(name = "NetworkMode") + var networkMode: kotlin.String? = null, + // PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + @Json(name = "PortBindings") + var portBindings: kotlin.collections.MutableMap>? = null, + @Json(name = "RestartPolicy") + var restartPolicy: RestartPolicy? = null, + // Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. + @Json(name = "AutoRemove") + var autoRemove: kotlin.Boolean? = null, + // Driver that this container uses to mount volumes. + @Json(name = "VolumeDriver") + var volumeDriver: kotlin.String? = null, + // A list of volumes to inherit from another container, specified in the form `[:]`. + @Json(name = "VolumesFrom") + var volumesFrom: kotlin.collections.MutableList? = null, + // Specification for mounts to be added to the container. + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + // Initial console size, as an `[height, width]` array. + @Json(name = "ConsoleSize") + var consoleSize: kotlin.collections.MutableList? = null, + // Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. + @Json(name = "Annotations") + var annotations: kotlin.collections.MutableMap? = null, + // A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. + @Json(name = "CapAdd") + var capAdd: kotlin.collections.MutableList? = null, + // A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. + @Json(name = "CapDrop") + var capDrop: kotlin.collections.MutableList? = null, + // cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. + @Json(name = "CgroupnsMode") + var cgroupnsMode: HostConfig.CgroupnsMode? = null, + // A list of DNS servers for the container to use. + @Json(name = "Dns") + var dns: kotlin.collections.MutableList? = null, + // A list of DNS options. + @Json(name = "DnsOptions") + var dnsOptions: kotlin.collections.MutableList? = null, + // A list of DNS search domains. + @Json(name = "DnsSearch") + var dnsSearch: kotlin.collections.MutableList? = null, + // A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. + @Json(name = "ExtraHosts") + var extraHosts: kotlin.collections.MutableList? = null, + // A list of additional groups that the container process will run as. + @Json(name = "GroupAdd") + var groupAdd: kotlin.collections.MutableList? = null, + // IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. + @Json(name = "IpcMode") + var ipcMode: kotlin.String? = null, + // Cgroup to use for the container. + @Json(name = "Cgroup") + var cgroup: kotlin.String? = null, + // A list of links for the container in the form `container_name:alias`. + @Json(name = "Links") + var links: kotlin.collections.MutableList? = null, + // An integer value containing the score given to the container in order to tune OOM killer preferences. + @Json(name = "OomScoreAdj") + var oomScoreAdj: kotlin.Int? = null, + // Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container + @Json(name = "PidMode") + var pidMode: kotlin.String? = null, + // Gives the container full access to the host. + @Json(name = "Privileged") + var privileged: kotlin.Boolean? = null, + // Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. + @Json(name = "PublishAllPorts") + var publishAllPorts: kotlin.Boolean? = null, + // Mount the container's root filesystem as read only. + @Json(name = "ReadonlyRootfs") + var readonlyRootfs: kotlin.Boolean? = null, + // A list of string values to customize labels for MLS systems, such as SELinux. + @Json(name = "SecurityOpt") + var securityOpt: kotlin.collections.MutableList? = null, + // Storage driver options for this container, in the form `{\"size\": \"120G\"}`. + @Json(name = "StorageOpt") + var storageOpt: kotlin.collections.MutableMap? = null, + // A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` + @Json(name = "Tmpfs") + var tmpfs: kotlin.collections.MutableMap? = null, + // UTS namespace to use for the container. + @Json(name = "UTSMode") + var utSMode: kotlin.String? = null, + // Sets the usernamespace mode for the container when usernamespace remapping option is enabled. + @Json(name = "UsernsMode") + var usernsMode: kotlin.String? = null, + // Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. + @Json(name = "ShmSize") + var shmSize: kotlin.Long? = null, + // A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` + @Json(name = "Sysctls") + var sysctls: kotlin.collections.MutableMap? = null, + // Runtime to use with this container. + @Json(name = "Runtime") + var runtime: kotlin.String? = null, + // Isolation technology of the container. (Windows only) + @Json(name = "Isolation") + var isolation: HostConfig.Isolation? = null, + // The list of paths to be masked inside the container (this overrides the default set of paths). + @Json(name = "MaskedPaths") + var maskedPaths: kotlin.collections.MutableList? = null, + // The list of paths to be set as read-only inside the container (this overrides the default set of paths). + @Json(name = "ReadonlyPaths") + var readonlyPaths: kotlin.collections.MutableList? = null, +) { + /** + * cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. + * + * Values: Private,Host + */ + @JsonClass(generateAdapter = false) + enum class CgroupnsMode(val value: kotlin.String) { + @Json(name = "private") + Private("private"), + + @Json(name = "host") + Host("host"), + } + + /** + * Isolation technology of the container. (Windows only) + * + * Values: Default,Process,Hyperv,EMPTY + */ + @JsonClass(generateAdapter = false) + enum class Isolation(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "process") + Process("process"), + + @Json(name = "hyperv") + Hyperv("hyperv"), + + @Json(name = "") + EMPTY(""), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt new file mode 100644 index 00000000..934ce059 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt @@ -0,0 +1,68 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The logging configuration for this container + * + * @param type + * @param config + */ +@JsonClass(generateAdapter = true) +data class HostConfigAllOfLogConfig( + @Json(name = "Type") + var type: HostConfigAllOfLogConfig.Type? = null, + @Json(name = "Config") + var config: kotlin.collections.MutableMap? = null, +) { + /** + * + * + * Values: JsonFile,Syslog,Journald,Gelf,Fluentd,Awslogs,Splunk,Etwlogs,None + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "json-file") + JsonFile("json-file"), + + @Json(name = "syslog") + Syslog("syslog"), + + @Json(name = "journald") + Journald("journald"), + + @Json(name = "gelf") + Gelf("gelf"), + + @Json(name = "fluentd") + Fluentd("fluentd"), + + @Json(name = "awslogs") + Awslogs("awslogs"), + + @Json(name = "splunk") + Splunk("splunk"), + + @Json(name = "etwlogs") + Etwlogs("etwlogs"), + + @Json(name = "none") + None("none"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt new file mode 100644 index 00000000..6b12e613 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param driver Name of the IPAM driver to use. + * @param config List of IPAM configuration options, specified as a map: ``` {\"Subnet\": , \"IPRange\": , \"Gateway\": , \"AuxAddress\": } ``` + * @param options Driver-specific options, specified as a map. + */ +@JsonClass(generateAdapter = true) +data class IPAM( + // Name of the IPAM driver to use. + @Json(name = "Driver") + var driver: kotlin.String? = "default", + // List of IPAM configuration options, specified as a map: ``` {\"Subnet\": , \"IPRange\": , \"Gateway\": , \"AuxAddress\": } ``` + @Json(name = "Config") + var config: kotlin.collections.MutableList? = null, + // Driver-specific options, specified as a map. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt new file mode 100644 index 00000000..dac6a0e4 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param subnet + * @param ipRange + * @param gateway + * @param auxiliaryAddresses + */ +@JsonClass(generateAdapter = true) +data class IPAMConfig( + @Json(name = "Subnet") + var subnet: kotlin.String? = null, + @Json(name = "IPRange") + var ipRange: kotlin.String? = null, + @Json(name = "Gateway") + var gateway: kotlin.String? = null, + @Json(name = "AuxiliaryAddresses") + var auxiliaryAddresses: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt new file mode 100644 index 00000000..fc6bda81 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Response to an API call that returns just an Id + * + * @param id The id of the newly created object. + */ +@JsonClass(generateAdapter = true) +data class IdResponse( + // The id of the newly created object. + @Json(name = "Id") + var id: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt new file mode 100644 index 00000000..1d2c088a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt @@ -0,0 +1,126 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Configuration of the image. These fields are used as defaults when starting a container from the image. + * + * @param hostname The hostname to use for the container, as a valid RFC 1123 hostname.


> **Note**: this field is always empty and must not be used. + * @param domainname The domain name to use for the container.


> **Note**: this field is always empty and must not be used. + * @param user The user that commands are run as inside the container. + * @param attachStdin Whether to attach to `stdin`.


> **Note**: this field is always false and must not be used. + * @param attachStdout Whether to attach to `stdout`.


> **Note**: this field is always false and must not be used. + * @param attachStderr Whether to attach to `stderr`.


> **Note**: this field is always false and must not be used. + * @param exposedPorts An object mapping ports to an empty object in the form: `{\"/\": {}}` + * @param tty Attach standard streams to a TTY, including `stdin` if it is not closed.


> **Note**: this field is always false and must not be used. + * @param openStdin Open `stdin`


> **Note**: this field is always false and must not be used. + * @param stdinOnce Close `stdin` after one attached client disconnects.


> **Note**: this field is always false and must not be used. + * @param env A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + * @param cmd Command to run specified as a string or an array of strings. + * @param healthcheck + * @param argsEscaped Command is already escaped (Windows only) + * @param image The name (or reference) of the image to use when creating the container, or which was used when the container was created.


> **Note**: this field is always empty and must not be used. + * @param volumes An object mapping mount point paths inside the container to empty objects. + * @param workingDir The working directory for commands to run in. + * @param entrypoint The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + * @param networkDisabled Disable networking for the container.


> **Note**: this field is always omitted and must not be used. + * @param macAddress MAC address of the container.


> **Deprecated**: this field is deprecated in API v1.44 and up. It is always omitted. + * @param onBuild `ONBUILD` metadata that were defined in the image's `Dockerfile`. + * @param labels User-defined key/value metadata. + * @param stopSignal Signal to stop a container as a string or unsigned integer. + * @param stopTimeout Timeout to stop a container in seconds.


> **Note**: this field is always omitted and must not be used. + * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + */ +@JsonClass(generateAdapter = true) +data class ImageConfig( + // The hostname to use for the container, as a valid RFC 1123 hostname.


> **Note**: this field is always empty and must not be used. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // The domain name to use for the container.


> **Note**: this field is always empty and must not be used. + @Json(name = "Domainname") + var domainname: kotlin.String? = null, + // The user that commands are run as inside the container. + @Json(name = "User") + var user: kotlin.String? = null, + // Whether to attach to `stdin`.


> **Note**: this field is always false and must not be used. + @Json(name = "AttachStdin") + var attachStdin: kotlin.Boolean? = false, + // Whether to attach to `stdout`.


> **Note**: this field is always false and must not be used. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = false, + // Whether to attach to `stderr`.


> **Note**: this field is always false and must not be used. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = false, + // An object mapping ports to an empty object in the form: `{\"/\": {}}` + @Json(name = "ExposedPorts") + var exposedPorts: kotlin.collections.MutableMap? = null, + // Attach standard streams to a TTY, including `stdin` if it is not closed.


> **Note**: this field is always false and must not be used. + @Json(name = "Tty") + var tty: kotlin.Boolean? = false, + // Open `stdin`


> **Note**: this field is always false and must not be used. + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = false, + // Close `stdin` after one attached client disconnects.


> **Note**: this field is always false and must not be used. + @Json(name = "StdinOnce") + var stdinOnce: kotlin.Boolean? = false, + // A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run specified as a string or an array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + @Json(name = "Healthcheck") + var healthcheck: HealthConfig? = null, + // Command is already escaped (Windows only) + @Json(name = "ArgsEscaped") + var argsEscaped: kotlin.Boolean? = false, + // The name (or reference) of the image to use when creating the container, or which was used when the container was created.


> **Note**: this field is always empty and must not be used. + @Json(name = "Image") + var image: kotlin.String? = "", + // An object mapping mount point paths inside the container to empty objects. + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableMap? = null, + // The working directory for commands to run in. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, + // The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList? = null, + // Disable networking for the container.


> **Note**: this field is always omitted and must not be used. + @Json(name = "NetworkDisabled") + var networkDisabled: kotlin.Boolean? = false, + // MAC address of the container.


> **Deprecated**: this field is deprecated in API v1.44 and up. It is always omitted. + @Json(name = "MacAddress") + var macAddress: kotlin.String? = "", + // `ONBUILD` metadata that were defined in the image's `Dockerfile`. + @Json(name = "OnBuild") + var onBuild: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Signal to stop a container as a string or unsigned integer. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = null, + // Timeout to stop a container in seconds.


> **Note**: this field is always omitted and must not be used. + @Json(name = "StopTimeout") + var stopTimeout: kotlin.Int? = null, + // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + @Json(name = "Shell") + var shell: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt new file mode 100644 index 00000000..138be462 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param untagged The image ID of an image that was untagged + * @param deleted The image ID of an image that was deleted + */ +@JsonClass(generateAdapter = true) +data class ImageDeleteResponseItem( + // The image ID of an image that was untagged + @Json(name = "Untagged") + var untagged: kotlin.String? = null, + // The image ID of an image that was deleted + @Json(name = "Deleted") + var deleted: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt new file mode 100644 index 00000000..395b6ed5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Image ID or Digest + * + * @param ID + */ +@JsonClass(generateAdapter = true) +data class ImageID( + @Json(name = "ID") + var ID: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt new file mode 100644 index 00000000..73035a04 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt @@ -0,0 +1,98 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about an image in the local image cache. + * + * @param id ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + * @param repoTags List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + * @param repoDigests List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + * @param parent ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. + * @param comment Optional message that was set when committing or importing the image. + * @param created Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. + * @param container The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. + * @param containerConfig + * @param dockerVersion The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. + * @param author Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. + * @param config + * @param architecture Hardware CPU architecture that the image runs on. + * @param variant CPU architecture variant (presently ARM-only). + * @param os Operating System the image is built to run on. + * @param osVersion Operating System version the image is built to run on (especially for Windows). + * @param propertySize Total size of the image including all layers it is composed of. + * @param graphDriver + * @param rootFS + * @param metadata + */ +@JsonClass(generateAdapter = true) +data class ImageInspect( + // ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + @Json(name = "Id") + var id: kotlin.String? = null, + // List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + @Json(name = "RepoTags") + var repoTags: kotlin.collections.MutableList? = null, + // List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + @Json(name = "RepoDigests") + var repoDigests: kotlin.collections.MutableList? = null, + // ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. + @Json(name = "Parent") + var parent: kotlin.String? = null, + // Optional message that was set when committing or importing the image. + @Json(name = "Comment") + var comment: kotlin.String? = null, + // Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. + @Json(name = "Created") + var created: kotlin.String? = null, + // The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty. **Deprecated**: this field is kept for backward compatibility, but will be removed in API v1.45. + @Json(name = "Container") + var container: kotlin.String? = null, + @Json(name = "ContainerConfig") + var containerConfig: ContainerConfig? = null, + // The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty. + @Json(name = "DockerVersion") + var dockerVersion: kotlin.String? = null, + // Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. + @Json(name = "Author") + var author: kotlin.String? = null, + @Json(name = "Config") + var config: ImageConfig? = null, + // Hardware CPU architecture that the image runs on. + @Json(name = "Architecture") + var architecture: kotlin.String? = null, + // CPU architecture variant (presently ARM-only). + @Json(name = "Variant") + var variant: kotlin.String? = null, + // Operating System the image is built to run on. + @Json(name = "Os") + var os: kotlin.String? = null, + // Operating System version the image is built to run on (especially for Windows). + @Json(name = "OsVersion") + var osVersion: kotlin.String? = null, + // Total size of the image including all layers it is composed of. + @Json(name = "Size") + var propertySize: kotlin.Long? = null, + @Json(name = "GraphDriver") + var graphDriver: GraphDriverData? = null, + @Json(name = "RootFS") + var rootFS: ImageInspectRootFS? = null, + @Json(name = "Metadata") + var metadata: ImageInspectMetadata? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt new file mode 100644 index 00000000..51c0d93e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself. + * + * @param lastTagTime Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. + */ +@JsonClass(generateAdapter = true) +data class ImageInspectMetadata( + // Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. + @Json(name = "LastTagTime") + var lastTagTime: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt new file mode 100644 index 00000000..23515fd8 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the image's RootFS, including the layer IDs. + * + * @param type + * @param layers + */ +@JsonClass(generateAdapter = true) +data class ImageInspectRootFS( + @Json(name = "Type") + var type: kotlin.String, + @Json(name = "Layers") + var layers: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt new file mode 100644 index 00000000..b551f8d0 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param imagesDeleted Images that were deleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class ImagePruneResponse( + // Images that were deleted + @Json(name = "ImagesDeleted") + var imagesDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt new file mode 100644 index 00000000..89f7e7b2 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param description + * @param official + * @param automated Whether this repository has automated builds enabled.


> **Deprecated**: This field is deprecated and will always > be \"false\" in future. + * @param name + * @param starCount + */ +@JsonClass(generateAdapter = true) +data class ImageSearchResponseItem( + @Json(name = "description") + var description: kotlin.String? = null, + @Json(name = "is_official") + var official: kotlin.Boolean? = null, + // Whether this repository has automated builds enabled.


> **Deprecated**: This field is deprecated and will always > be \"false\" in future. + @Json(name = "is_automated") + var automated: kotlin.Boolean? = null, + @Json(name = "name") + var name: kotlin.String? = null, + @Json(name = "star_count") + var starCount: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt new file mode 100644 index 00000000..2733d170 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt @@ -0,0 +1,63 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + * @param parentId ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. + * @param created Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). + * @param propertySize Total size of the image including all layers it is composed of. + * @param sharedSize Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. + * @param containers Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. + * @param repoTags List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + * @param repoDigests List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + * @param labels User-defined key/value metadata. + */ +@JsonClass(generateAdapter = true) +data class ImageSummary( + // ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + @Json(name = "Id") + var id: kotlin.String, + // ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. + @Json(name = "ParentId") + var parentId: kotlin.String, + // Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). + @Json(name = "Created") + var created: kotlin.Int, + // Total size of the image including all layers it is composed of. + @Json(name = "Size") + var propertySize: kotlin.Long, + // Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. + @Json(name = "SharedSize") + var sharedSize: kotlin.Long, + // Number of containers using this image. Includes both stopped and running containers. This size is not calculated by default, and depends on which API endpoint is used. `-1` indicates that the value has not been set / calculated. + @Json(name = "Containers") + var containers: kotlin.Int, + // List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + @Json(name = "RepoTags") + var repoTags: kotlin.collections.MutableList? = null, + // List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + @Json(name = "RepoDigests") + var repoDigests: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt new file mode 100644 index 00000000..946c5434 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * IndexInfo contains information about a registry. + * + * @param name Name of the registry, such as \"docker.io\". + * @param mirrors List of mirrors, expressed as URIs. + * @param secure Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. + * @param official Indicates whether this is an official registry (i.e., Docker Hub / docker.io) + */ +@JsonClass(generateAdapter = true) +data class IndexInfo( + // Name of the registry, such as \"docker.io\". + @Json(name = "Name") + var name: kotlin.String? = null, + // List of mirrors, expressed as URIs. + @Json(name = "Mirrors") + var mirrors: kotlin.collections.MutableList? = null, + // Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. + @Json(name = "Secure") + var secure: kotlin.Boolean? = null, + // Indicates whether this is an official registry (i.e., Docker Hub / docker.io) + @Json(name = "Official") + var official: kotlin.Boolean? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt new file mode 100644 index 00000000..c86f24ed --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * JoinTokens contains the tokens workers and managers need to join the swarm. + * + * @param worker The token workers can use to join the swarm. + * @param manager The token managers can use to join the swarm. + */ +@JsonClass(generateAdapter = true) +data class JoinTokens( + // The token workers can use to join the swarm. + @Json(name = "Worker") + var worker: kotlin.String? = null, + // The token managers can use to join the swarm. + @Json(name = "Manager") + var manager: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt new file mode 100644 index 00000000..032c6749 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * An object describing a limit on resources which can be requested by a task. + * + * @param nanoCPUs + * @param memoryBytes + * @param pids Limits the maximum number of PIDs in the container. Set `0` for unlimited. + */ +@JsonClass(generateAdapter = true) +data class Limit( + @Json(name = "NanoCPUs") + var nanoCPUs: kotlin.Long? = null, + @Json(name = "MemoryBytes") + var memoryBytes: kotlin.Long? = null, + // Limits the maximum number of PIDs in the container. Set `0` for unlimited. + @Json(name = "Pids") + var pids: kotlin.Long? = 0L, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt new file mode 100644 index 00000000..98d513f8 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt @@ -0,0 +1,74 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Current local status of this node. + * + * Values: EMPTY,Inactive,Pending,Active,Error,Locked + */ + +@JsonClass(generateAdapter = false) +enum class LocalNodeState(val value: kotlin.String) { + @Json(name = "") + EMPTY(""), + + @Json(name = "inactive") + Inactive("inactive"), + + @Json(name = "pending") + Pending("pending"), + + @Json(name = "active") + Active("active"), + + @Json(name = "error") + Error("error"), + + @Json(name = "locked") + Locked("locked"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is LocalNodeState) "$data" else null + + /** + * Returns a valid [LocalNodeState] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): LocalNodeState? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt new file mode 100644 index 00000000..43ddd780 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ManagerStatus represents the status of a manager. It provides the current status of a node's manager component, if the node is a manager. + * + * @param leader + * @param reachability + * @param addr The IP address and port at which the manager is reachable. + */ +@JsonClass(generateAdapter = true) +data class ManagerStatus( + @Json(name = "Leader") + var leader: kotlin.Boolean? = false, + @Json(name = "Reachability") + var reachability: Reachability? = null, + // The IP address and port at which the manager is reachable. + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt new file mode 100644 index 00000000..50aadec7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt @@ -0,0 +1,79 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param target Container path. + * @param source Mount source (e.g. a volume name, a host path). + * @param type The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume + * @param readOnly Whether the mount should be read-only. + * @param consistency The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. + * @param bindOptions + * @param volumeOptions + * @param tmpfsOptions + */ +@JsonClass(generateAdapter = true) +data class Mount( + // Container path. + @Json(name = "Target") + var target: kotlin.String? = null, + // Mount source (e.g. a volume name, a host path). + @Json(name = "Source") + var source: kotlin.String? = null, + // The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume + @Json(name = "Type") + var type: Mount.Type? = null, + // Whether the mount should be read-only. + @Json(name = "ReadOnly") + var readOnly: kotlin.Boolean? = null, + // The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. + @Json(name = "Consistency") + var consistency: kotlin.String? = null, + @Json(name = "BindOptions") + var bindOptions: MountBindOptions? = null, + @Json(name = "VolumeOptions") + var volumeOptions: MountVolumeOptions? = null, + @Json(name = "TmpfsOptions") + var tmpfsOptions: MountTmpfsOptions? = null, +) { + /** + * The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume + * + * Values: Bind,Volume,Tmpfs,Npipe,Cluster + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "bind") + Bind("bind"), + + @Json(name = "volume") + Volume("volume"), + + @Json(name = "tmpfs") + Tmpfs("tmpfs"), + + @Json(name = "npipe") + Npipe("npipe"), + + @Json(name = "cluster") + Cluster("cluster"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt new file mode 100644 index 00000000..bd41e84a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt @@ -0,0 +1,73 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `bind` type. + * + * @param propagation A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + * @param nonRecursive Disable recursive bind mount. + * @param createMountpoint Create mount point on host if missing + * @param readOnlyNonRecursive Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction). + * @param readOnlyForceRecursive Raise an error if the mount cannot be made recursively read-only. + */ +@JsonClass(generateAdapter = true) +data class MountBindOptions( + // A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + @Json(name = "Propagation") + var propagation: MountBindOptions.Propagation? = null, + // Disable recursive bind mount. + @Json(name = "NonRecursive") + var nonRecursive: kotlin.Boolean? = false, + // Create mount point on host if missing + @Json(name = "CreateMountpoint") + var createMountpoint: kotlin.Boolean? = false, + // Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction). + @Json(name = "ReadOnlyNonRecursive") + var readOnlyNonRecursive: kotlin.Boolean? = false, + // Raise an error if the mount cannot be made recursively read-only. + @Json(name = "ReadOnlyForceRecursive") + var readOnlyForceRecursive: kotlin.Boolean? = false, +) { + /** + * A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + * + * Values: Private,Rprivate,Shared,Rshared,Slave,Rslave + */ + @JsonClass(generateAdapter = false) + enum class Propagation(val value: kotlin.String) { + @Json(name = "private") + Private("private"), + + @Json(name = "rprivate") + Rprivate("rprivate"), + + @Json(name = "shared") + Shared("shared"), + + @Json(name = "rshared") + Rshared("rshared"), + + @Json(name = "slave") + Slave("slave"), + + @Json(name = "rslave") + Rslave("rslave"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt new file mode 100644 index 00000000..3a6a1e7d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt @@ -0,0 +1,82 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container. + * + * @param type The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume + * @param name Name is the name reference to the underlying data defined by `Source` e.g., the volume name. + * @param source Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. + * @param destination Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. + * @param driver Driver is the volume driver used to create the volume (if it is a volume). + * @param mode Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). + * @param RW Whether the mount is mounted writable (read-write). + * @param propagation Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. + */ +@JsonClass(generateAdapter = true) +data class MountPoint( + // The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume + @Json(name = "Type") + var type: MountPoint.Type? = null, + // Name is the name reference to the underlying data defined by `Source` e.g., the volume name. + @Json(name = "Name") + var name: kotlin.String? = null, + // Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. + @Json(name = "Source") + var source: kotlin.String? = null, + // Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. + @Json(name = "Destination") + var destination: kotlin.String? = null, + // Driver is the volume driver used to create the volume (if it is a volume). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). + @Json(name = "Mode") + var mode: kotlin.String? = null, + // Whether the mount is mounted writable (read-write). + @Json(name = "RW") + var RW: kotlin.Boolean? = null, + // Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. + @Json(name = "Propagation") + var propagation: kotlin.String? = null, +) { + /** + * The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume + * + * Values: Bind,Volume,Tmpfs,Npipe,Cluster + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "bind") + Bind("bind"), + + @Json(name = "volume") + Volume("volume"), + + @Json(name = "tmpfs") + Tmpfs("tmpfs"), + + @Json(name = "npipe") + Npipe("npipe"), + + @Json(name = "cluster") + Cluster("cluster"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt new file mode 100644 index 00000000..09903e8a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `tmpfs` type. + * + * @param sizeBytes The size for the tmpfs mount in bytes. + * @param mode The permission mode for the tmpfs mount in an integer. + */ +@JsonClass(generateAdapter = true) +data class MountTmpfsOptions( + // The size for the tmpfs mount in bytes. + @Json(name = "SizeBytes") + var sizeBytes: kotlin.Long? = null, + // The permission mode for the tmpfs mount in an integer. + @Json(name = "Mode") + var mode: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt new file mode 100644 index 00000000..0fa3a7a6 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt @@ -0,0 +1,38 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `volume` type. + * + * @param noCopy Populate volume with data from the target. + * @param labels User-defined key/value metadata. + * @param driverConfig + */ +@JsonClass(generateAdapter = true) +data class MountVolumeOptions( + // Populate volume with data from the target. + @Json(name = "NoCopy") + var noCopy: kotlin.Boolean? = false, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "DriverConfig") + var driverConfig: MountVolumeOptionsDriverConfig? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt new file mode 100644 index 00000000..3b8d0ab9 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Map of driver specific options + * + * @param name Name of the driver to use to create the volume. + * @param options key/value map of driver specific options. + */ +@JsonClass(generateAdapter = true) +data class MountVolumeOptionsDriverConfig( + // Name of the driver to use to create the volume. + @Json(name = "Name") + var name: kotlin.String? = null, + // key/value map of driver specific options. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt new file mode 100644 index 00000000..628271a7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt @@ -0,0 +1,89 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the network. + * @param id ID that uniquely identifies a network on a single machine. + * @param created Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param scope The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + * @param driver The name of the driver used to create the network (e.g. `bridge`, `overlay`). + * @param enableIPv6 Whether the network was created with IPv6 enabled. + * @param IPAM + * @param `internal` Whether the network is created to only allow internal networking connectivity. + * @param attachable Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + * @param ingress Whether the network is providing the routing-mesh for the swarm cluster. + * @param configFrom + * @param configOnly Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + * @param containers Contains endpoints attached to the network. + * @param options Network-specific options uses when creating the network. + * @param labels User-defined key/value metadata. + * @param peers List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + */ +@JsonClass(generateAdapter = true) +data class Network( + // Name of the network. + @Json(name = "Name") + var name: kotlin.String? = null, + // ID that uniquely identifies a network on a single machine. + @Json(name = "Id") + var id: kotlin.String? = null, + // Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Created") + var created: kotlin.String? = null, + // The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + @Json(name = "Scope") + var scope: kotlin.String? = null, + // The name of the driver used to create the network (e.g. `bridge`, `overlay`). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Whether the network was created with IPv6 enabled. + @Json(name = "EnableIPv6") + var enableIPv6: kotlin.Boolean? = null, + @Json(name = "IPAM") + var IPAM: IPAM? = null, + // Whether the network is created to only allow internal networking connectivity. + @Json(name = "Internal") + var `internal`: kotlin.Boolean? = false, + // Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + @Json(name = "Attachable") + var attachable: kotlin.Boolean? = false, + // Whether the network is providing the routing-mesh for the swarm cluster. + @Json(name = "Ingress") + var ingress: kotlin.Boolean? = false, + @Json(name = "ConfigFrom") + var configFrom: ConfigReference? = null, + // Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + @Json(name = "ConfigOnly") + var configOnly: kotlin.Boolean? = false, + // Contains endpoints attached to the network. + @Json(name = "Containers") + var containers: kotlin.collections.MutableMap? = null, + // Network-specific options uses when creating the network. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + @Json(name = "Peers") + var peers: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt new file mode 100644 index 00000000..fcfeecbf --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specifies how a service should be attached to a particular network. + * + * @param target The target network for attachment. Must be a network name or ID. + * @param aliases Discoverable alternate names for the service on this network. + * @param driverOpts Driver attachment options for the network target. + */ +@JsonClass(generateAdapter = true) +data class NetworkAttachmentConfig( + // The target network for attachment. Must be a network name or ID. + @Json(name = "Target") + var target: kotlin.String? = null, + // Discoverable alternate names for the service on this network. + @Json(name = "Aliases") + var aliases: kotlin.collections.MutableList? = null, + // Driver attachment options for the network target. + @Json(name = "DriverOpts") + var driverOpts: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt new file mode 100644 index 00000000..b80d02cb --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param container The ID or name of the container to connect to the network. + * @param endpointConfig + */ +@JsonClass(generateAdapter = true) +data class NetworkConnectRequest( + // The ID or name of the container to connect to the network. + @Json(name = "Container") + var container: kotlin.String? = null, + @Json(name = "EndpointConfig") + var endpointConfig: EndpointSettings? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt new file mode 100644 index 00000000..20d8e24c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param endpointID + * @param macAddress + * @param ipv4Address + * @param ipv6Address + */ +@JsonClass(generateAdapter = true) +data class NetworkContainer( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "EndpointID") + var endpointID: kotlin.String? = null, + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + @Json(name = "IPv4Address") + var ipv4Address: kotlin.String? = null, + @Json(name = "IPv6Address") + var ipv6Address: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt new file mode 100644 index 00000000..fe8b400c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt @@ -0,0 +1,77 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name The network's name. + * @param checkDuplicate Deprecated: CheckDuplicate is now always enabled. + * @param driver Name of the network driver plugin to use. + * @param scope The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level). + * @param `internal` Restrict external access to the network. + * @param attachable Globally scoped network is manually attachable by regular containers from workers in swarm mode. + * @param ingress Ingress network is the network which provides the routing-mesh in swarm mode. + * @param configOnly Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + * @param configFrom + * @param IPAM + * @param enableIPv6 Enable IPv6 on the network. + * @param options Network specific options to be used by the drivers. + * @param labels User-defined key/value metadata. + */ +@JsonClass(generateAdapter = true) +data class NetworkCreateRequest( + // The network's name. + @Json(name = "Name") + var name: kotlin.String, + // Deprecated: CheckDuplicate is now always enabled. + @Json(name = "CheckDuplicate") + var checkDuplicate: kotlin.Boolean? = null, + // Name of the network driver plugin to use. + @Json(name = "Driver") + var driver: kotlin.String? = "bridge", + // The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level). + @Json(name = "Scope") + var scope: kotlin.String? = null, + // Restrict external access to the network. + @Json(name = "Internal") + var `internal`: kotlin.Boolean? = null, + // Globally scoped network is manually attachable by regular containers from workers in swarm mode. + @Json(name = "Attachable") + var attachable: kotlin.Boolean? = null, + // Ingress network is the network which provides the routing-mesh in swarm mode. + @Json(name = "Ingress") + var ingress: kotlin.Boolean? = null, + // Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + @Json(name = "ConfigOnly") + var configOnly: kotlin.Boolean? = false, + @Json(name = "ConfigFrom") + var configFrom: ConfigReference? = null, + @Json(name = "IPAM") + var IPAM: IPAM? = null, + // Enable IPv6 on the network. + @Json(name = "EnableIPv6") + var enableIPv6: kotlin.Boolean? = null, + // Network specific options to be used by the drivers. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt new file mode 100644 index 00000000..3429f216 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id The ID of the created network. + * @param warning + */ +@JsonClass(generateAdapter = true) +data class NetworkCreateResponse( + // The ID of the created network. + @Json(name = "Id") + var id: kotlin.String? = null, + @Json(name = "Warning") + var warning: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt new file mode 100644 index 00000000..fc94cc23 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param container The ID or name of the container to disconnect from the network. + * @param force Force the container to disconnect from the network. + */ +@JsonClass(generateAdapter = true) +data class NetworkDisconnectRequest( + // The ID or name of the container to disconnect from the network. + @Json(name = "Container") + var container: kotlin.String? = null, + // Force the container to disconnect from the network. + @Json(name = "Force") + var force: kotlin.Boolean? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt new file mode 100644 index 00000000..5d84de59 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param networksDeleted Networks that were deleted + */ +@JsonClass(generateAdapter = true) +data class NetworkPruneResponse( + // Networks that were deleted + @Json(name = "NetworksDeleted") + var networksDeleted: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt new file mode 100644 index 00000000..06fc1042 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt @@ -0,0 +1,99 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NetworkSettings exposes the network settings in the API + * + * @param bridge Name of the default bridge interface when dockerd's --bridge flag is set. + * @param sandboxID SandboxID uniquely represents a container's network stack. + * @param hairpinMode Indicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release. + * @param linkLocalIPv6Address IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release. + * @param linkLocalIPv6PrefixLen Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release. + * @param ports PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + * @param sandboxKey SandboxKey is the full path of the netns handle + * @param secondaryIPAddresses Deprecated: This field is never set and will be removed in a future release. + * @param secondaryIPv6Addresses Deprecated: This field is never set and will be removed in a future release. + * @param endpointID EndpointID uniquely represents a service endpoint in a Sandbox.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param gateway Gateway address for the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param globalIPv6Address Global IPv6 address for the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param globalIPv6PrefixLen Mask length of the global IPv6 address.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param ipAddress IPv4 address for the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param ipPrefixLen Mask length of the IPv4 address.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param ipv6Gateway IPv6 gateway address for this network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param macAddress MAC address for the container on the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + * @param networks Information about all networks that the container is connected to. + */ +@JsonClass(generateAdapter = true) +data class NetworkSettings( + // Name of the default bridge interface when dockerd's --bridge flag is set. + @Json(name = "Bridge") + var bridge: kotlin.String? = null, + // SandboxID uniquely represents a container's network stack. + @Json(name = "SandboxID") + var sandboxID: kotlin.String? = null, + // Indicates if hairpin NAT should be enabled on the virtual interface. Deprecated: This field is never set and will be removed in a future release. + @Json(name = "HairpinMode") + var hairpinMode: kotlin.Boolean? = null, + // IPv6 unicast address using the link-local prefix. Deprecated: This field is never set and will be removed in a future release. + @Json(name = "LinkLocalIPv6Address") + var linkLocalIPv6Address: kotlin.String? = null, + // Prefix length of the IPv6 unicast address. Deprecated: This field is never set and will be removed in a future release. + @Json(name = "LinkLocalIPv6PrefixLen") + var linkLocalIPv6PrefixLen: kotlin.Int? = null, + // PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + @Json(name = "Ports") + var ports: kotlin.collections.MutableMap>? = null, + // SandboxKey is the full path of the netns handle + @Json(name = "SandboxKey") + var sandboxKey: kotlin.String? = null, + // Deprecated: This field is never set and will be removed in a future release. + @Json(name = "SecondaryIPAddresses") + var secondaryIPAddresses: kotlin.collections.MutableList
? = null, + // Deprecated: This field is never set and will be removed in a future release. + @Json(name = "SecondaryIPv6Addresses") + var secondaryIPv6Addresses: kotlin.collections.MutableList
? = null, + // EndpointID uniquely represents a service endpoint in a Sandbox.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "EndpointID") + var endpointID: kotlin.String? = null, + // Gateway address for the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "Gateway") + var gateway: kotlin.String? = null, + // Global IPv6 address for the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "GlobalIPv6Address") + var globalIPv6Address: kotlin.String? = null, + // Mask length of the global IPv6 address.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "GlobalIPv6PrefixLen") + var globalIPv6PrefixLen: kotlin.Int? = null, + // IPv4 address for the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "IPAddress") + var ipAddress: kotlin.String? = null, + // Mask length of the IPv4 address.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "IPPrefixLen") + var ipPrefixLen: kotlin.Int? = null, + // IPv6 gateway address for this network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "IPv6Gateway") + var ipv6Gateway: kotlin.String? = null, + // MAC address for the container on the default \"bridge\" network.


> **Deprecated**: This field is only propagated when attached to the > default \"bridge\" network. Use the information from the \"bridge\" > network inside the `Networks` map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0 + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + // Information about all networks that the container is connected to. + @Json(name = "Networks") + var networks: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt new file mode 100644 index 00000000..0d210e17 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the `docker create` and `docker network connect` commands. + * + * @param endpointsConfig A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. + */ +@JsonClass(generateAdapter = true) +data class NetworkingConfig( + // A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. + @Json(name = "EndpointsConfig") + var endpointsConfig: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt new file mode 100644 index 00000000..53f96c24 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt @@ -0,0 +1,53 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param updatedAt Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param spec + * @param description + * @param status + * @param managerStatus + */ +@JsonClass(generateAdapter = true) +data class Node( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + // Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: NodeSpec? = null, + @Json(name = "Description") + var description: NodeDescription? = null, + @Json(name = "Status") + var status: NodeStatus? = null, + @Json(name = "ManagerStatus") + var managerStatus: ManagerStatus? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt new file mode 100644 index 00000000..4b776f52 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NodeDescription encapsulates the properties of the Node as reported by the agent. + * + * @param hostname + * @param platform + * @param resources + * @param engine + * @param tlSInfo + */ +@JsonClass(generateAdapter = true) +data class NodeDescription( + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + @Json(name = "Platform") + var platform: Platform? = null, + @Json(name = "Resources") + var resources: ResourceObject? = null, + @Json(name = "Engine") + var engine: EngineDescription? = null, + @Json(name = "TLSInfo") + var tlSInfo: TLSInfo? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt new file mode 100644 index 00000000..fd067316 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt @@ -0,0 +1,74 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name for the node. + * @param labels User-defined key/value metadata. + * @param role Role of the node. + * @param availability Availability of the node. + */ +@JsonClass(generateAdapter = true) +data class NodeSpec( + // Name for the node. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Role of the node. + @Json(name = "Role") + var role: NodeSpec.Role? = null, + // Availability of the node. + @Json(name = "Availability") + var availability: NodeSpec.Availability? = null, +) { + /** + * Role of the node. + * + * Values: Worker,Manager + */ + @JsonClass(generateAdapter = false) + enum class Role(val value: kotlin.String) { + @Json(name = "worker") + Worker("worker"), + + @Json(name = "manager") + Manager("manager"), + } + + /** + * Availability of the node. + * + * Values: Active,Pause,Drain + */ + @JsonClass(generateAdapter = false) + enum class Availability(val value: kotlin.String) { + @Json(name = "active") + Active("active"), + + @Json(name = "pause") + Pause("pause"), + + @Json(name = "drain") + Drain("drain"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt new file mode 100644 index 00000000..f3d578e6 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt @@ -0,0 +1,68 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NodeState represents the state of a node. + * + * Values: Unknown,Down,Ready,Disconnected + */ + +@JsonClass(generateAdapter = false) +enum class NodeState(val value: kotlin.String) { + @Json(name = "unknown") + Unknown("unknown"), + + @Json(name = "down") + Down("down"), + + @Json(name = "ready") + Ready("ready"), + + @Json(name = "disconnected") + Disconnected("disconnected"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is NodeState) "$data" else null + + /** + * Returns a valid [NodeState] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): NodeState? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt new file mode 100644 index 00000000..ec24fa70 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NodeStatus represents the status of a node. It provides the current status of the node, as seen by the manager. + * + * @param state + * @param message + * @param addr IP address of the node. + */ +@JsonClass(generateAdapter = true) +data class NodeStatus( + @Json(name = "State") + var state: NodeState? = null, + @Json(name = "Message") + var message: kotlin.String? = null, + // IP address of the node. + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt new file mode 100644 index 00000000..cf632bd3 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * 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 propertySize The size in bytes of the blob. + */ +@JsonClass(generateAdapter = true) +data class OCIDescriptor( + // The media type of the object this schema refers to. + @Json(name = "mediaType") + var mediaType: kotlin.String? = null, + // The digest of the targeted content. + @Json(name = "digest") + var digest: kotlin.String? = null, + // The size in bytes of the blob. + @Json(name = "size") + var propertySize: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt new file mode 100644 index 00000000..4cccb7dc --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * 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 OCIPlatform( + // The CPU architecture, for example `amd64` or `ppc64`. + @Json(name = "architecture") + var architecture: kotlin.String? = null, + // The operating system, for example `linux` or `windows`. + @Json(name = "os") + var os: kotlin.String? = null, + // Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. + @Json(name = "os.version") + var osVersion: kotlin.String? = null, + // Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). + @Json(name = "os.features") + var osFeatures: kotlin.collections.MutableList? = null, + // Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. + @Json(name = "variant") + var variant: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt new file mode 100644 index 00000000..bb53783f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other. + * + * @param index + */ +@JsonClass(generateAdapter = true) +data class ObjectVersion( + @Json(name = "Index") + var index: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt new file mode 100644 index 00000000..a1e8cf88 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * PeerInfo represents one peer of an overlay network. + * + * @param name ID of the peer-node in the Swarm cluster. + * @param IP IP-address of the peer-node in the Swarm cluster. + */ +@JsonClass(generateAdapter = true) +data class PeerInfo( + // ID of the peer-node in the Swarm cluster. + @Json(name = "Name") + var name: kotlin.String? = null, + // IP-address of the peer-node in the Swarm cluster. + @Json(name = "IP") + var IP: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt new file mode 100644 index 00000000..58ce4588 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Represents a peer-node in the swarm + * + * @param nodeID Unique identifier of for this node in the swarm. + * @param addr IP address and ports at which this node can be reached. + */ +@JsonClass(generateAdapter = true) +data class PeerNode( + // Unique identifier of for this node in the swarm. + @Json(name = "NodeID") + var nodeID: kotlin.String? = null, + // IP address and ports at which this node can be reached. + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt new file mode 100644 index 00000000..b52d4bab --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Platform represents the platform (Arch/OS). + * + * @param architecture Architecture represents the hardware architecture (for example, `x86_64`). + * @param OS OS represents the Operating System (for example, `linux` or `windows`). + */ +@JsonClass(generateAdapter = true) +data class Platform( + // Architecture represents the hardware architecture (for example, `x86_64`). + @Json(name = "Architecture") + var architecture: kotlin.String? = null, + // OS represents the Operating System (for example, `linux` or `windows`). + @Json(name = "OS") + var OS: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt new file mode 100644 index 00000000..575ddd27 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A plugin for the Engine API + * + * @param name + * @param enabled True if the plugin is running. False if the plugin is not running, only installed. + * @param settings + * @param config + * @param id + * @param pluginReference plugin remote reference used to push/pull the plugin + */ +@JsonClass(generateAdapter = true) +data class Plugin( + @Json(name = "Name") + var name: kotlin.String, + // True if the plugin is running. False if the plugin is not running, only installed. + @Json(name = "Enabled") + var enabled: kotlin.Boolean, + @Json(name = "Settings") + var settings: PluginSettings, + @Json(name = "Config") + var config: PluginConfig, + @Json(name = "Id") + var id: kotlin.String? = null, + // plugin remote reference used to push/pull the plugin + @Json(name = "PluginReference") + var pluginReference: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt new file mode 100644 index 00000000..79f0d5cc --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt @@ -0,0 +1,76 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The config of a plugin. + * + * @param description + * @param documentation + * @param `interface` + * @param entrypoint + * @param workDir + * @param network + * @param linux + * @param propagatedMount + * @param ipcHost + * @param pidHost + * @param mounts + * @param env + * @param args + * @param dockerVersion Docker Version used to create the plugin + * @param user + * @param rootfs + */ +@JsonClass(generateAdapter = true) +data class PluginConfig( + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Documentation") + var documentation: kotlin.String, + @Json(name = "Interface") + var `interface`: PluginConfigInterface, + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList, + @Json(name = "WorkDir") + var workDir: kotlin.String, + @Json(name = "Network") + var network: PluginConfigNetwork, + @Json(name = "Linux") + var linux: PluginConfigLinux, + @Json(name = "PropagatedMount") + var propagatedMount: kotlin.String, + @Json(name = "IpcHost") + var ipcHost: kotlin.Boolean, + @Json(name = "PidHost") + var pidHost: kotlin.Boolean, + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList, + @Json(name = "Env") + var env: kotlin.collections.MutableList, + @Json(name = "Args") + var args: PluginConfigArgs, + // Docker Version used to create the plugin + @Json(name = "DockerVersion") + var dockerVersion: kotlin.String? = null, + @Json(name = "User") + var user: PluginConfigUser? = null, + @Json(name = "rootfs") + var rootfs: PluginConfigRootfs? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt new file mode 100644 index 00000000..706830ad --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class PluginConfigArgs( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Value") + var `value`: kotlin.collections.MutableList, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt new file mode 100644 index 00000000..c676fd55 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The interface between Docker and the plugin + * + * @param types + * @param socket + * @param protocolScheme Protocol to use for clients connecting to the plugin. + */ +@JsonClass(generateAdapter = true) +data class PluginConfigInterface( + @Json(name = "Types") + var types: kotlin.collections.MutableList, + @Json(name = "Socket") + var socket: kotlin.String, + // Protocol to use for clients connecting to the plugin. + @Json(name = "ProtocolScheme") + var protocolScheme: PluginConfigInterface.ProtocolScheme? = null, +) { + /** + * Protocol to use for clients connecting to the plugin. + * + * Values: EMPTY,MobyPeriodPluginsPeriodHttpSlashV1 + */ + @JsonClass(generateAdapter = false) + enum class ProtocolScheme(val value: kotlin.String) { + @Json(name = "") + EMPTY(""), + + @Json(name = "moby.plugins.http/v1") + MobyPeriodPluginsPeriodHttpSlashV1("moby.plugins.http/v1"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt new file mode 100644 index 00000000..9fb7723d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param capabilities + * @param allowAllDevices + * @param devices + */ +@JsonClass(generateAdapter = true) +data class PluginConfigLinux( + @Json(name = "Capabilities") + var capabilities: kotlin.collections.MutableList, + @Json(name = "AllowAllDevices") + var allowAllDevices: kotlin.Boolean, + @Json(name = "Devices") + var devices: kotlin.collections.MutableList, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt new file mode 100644 index 00000000..bcb6ee9d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param type + */ +@JsonClass(generateAdapter = true) +data class PluginConfigNetwork( + @Json(name = "Type") + var type: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt new file mode 100644 index 00000000..702b9d31 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param type + * @param diffIds + */ +@JsonClass(generateAdapter = true) +data class PluginConfigRootfs( + @Json(name = "type") + var type: kotlin.String? = null, + @Json(name = "diff_ids") + var diffIds: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt new file mode 100644 index 00000000..214dab67 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param UID + * @param GID + */ +@JsonClass(generateAdapter = true) +data class PluginConfigUser( + @Json(name = "UID") + var UID: kotlin.Int? = null, + @Json(name = "GID") + var GID: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt new file mode 100644 index 00000000..81fd97e5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param path + */ +@JsonClass(generateAdapter = true) +data class PluginDevice( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Path") + var path: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt new file mode 100644 index 00000000..d7eb7339 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class PluginEnv( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Value") + var `value`: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt new file mode 100644 index 00000000..e00314b2 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param prefix + * @param capability + * @param version + */ +@JsonClass(generateAdapter = true) +data class PluginInterfaceType( + @Json(name = "Prefix") + var prefix: kotlin.String, + @Json(name = "Capability") + var capability: kotlin.String, + @Json(name = "Version") + var version: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt new file mode 100644 index 00000000..e48cde1d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt @@ -0,0 +1,48 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param source + * @param destination + * @param type + * @param options + */ +@JsonClass(generateAdapter = true) +data class PluginMount( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Source") + var source: kotlin.String, + @Json(name = "Destination") + var destination: kotlin.String, + @Json(name = "Type") + var type: kotlin.String, + @Json(name = "Options") + var options: kotlin.collections.MutableList, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt new file mode 100644 index 00000000..79ee4629 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Describes a permission the user has to accept upon installing the plugin. + * + * @param name + * @param description + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class PluginPrivilege( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "Description") + var description: kotlin.String? = null, + @Json(name = "Value") + var `value`: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt new file mode 100644 index 00000000..a1ceff86 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Settings that can be modified by users. + * + * @param mounts + * @param env + * @param args + * @param devices + */ +@JsonClass(generateAdapter = true) +data class PluginSettings( + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList, + @Json(name = "Env") + var env: kotlin.collections.MutableList, + @Json(name = "Args") + var args: kotlin.collections.MutableList, + @Json(name = "Devices") + var devices: kotlin.collections.MutableList, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt new file mode 100644 index 00000000..fc28f877 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Available plugins per type.


> **Note**: Only unmanaged (V1) plugins are included in this list. > V1 plugins are \"lazily\" loaded, and are not returned in this list > if there is no resource using the plugin. + * + * @param volume Names of available volume-drivers, and network-driver plugins. + * @param network Names of available network-drivers, and network-driver plugins. + * @param authorization Names of available authorization plugins. + * @param log Names of available logging-drivers, and logging-driver plugins. + */ +@JsonClass(generateAdapter = true) +data class PluginsInfo( + // Names of available volume-drivers, and network-driver plugins. + @Json(name = "Volume") + var volume: kotlin.collections.MutableList? = null, + // Names of available network-drivers, and network-driver plugins. + @Json(name = "Network") + var network: kotlin.collections.MutableList? = null, + // Names of available authorization plugins. + @Json(name = "Authorization") + var authorization: kotlin.collections.MutableList? = null, + // Names of available logging-drivers, and logging-driver plugins. + @Json(name = "Log") + var log: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt new file mode 100644 index 00000000..64e5eb71 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * An open port on a container + * + * @param privatePort Port on the container + * @param type + * @param IP Host IP address that the container's port is mapped to + * @param publicPort Port exposed on the host + */ +@JsonClass(generateAdapter = true) +data class Port( + // Port on the container + @Json(name = "PrivatePort") + var privatePort: kotlin.Int, + @Json(name = "Type") + var type: Port.Type, + // Host IP address that the container's port is mapped to + @Json(name = "IP") + var IP: kotlin.String? = null, + // Port exposed on the host + @Json(name = "PublicPort") + var publicPort: kotlin.Int? = null, +) { + /** + * + * + * Values: Tcp,Udp,Sctp + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "tcp") + Tcp("tcp"), + + @Json(name = "udp") + Udp("udp"), + + @Json(name = "sctp") + Sctp("sctp"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt new file mode 100644 index 00000000..52f217a3 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * PortBinding represents a binding between a host IP address and a host port. + * + * @param hostIp Host IP address that the container's port is mapped to. + * @param hostPort Host port number that the container's port is mapped to. + */ +@JsonClass(generateAdapter = true) +data class PortBinding( + // Host IP address that the container's port is mapped to. + @Json(name = "HostIp") + var hostIp: kotlin.String? = null, + // Host port number that the container's port is mapped to. + @Json(name = "HostPort") + var hostPort: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt new file mode 100644 index 00000000..10c1cb5d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents the port status of a task's host ports whose service has published host ports + * + * @param ports + */ +@JsonClass(generateAdapter = true) +data class PortStatus( + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt new file mode 100644 index 00000000..9ed2b6a5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param privileged + * @param user + * @param tty + * @param entrypoint + * @param arguments + */ +@JsonClass(generateAdapter = true) +data class ProcessConfig( + @Json(name = "privileged") + var privileged: kotlin.Boolean? = null, + @Json(name = "user") + var user: kotlin.String? = null, + @Json(name = "tty") + var tty: kotlin.Boolean? = null, + @Json(name = "entrypoint") + var entrypoint: kotlin.String? = null, + @Json(name = "arguments") + var arguments: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt new file mode 100644 index 00000000..86795046 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param current + * @param total + */ +@JsonClass(generateAdapter = true) +data class ProgressDetail( + @Json(name = "current") + var current: kotlin.Int? = null, + @Json(name = "total") + var total: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt new file mode 100644 index 00000000..798fe956 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param error + * @param status + * @param progress + * @param progressDetail + */ +@JsonClass(generateAdapter = true) +data class PushImageInfo( + @Json(name = "error") + var error: kotlin.String? = null, + @Json(name = "status") + var status: kotlin.String? = null, + @Json(name = "progress") + var progress: kotlin.String? = null, + @Json(name = "progressDetail") + var progressDetail: ProgressDetail? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt new file mode 100644 index 00000000..d0a61bd8 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt @@ -0,0 +1,65 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Reachability represents the reachability of a node. + * + * Values: Unknown,Unreachable,Reachable + */ + +@JsonClass(generateAdapter = false) +enum class Reachability(val value: kotlin.String) { + @Json(name = "unknown") + Unknown("unknown"), + + @Json(name = "unreachable") + Unreachable("unreachable"), + + @Json(name = "reachable") + Reachable("reachable"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is Reachability) "$data" else null + + /** + * Returns a valid [Reachability] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): Reachability? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt new file mode 100644 index 00000000..6dabfc3b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt @@ -0,0 +1,46 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * RegistryServiceConfig stores daemon registry services configuration. + * + * @param allowNondistributableArtifactsCIDRs List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632).


> **Deprecated**: Pushing nondistributable artifacts is now always enabled > and this field is always `null`. + * @param allowNondistributableArtifactsHostnames List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`.


> **Deprecated**: Pushing nondistributable artifacts is now always enabled > and this field is always `null`. + * @param insecureRegistryCIDRs List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. + * @param indexConfigs + * @param mirrors List of registry URLs that act as a mirror for the official (`docker.io`) registry. + */ +@JsonClass(generateAdapter = true) +data class RegistryServiceConfig( + // List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632).


> **Deprecated**: Pushing nondistributable artifacts is now always enabled > and this field is always `null`. + @Json(name = "AllowNondistributableArtifactsCIDRs") + var allowNondistributableArtifactsCIDRs: kotlin.collections.MutableList? = null, + // List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`.


> **Deprecated**: Pushing nondistributable artifacts is now always enabled > and this field is always `null`. + @Json(name = "AllowNondistributableArtifactsHostnames") + var allowNondistributableArtifactsHostnames: kotlin.collections.MutableList? = null, + // List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. + @Json(name = "InsecureRegistryCIDRs") + var insecureRegistryCIDRs: kotlin.collections.MutableList? = null, + @Json(name = "IndexConfigs") + var indexConfigs: kotlin.collections.MutableMap? = null, + // List of registry URLs that act as a mirror for the official (`docker.io`) registry. + @Json(name = "Mirrors") + var mirrors: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt new file mode 100644 index 00000000..78b6426d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * An object describing the resources which can be advertised by a node and requested by a task. + * + * @param nanoCPUs + * @param memoryBytes + * @param genericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + */ +@JsonClass(generateAdapter = true) +data class ResourceObject( + @Json(name = "NanoCPUs") + var nanoCPUs: kotlin.Long? = null, + @Json(name = "MemoryBytes") + var memoryBytes: kotlin.Long? = null, + // User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + @Json(name = "GenericResources") + var genericResources: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt new file mode 100644 index 00000000..e86b9aae --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt @@ -0,0 +1,151 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A container's resources (cgroups config, ulimits, etc) + * + * @param cpuShares An integer value representing this container's relative CPU weight versus other containers. + * @param memory Memory limit in bytes. + * @param cgroupParent Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + * @param blkioWeight Block IO weight (relative weight). + * @param blkioWeightDevice Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + * @param blkioDeviceReadBps Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteBps Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceReadIOps Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteIOps Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param cpuPeriod The length of a CPU period in microseconds. + * @param cpuQuota Microseconds of CPU time that the container can get in a CPU period. + * @param cpuRealtimePeriod The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpuRealtimeRuntime The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpusetCpus CPUs in which to allow execution (e.g., `0-3`, `0,1`). + * @param cpusetMems Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + * @param devices A list of devices to add to the container. + * @param deviceCgroupRules a list of cgroup rules to apply to the container + * @param deviceRequests A list of requests for devices to be sent to device drivers. + * @param kernelMemoryTCP Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. + * @param memoryReservation Memory soft limit in bytes. + * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + * @param nanoCpus CPU quota in units of 10-9 CPUs. + * @param oomKillDisable Disable OOM Killer for the container. + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param pidsLimit Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + * @param ulimits A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + * @param cpuCount The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param cpuPercent The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param ioMaximumIOps Maximum IOps for the container system drive (Windows only) + * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). + */ +@JsonClass(generateAdapter = true) +data class Resources( + // An integer value representing this container's relative CPU weight versus other containers. + @Json(name = "CpuShares") + var cpuShares: kotlin.Int? = null, + // Memory limit in bytes. + @Json(name = "Memory") + var memory: kotlin.Long? = 0L, + // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + @Json(name = "CgroupParent") + var cgroupParent: kotlin.String? = null, + // Block IO weight (relative weight). + @Json(name = "BlkioWeight") + var blkioWeight: kotlin.Int? = null, + // Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + @Json(name = "BlkioWeightDevice") + var blkioWeightDevice: kotlin.collections.MutableList? = null, + // Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadBps") + var blkioDeviceReadBps: kotlin.collections.MutableList? = null, + // Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteBps") + var blkioDeviceWriteBps: kotlin.collections.MutableList? = null, + // Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadIOps") + var blkioDeviceReadIOps: kotlin.collections.MutableList? = null, + // Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteIOps") + var blkioDeviceWriteIOps: kotlin.collections.MutableList? = null, + // The length of a CPU period in microseconds. + @Json(name = "CpuPeriod") + var cpuPeriod: kotlin.Long? = null, + // Microseconds of CPU time that the container can get in a CPU period. + @Json(name = "CpuQuota") + var cpuQuota: kotlin.Long? = null, + // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimePeriod") + var cpuRealtimePeriod: kotlin.Long? = null, + // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimeRuntime") + var cpuRealtimeRuntime: kotlin.Long? = null, + // CPUs in which to allow execution (e.g., `0-3`, `0,1`). + @Json(name = "CpusetCpus") + var cpusetCpus: kotlin.String? = null, + // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + @Json(name = "CpusetMems") + var cpusetMems: kotlin.String? = null, + // A list of devices to add to the container. + @Json(name = "Devices") + var devices: kotlin.collections.MutableList? = null, + // a list of cgroup rules to apply to the container + @Json(name = "DeviceCgroupRules") + var deviceCgroupRules: kotlin.collections.MutableList? = null, + // A list of requests for devices to be sent to device drivers. + @Json(name = "DeviceRequests") + var deviceRequests: kotlin.collections.MutableList? = null, + // Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. + @Json(name = "KernelMemoryTCP") + var kernelMemoryTCP: kotlin.Long? = null, + // Memory soft limit in bytes. + @Json(name = "MemoryReservation") + var memoryReservation: kotlin.Long? = null, + // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + @Json(name = "MemorySwap") + var memorySwap: kotlin.Long? = null, + // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, + // CPU quota in units of 10-9 CPUs. + @Json(name = "NanoCpus") + var nanoCpus: kotlin.Long? = null, + // Disable OOM Killer for the container. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Long? = null, + // A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, + // The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuCount") + var cpuCount: kotlin.Long? = null, + // The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuPercent") + var cpuPercent: kotlin.Long? = null, + // Maximum IOps for the container system drive (Windows only) + @Json(name = "IOMaximumIOps") + var ioMaximumIOps: kotlin.Long? = null, + // Maximum IO in bytes per second for the container system drive (Windows only). + @Json(name = "IOMaximumBandwidth") + var ioMaximumBandwidth: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt new file mode 100644 index 00000000..007f3f33 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param path + * @param weight + */ +@JsonClass(generateAdapter = true) +data class ResourcesBlkioWeightDeviceInner( + @Json(name = "Path") + var path: kotlin.String? = null, + @Json(name = "Weight") + var weight: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt new file mode 100644 index 00000000..b2c427a1 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of ulimit + * @param soft Soft limit + * @param hard Hard limit + */ +@JsonClass(generateAdapter = true) +data class ResourcesUlimitsInner( + // Name of ulimit + @Json(name = "Name") + var name: kotlin.String? = null, + // Soft limit + @Json(name = "Soft") + var soft: kotlin.Int? = null, + // Hard limit + @Json(name = "Hard") + var hard: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt new file mode 100644 index 00000000..2101db69 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt @@ -0,0 +1,58 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +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 - `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 - `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") + var name: RestartPolicy.Name? = null, + // If `on-failure` is used, the number of times to retry before giving up. + @Json(name = "MaximumRetryCount") + var maximumRetryCount: kotlin.Int? = null, +) { + /** + * - 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,UnlessStopped,OnFailure + */ + @JsonClass(generateAdapter = false) + enum class Name(val value: kotlin.String) { + @Json(name = "") + EMPTY(""), + + @Json(name = "no") + No("no"), + + @Json(name = "always") + Always("always"), + + @Json(name = "unless-stopped") + UnlessStopped("unless-stopped"), + + @Json(name = "on-failure") + OnFailure("on-failure"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt new file mode 100644 index 00000000..8ba7ba52 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime. The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux. + * + * @param path Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + * @param runtimeArgs List of command-line arguments to pass to the runtime when invoked. + * @param status Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + */ +@JsonClass(generateAdapter = true) +data class Runtime( + // Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + @Json(name = "path") + var path: kotlin.String? = null, + // List of command-line arguments to pass to the runtime when invoked. + @Json(name = "runtimeArgs") + var runtimeArgs: kotlin.collections.MutableList? = null, + // Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + @Json(name = "status") + var status: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt new file mode 100644 index 00000000..2a4c8cf9 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt + * @param updatedAt + * @param spec + */ +@JsonClass(generateAdapter = true) +data class Secret( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: SecretSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt new file mode 100644 index 00000000..5d90b996 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the secret. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + * @param driver + * @param templating + */ +@JsonClass(generateAdapter = true) +data class SecretCreateRequest( + // User-defined name of the secret. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Driver") + var driver: Driver? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt new file mode 100644 index 00000000..bd21501a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the secret. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + * @param driver + * @param templating + */ +@JsonClass(generateAdapter = true) +data class SecretSpec( + // User-defined name of the secret. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Driver") + var driver: Driver? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt new file mode 100644 index 00000000..0e09952c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt + * @param updatedAt + * @param spec + * @param endpoint + * @param updateStatus + * @param serviceStatus + * @param jobStatus + */ +@JsonClass(generateAdapter = true) +data class Service( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: ServiceSpec? = null, + @Json(name = "Endpoint") + var endpoint: ServiceEndpoint? = null, + @Json(name = "UpdateStatus") + var updateStatus: ServiceUpdateStatus? = null, + @Json(name = "ServiceStatus") + var serviceStatus: ServiceServiceStatus? = null, + @Json(name = "JobStatus") + var jobStatus: ServiceJobStatus? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt new file mode 100644 index 00000000..ce0b2158 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the service. + * @param labels User-defined key/value metadata. + * @param taskTemplate + * @param mode + * @param updateConfig + * @param rollbackConfig + * @param networks Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + * @param endpointSpec + */ +@JsonClass(generateAdapter = true) +data class ServiceCreateRequest( + // Name of the service. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "TaskTemplate") + var taskTemplate: TaskSpec? = null, + @Json(name = "Mode") + var mode: ServiceSpecMode? = null, + @Json(name = "UpdateConfig") + var updateConfig: ServiceSpecUpdateConfig? = null, + @Json(name = "RollbackConfig") + var rollbackConfig: ServiceSpecRollbackConfig? = null, + // Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") + var endpointSpec: EndpointSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt new file mode 100644 index 00000000..97f46e77 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * contains the information returned to a client on the creation of a new service. + * + * @param ID The ID of the created service. + * @param warnings Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. + */ +@JsonClass(generateAdapter = true) +data class ServiceCreateResponse( + // The ID of the created service. + @Json(name = "ID") + var ID: kotlin.String? = null, + // Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt new file mode 100644 index 00000000..e092e803 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param spec + * @param ports + * @param virtualIPs + */ +@JsonClass(generateAdapter = true) +data class ServiceEndpoint( + @Json(name = "Spec") + var spec: EndpointSpec? = null, + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, + @Json(name = "VirtualIPs") + var virtualIPs: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt new file mode 100644 index 00000000..44dff832 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param networkID + * @param addr + */ +@JsonClass(generateAdapter = true) +data class ServiceEndpointVirtualIPsInner( + @Json(name = "NetworkID") + var networkID: kotlin.String? = null, + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt new file mode 100644 index 00000000..32f0dc3a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service's version, does not need to be sent with an update request. + * + * @param jobIteration + * @param lastExecution The last time, as observed by the server, that this job was started. + */ +@JsonClass(generateAdapter = true) +data class ServiceJobStatus( + @Json(name = "JobIteration") + var jobIteration: ObjectVersion? = null, + // The last time, as observed by the server, that this job was started. + @Json(name = "LastExecution") + var lastExecution: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt new file mode 100644 index 00000000..05dc0d8b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The status of the service's tasks. Provided only when requested as part of a ServiceList operation. + * + * @param runningTasks The number of tasks for the service currently in the Running state. + * @param desiredTasks The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. + * @param completedTasks The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. + */ +@JsonClass(generateAdapter = true) +data class ServiceServiceStatus( + // The number of tasks for the service currently in the Running state. + @Json(name = "RunningTasks") + var runningTasks: kotlin.Int? = null, + // The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. + @Json(name = "DesiredTasks") + var desiredTasks: kotlin.Int? = null, + // The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. + @Json(name = "CompletedTasks") + var completedTasks: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt new file mode 100644 index 00000000..7d4a5e3a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * User modifiable configuration for a service. + * + * @param name Name of the service. + * @param labels User-defined key/value metadata. + * @param taskTemplate + * @param mode + * @param updateConfig + * @param rollbackConfig + * @param networks Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + * @param endpointSpec + */ +@JsonClass(generateAdapter = true) +data class ServiceSpec( + // Name of the service. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "TaskTemplate") + var taskTemplate: TaskSpec? = null, + @Json(name = "Mode") + var mode: ServiceSpecMode? = null, + @Json(name = "UpdateConfig") + var updateConfig: ServiceSpecUpdateConfig? = null, + @Json(name = "RollbackConfig") + var rollbackConfig: ServiceSpecRollbackConfig? = null, + // Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") + var endpointSpec: EndpointSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt new file mode 100644 index 00000000..cf729aa0 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt @@ -0,0 +1,40 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Scheduling mode for the service. + * + * @param replicated + * @param global + * @param replicatedJob + * @param globalJob The mode used for services which run a task to the completed state on each valid node. + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecMode( + @Json(name = "Replicated") + var replicated: ServiceSpecModeReplicated? = null, + @Json(name = "Global") + var global: kotlin.Any? = null, + @Json(name = "ReplicatedJob") + var replicatedJob: ServiceSpecModeReplicatedJob? = null, + // The mode used for services which run a task to the completed state on each valid node. + @Json(name = "GlobalJob") + var globalJob: kotlin.Any? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt new file mode 100644 index 00000000..ea25e561 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param replicas + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecModeReplicated( + @Json(name = "Replicas") + var replicas: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt new file mode 100644 index 00000000..d4f3427d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The mode used for services with a finite number of tasks that run to a completed state. + * + * @param maxConcurrent The maximum number of replicas to run simultaneously. + * @param totalCompletions The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecModeReplicatedJob( + // The maximum number of replicas to run simultaneously. + @Json(name = "MaxConcurrent") + var maxConcurrent: kotlin.Long? = 1L, + // The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` + @Json(name = "TotalCompletions") + var totalCompletions: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt new file mode 100644 index 00000000..7bed7f83 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt @@ -0,0 +1,79 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for the rollback strategy of the service. + * + * @param parallelism Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). + * @param delay Amount of time between rollback iterations, in nanoseconds. + * @param failureAction Action to take if an rolled back task fails to run, or stops running during the rollback. + * @param monitor Amount of time to monitor each rolled back task for failures, in nanoseconds. + * @param maxFailureRatio The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. + * @param order The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecRollbackConfig( + // Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). + @Json(name = "Parallelism") + var parallelism: kotlin.Long? = null, + // Amount of time between rollback iterations, in nanoseconds. + @Json(name = "Delay") + var delay: kotlin.Long? = null, + // Action to take if an rolled back task fails to run, or stops running during the rollback. + @Json(name = "FailureAction") + var failureAction: ServiceSpecRollbackConfig.FailureAction? = null, + // Amount of time to monitor each rolled back task for failures, in nanoseconds. + @Json(name = "Monitor") + var monitor: kotlin.Long? = null, + // The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. + @Json(name = "MaxFailureRatio") + var maxFailureRatio: java.math.BigDecimal? = null, + // The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + @Json(name = "Order") + var order: ServiceSpecRollbackConfig.Order? = null, +) { + /** + * Action to take if an rolled back task fails to run, or stops running during the rollback. + * + * Values: Continue,Pause + */ + @JsonClass(generateAdapter = false) + enum class FailureAction(val value: kotlin.String) { + @Json(name = "continue") + Continue("continue"), + + @Json(name = "pause") + Pause("pause"), + } + + /** + * The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + * + * Values: StopFirst,StartFirst + */ + @JsonClass(generateAdapter = false) + enum class Order(val value: kotlin.String) { + @Json(name = "stop-first") + StopFirst("stop-first"), + + @Json(name = "start-first") + StartFirst("start-first"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt new file mode 100644 index 00000000..45539520 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt @@ -0,0 +1,82 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for the update strategy of the service. + * + * @param parallelism Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). + * @param delay Amount of time between updates, in nanoseconds. + * @param failureAction Action to take if an updated task fails to run, or stops running during the update. + * @param monitor Amount of time to monitor each updated task for failures, in nanoseconds. + * @param maxFailureRatio The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. + * @param order The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecUpdateConfig( + // Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). + @Json(name = "Parallelism") + var parallelism: kotlin.Long? = null, + // Amount of time between updates, in nanoseconds. + @Json(name = "Delay") + var delay: kotlin.Long? = null, + // Action to take if an updated task fails to run, or stops running during the update. + @Json(name = "FailureAction") + var failureAction: ServiceSpecUpdateConfig.FailureAction? = null, + // Amount of time to monitor each updated task for failures, in nanoseconds. + @Json(name = "Monitor") + var monitor: kotlin.Long? = null, + // The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. + @Json(name = "MaxFailureRatio") + var maxFailureRatio: java.math.BigDecimal? = null, + // The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + @Json(name = "Order") + var order: ServiceSpecUpdateConfig.Order? = null, +) { + /** + * Action to take if an updated task fails to run, or stops running during the update. + * + * Values: Continue,Pause,Rollback + */ + @JsonClass(generateAdapter = false) + enum class FailureAction(val value: kotlin.String) { + @Json(name = "continue") + Continue("continue"), + + @Json(name = "pause") + Pause("pause"), + + @Json(name = "rollback") + Rollback("rollback"), + } + + /** + * The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + * + * Values: StopFirst,StartFirst + */ + @JsonClass(generateAdapter = false) + enum class Order(val value: kotlin.String) { + @Json(name = "stop-first") + StopFirst("stop-first"), + + @Json(name = "start-first") + StartFirst("start-first"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt new file mode 100644 index 00000000..e03dc048 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the service. + * @param labels User-defined key/value metadata. + * @param taskTemplate + * @param mode + * @param updateConfig + * @param rollbackConfig + * @param networks Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + * @param endpointSpec + */ +@JsonClass(generateAdapter = true) +data class ServiceUpdateRequest( + // Name of the service. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "TaskTemplate") + var taskTemplate: TaskSpec? = null, + @Json(name = "Mode") + var mode: ServiceSpecMode? = null, + @Json(name = "UpdateConfig") + var updateConfig: ServiceSpecUpdateConfig? = null, + @Json(name = "RollbackConfig") + var rollbackConfig: ServiceSpecRollbackConfig? = null, + // Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") + var endpointSpec: EndpointSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt new file mode 100644 index 00000000..338d2a20 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param warnings Optional warning messages + */ +@JsonClass(generateAdapter = true) +data class ServiceUpdateResponse( + // Optional warning messages + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt new file mode 100644 index 00000000..feaf2d12 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt @@ -0,0 +1,56 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The status of a service update. + * + * @param state + * @param startedAt + * @param completedAt + * @param message + */ +@JsonClass(generateAdapter = true) +data class ServiceUpdateStatus( + @Json(name = "State") + var state: ServiceUpdateStatus.State? = null, + @Json(name = "StartedAt") + var startedAt: kotlin.String? = null, + @Json(name = "CompletedAt") + var completedAt: kotlin.String? = null, + @Json(name = "Message") + var message: kotlin.String? = null, +) { + /** + * + * + * Values: Updating,Paused,Completed + */ + @JsonClass(generateAdapter = false) + enum class State(val value: kotlin.String) { + @Json(name = "updating") + Updating("updating"), + + @Json(name = "paused") + Paused("paused"), + + @Json(name = "completed") + Completed("completed"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt new file mode 100644 index 00000000..0340ecad --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt @@ -0,0 +1,67 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID The ID of the swarm. + * @param version + * @param createdAt Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param updatedAt Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param spec + * @param tlSInfo + * @param rootRotationInProgress Whether there is currently a root CA rotation in progress for the swarm + * @param dataPathPort 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, the default port (4789) is used. + * @param defaultAddrPool Default Address Pool specifies default subnet pools for global scope networks. + * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. + * @param joinTokens + */ +@JsonClass(generateAdapter = true) +data class Swarm( + // The ID of the swarm. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + // Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: SwarmSpec? = null, + @Json(name = "TLSInfo") + var tlSInfo: TLSInfo? = null, + // Whether there is currently a root CA rotation in progress for the swarm + @Json(name = "RootRotationInProgress") + var rootRotationInProgress: kotlin.Boolean? = null, + // 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, the default port (4789) is used. + @Json(name = "DataPathPort") + var dataPathPort: kotlin.Int? = null, + // Default Address Pool specifies default subnet pools for global scope networks. + @Json(name = "DefaultAddrPool") + var defaultAddrPool: kotlin.collections.MutableList? = null, + // SubnetSize specifies the subnet size of the networks created from the default subnet pool. + @Json(name = "SubnetSize") + var subnetSize: kotlin.Int? = null, + @Json(name = "JoinTokens") + var joinTokens: JoinTokens? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt new file mode 100644 index 00000000..4404fe93 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Represents generic information about swarm. + * + * @param nodeID Unique identifier of for this node in the swarm. + * @param nodeAddr IP address at which this node can be reached by other nodes in the swarm. + * @param localNodeState + * @param controlAvailable + * @param error + * @param remoteManagers List of ID's and addresses of other managers in the swarm. + * @param nodes Total number of nodes in the swarm. + * @param managers Total number of managers in the swarm. + * @param cluster + */ +@JsonClass(generateAdapter = true) +data class SwarmInfo( + // Unique identifier of for this node in the swarm. + @Json(name = "NodeID") + var nodeID: kotlin.String? = "", + // IP address at which this node can be reached by other nodes in the swarm. + @Json(name = "NodeAddr") + var nodeAddr: kotlin.String? = "", + @Json(name = "LocalNodeState") + var localNodeState: LocalNodeState? = LocalNodeState.EMPTY, + @Json(name = "ControlAvailable") + var controlAvailable: kotlin.Boolean? = false, + @Json(name = "Error") + var error: kotlin.String? = "", + // List of ID's and addresses of other managers in the swarm. + @Json(name = "RemoteManagers") + var remoteManagers: kotlin.collections.MutableList? = null, + // Total number of nodes in the swarm. + @Json(name = "Nodes") + var nodes: kotlin.Int? = null, + // Total number of managers in the swarm. + @Json(name = "Managers") + var managers: kotlin.Int? = null, + @Json(name = "Cluster") + var cluster: ClusterInfo? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt new file mode 100644 index 00000000..d3fc924d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt @@ -0,0 +1,58 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param listenAddr 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. + * @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 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 dataPathPort 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. + * @param defaultAddrPool Default Address Pool specifies default subnet pools for global scope networks. + * @param forceNewCluster Force creation of a new swarm. + * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. + * @param spec + */ +@JsonClass(generateAdapter = true) +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") + var 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") + var 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 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") + var dataPathAddr: kotlin.String? = null, + // 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. + @Json(name = "DataPathPort") + var dataPathPort: kotlin.Int? = null, + // Default Address Pool specifies default subnet pools for global scope networks. + @Json(name = "DefaultAddrPool") + var defaultAddrPool: kotlin.collections.MutableList? = null, + // Force creation of a new swarm. + @Json(name = "ForceNewCluster") + var forceNewCluster: kotlin.Boolean? = null, + // SubnetSize specifies the subnet size of the networks created from the default subnet pool. + @Json(name = "SubnetSize") + var subnetSize: kotlin.Int? = null, + @Json(name = "Spec") + var spec: SwarmSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt new file mode 100644 index 00000000..a8b67cd2 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +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 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 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") + var 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") + var 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 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") + var dataPathAddr: kotlin.String? = null, + // Addresses of manager nodes already participating in the swarm. + @Json(name = "RemoteAddrs") + var remoteAddrs: kotlin.collections.MutableList? = null, + // Secret token for joining this swarm. + @Json(name = "JoinToken") + var joinToken: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt new file mode 100644 index 00000000..e7611d04 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt @@ -0,0 +1,53 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * User modifiable swarm configuration. + * + * @param name Name of the swarm. + * @param labels User-defined key/value metadata. + * @param orchestration + * @param raft + * @param dispatcher + * @param caConfig + * @param encryptionConfig + * @param taskDefaults + */ +@JsonClass(generateAdapter = true) +data class SwarmSpec( + // Name of the swarm. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Orchestration") + var orchestration: SwarmSpecOrchestration? = null, + @Json(name = "Raft") + var raft: SwarmSpecRaft? = null, + @Json(name = "Dispatcher") + var dispatcher: SwarmSpecDispatcher? = null, + @Json(name = "CAConfig") + var caConfig: SwarmSpecCAConfig? = null, + @Json(name = "EncryptionConfig") + var encryptionConfig: SwarmSpecEncryptionConfig? = null, + @Json(name = "TaskDefaults") + var taskDefaults: SwarmSpecTaskDefaults? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt new file mode 100644 index 00000000..997c7d54 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * CA configuration. + * + * @param nodeCertExpiry The duration node certificates are issued for. + * @param externalCAs Configuration for forwarding signing requests to an external certificate authority. + * @param signingCACert The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. + * @param signingCAKey The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. + * @param forceRotate An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecCAConfig( + // The duration node certificates are issued for. + @Json(name = "NodeCertExpiry") + var nodeCertExpiry: kotlin.Long? = null, + // Configuration for forwarding signing requests to an external certificate authority. + @Json(name = "ExternalCAs") + var externalCAs: kotlin.collections.MutableList? = null, + // The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. + @Json(name = "SigningCACert") + var signingCACert: kotlin.String? = null, + // The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. + @Json(name = "SigningCAKey") + var signingCAKey: kotlin.String? = null, + // An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` + @Json(name = "ForceRotate") + var forceRotate: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt new file mode 100644 index 00000000..8b89b67c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param protocol Protocol for communication with the external CA (currently only `cfssl` is supported). + * @param URL URL where certificate signing requests should be sent. + * @param options An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. + * @param caCert The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecCAConfigExternalCAsInner( + // Protocol for communication with the external CA (currently only `cfssl` is supported). + @Json(name = "Protocol") + var protocol: SwarmSpecCAConfigExternalCAsInner.Protocol? = Protocol.Cfssl, + // URL where certificate signing requests should be sent. + @Json(name = "URL") + var URL: kotlin.String? = null, + // An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). + @Json(name = "CACert") + var caCert: kotlin.String? = null, +) { + /** + * Protocol for communication with the external CA (currently only `cfssl` is supported). + * + * Values: Cfssl + */ + @JsonClass(generateAdapter = false) + enum class Protocol(val value: kotlin.String) { + @Json(name = "cfssl") + Cfssl("cfssl"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt new file mode 100644 index 00000000..f61ca41e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Dispatcher configuration. + * + * @param heartbeatPeriod The delay for an agent to send a heartbeat to the dispatcher. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecDispatcher( + // The delay for an agent to send a heartbeat to the dispatcher. + @Json(name = "HeartbeatPeriod") + var heartbeatPeriod: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt new file mode 100644 index 00000000..a47b3291 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Parameters related to encryption-at-rest. + * + * @param autoLockManagers If set, generate a key and use it to lock data stored on the managers. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecEncryptionConfig( + // If set, generate a key and use it to lock data stored on the managers. + @Json(name = "AutoLockManagers") + var autoLockManagers: kotlin.Boolean? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt new file mode 100644 index 00000000..6150ccf4 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Orchestration configuration. + * + * @param taskHistoryRetentionLimit The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecOrchestration( + // The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. + @Json(name = "TaskHistoryRetentionLimit") + var taskHistoryRetentionLimit: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt new file mode 100644 index 00000000..3a632d48 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Raft configuration. + * + * @param snapshotInterval The number of log entries between snapshots. + * @param keepOldSnapshots The number of snapshots to keep beyond the current snapshot. + * @param logEntriesForSlowFollowers The number of log entries to keep around to sync up slow followers after a snapshot is created. + * @param electionTick The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + * @param heartbeatTick The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecRaft( + // The number of log entries between snapshots. + @Json(name = "SnapshotInterval") + var snapshotInterval: kotlin.Int? = null, + // The number of snapshots to keep beyond the current snapshot. + @Json(name = "KeepOldSnapshots") + var keepOldSnapshots: kotlin.Int? = null, + // The number of log entries to keep around to sync up slow followers after a snapshot is created. + @Json(name = "LogEntriesForSlowFollowers") + var logEntriesForSlowFollowers: kotlin.Int? = null, + // The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + @Json(name = "ElectionTick") + var electionTick: kotlin.Int? = null, + // The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + @Json(name = "HeartbeatTick") + var heartbeatTick: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt new file mode 100644 index 00000000..13ee5598 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Defaults for creating tasks in this cluster. + * + * @param logDriver + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecTaskDefaults( + @Json(name = "LogDriver") + var logDriver: SwarmSpecTaskDefaultsLogDriver? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt new file mode 100644 index 00000000..bd44aa93 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The log driver to use for tasks created in the orchestrator if unspecified by a service. Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated. + * + * @param name The log driver to use as a default for new tasks. + * @param options Driver-specific options for the selected log driver, specified as key/value pairs. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecTaskDefaultsLogDriver( + // The log driver to use as a default for new tasks. + @Json(name = "Name") + var name: kotlin.String? = null, + // Driver-specific options for the selected log driver, specified as key/value pairs. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt new file mode 100644 index 00000000..5252c113 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param unlockKey The swarm's unlock key. + */ +@JsonClass(generateAdapter = true) +data class SwarmUnlockRequest( + // The swarm's unlock key. + @Json(name = "UnlockKey") + var unlockKey: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt new file mode 100644 index 00000000..dc6cb7bc --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param status The status of the authentication + * @param identityToken An opaque token used to authenticate a user after a successful login + */ +@JsonClass(generateAdapter = true) +data class SystemAuthResponse( + // The status of the authentication + @Json(name = "Status") + var status: kotlin.String, + // An opaque token used to authenticate a user after a successful login + @Json(name = "IdentityToken") + var identityToken: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt new file mode 100644 index 00000000..b5d13f38 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param layersSize + * @param images + * @param containers + * @param volumes + * @param buildCache + */ +@JsonClass(generateAdapter = true) +data class SystemDataUsageResponse( + @Json(name = "LayersSize") + var layersSize: kotlin.Long? = null, + @Json(name = "Images") + var images: kotlin.collections.MutableList? = null, + @Json(name = "Containers") + var containers: kotlin.collections.MutableList? = null, + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableList? = null, + @Json(name = "BuildCache") + var buildCache: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt new file mode 100644 index 00000000..5d5d4098 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt @@ -0,0 +1,316 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID Unique identifier of the daemon.


> **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. + * @param containers Total number of containers on the host. + * @param containersRunning Number of containers with status `\"running\"`. + * @param containersPaused Number of containers with status `\"paused\"`. + * @param containersStopped Number of containers with status `\"stopped\"`. + * @param images Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. + * @param driver Name of the storage driver in use. + * @param driverStatus Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + * @param dockerRootDir Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. + * @param plugins + * @param memoryLimit Indicates if the host has memory limit support enabled. + * @param swapLimit Indicates if the host has memory swap limit support enabled. + * @param kernelMemoryTCP Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. + * @param cpuCfsPeriod Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. + * @param cpuCfsQuota Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. + * @param cpUShares Indicates if CPU Shares limiting is supported by the host. + * @param cpUSet Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) + * @param pidsLimit Indicates if the host kernel has PID limit support enabled. + * @param oomKillDisable Indicates if OOM killer disable is supported on the host. + * @param ipv4Forwarding Indicates IPv4 forwarding is enabled. + * @param bridgeNfIptables Indicates if `bridge-nf-call-iptables` is available on the host. + * @param bridgeNfIp6tables Indicates if `bridge-nf-call-ip6tables` is available on the host. + * @param debug Indicates if the daemon is running in debug-mode / with debug-level logging enabled. + * @param nfd The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. + * @param ngoroutines The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. + * @param systemTime Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param loggingDriver The logging driver to use as a default for new containers. + * @param cgroupDriver The driver to use for managing cgroups. + * @param cgroupVersion The version of the cgroup. + * @param neventsListener Number of event listeners subscribed. + * @param kernelVersion Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\ registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. + * @param operatingSystem Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" + * @param osVersion Version of the host's operating system


> **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. + * @param osType Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + * @param architecture Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + * @param NCPU The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. + * @param memTotal Total amount of physical memory available on the host, in bytes. + * @param indexServerAddress Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. + * @param registryConfig + * @param genericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + * @param httpProxy HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + * @param httpsProxy HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + * @param noProxy Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. + * @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. + * @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. + * @param defaultRuntime Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. + * @param swarm + * @param liveRestoreEnabled Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. + * @param isolation Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. + * @param initBinary Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + * @param containerdCommit + * @param runcCommit + * @param initCommit + * @param securityOptions List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. + * @param productLicense Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. + * @param defaultAddressPools List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. + * @param warnings List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. + * @param cdISpecDirs List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. + */ +@JsonClass(generateAdapter = true) +data class SystemInfo( + // Unique identifier of the daemon.


> **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. + @Json(name = "ID") + var ID: kotlin.String? = null, + // Total number of containers on the host. + @Json(name = "Containers") + var containers: kotlin.Int? = null, + // Number of containers with status `\"running\"`. + @Json(name = "ContainersRunning") + var containersRunning: kotlin.Int? = null, + // Number of containers with status `\"paused\"`. + @Json(name = "ContainersPaused") + var containersPaused: kotlin.Int? = null, + // Number of containers with status `\"stopped\"`. + @Json(name = "ContainersStopped") + var containersStopped: kotlin.Int? = null, + // Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. + @Json(name = "Images") + var images: kotlin.Int? = null, + // Name of the storage driver in use. + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + @Json(name = "DriverStatus") + var driverStatus: kotlin.collections.MutableList>? = null, + // Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. + @Json(name = "DockerRootDir") + var dockerRootDir: kotlin.String? = null, + @Json(name = "Plugins") + var plugins: PluginsInfo? = null, + // Indicates if the host has memory limit support enabled. + @Json(name = "MemoryLimit") + var memoryLimit: kotlin.Boolean? = null, + // Indicates if the host has memory swap limit support enabled. + @Json(name = "SwapLimit") + var swapLimit: kotlin.Boolean? = null, + // Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup. + @Json(name = "KernelMemoryTCP") + var kernelMemoryTCP: kotlin.Boolean? = null, + // Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. + @Json(name = "CpuCfsPeriod") + var cpuCfsPeriod: kotlin.Boolean? = null, + // Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. + @Json(name = "CpuCfsQuota") + var cpuCfsQuota: kotlin.Boolean? = null, + // Indicates if CPU Shares limiting is supported by the host. + @Json(name = "CPUShares") + var cpUShares: kotlin.Boolean? = null, + // Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) + @Json(name = "CPUSet") + var cpUSet: kotlin.Boolean? = null, + // Indicates if the host kernel has PID limit support enabled. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Boolean? = null, + // Indicates if OOM killer disable is supported on the host. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Indicates IPv4 forwarding is enabled. + @Json(name = "IPv4Forwarding") + var ipv4Forwarding: kotlin.Boolean? = null, + // Indicates if `bridge-nf-call-iptables` is available on the host. + @Json(name = "BridgeNfIptables") + var bridgeNfIptables: kotlin.Boolean? = null, + // Indicates if `bridge-nf-call-ip6tables` is available on the host. + @Json(name = "BridgeNfIp6tables") + var bridgeNfIp6tables: kotlin.Boolean? = null, + // Indicates if the daemon is running in debug-mode / with debug-level logging enabled. + @Json(name = "Debug") + var debug: kotlin.Boolean? = null, + // The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. + @Json(name = "NFd") + var nfd: kotlin.Int? = null, + // The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. + @Json(name = "NGoroutines") + var ngoroutines: kotlin.Int? = null, + // Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "SystemTime") + var systemTime: kotlin.String? = null, + // The logging driver to use as a default for new containers. + @Json(name = "LoggingDriver") + var loggingDriver: kotlin.String? = null, + // The driver to use for managing cgroups. + @Json(name = "CgroupDriver") + var cgroupDriver: SystemInfo.CgroupDriver? = CgroupDriver.Cgroupfs, + // The version of the cgroup. + @Json(name = "CgroupVersion") + var cgroupVersion: SystemInfo.CgroupVersion? = CgroupVersion.V1, + // Number of event listeners subscribed. + @Json(name = "NEventsListener") + var neventsListener: kotlin.Int? = null, + // Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\ registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. + @Json(name = "KernelVersion") + var kernelVersion: kotlin.String? = null, + // Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\" or \"Windows Server 2016 Datacenter\" + @Json(name = "OperatingSystem") + var operatingSystem: kotlin.String? = null, + // Version of the host's operating system


> **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. + @Json(name = "OSVersion") + var osVersion: kotlin.String? = null, + // Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + @Json(name = "OSType") + var osType: kotlin.String? = null, + // Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + @Json(name = "Architecture") + var architecture: kotlin.String? = null, + // The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. + @Json(name = "NCPU") + var NCPU: kotlin.Int? = null, + // Total amount of physical memory available on the host, in bytes. + @Json(name = "MemTotal") + var memTotal: kotlin.Long? = null, + // Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. + @Json(name = "IndexServerAddress") + var indexServerAddress: kotlin.String? = "https://index.docker.io/v1/", + @Json(name = "RegistryConfig") + var registryConfig: RegistryServiceConfig? = null, + // User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + @Json(name = "GenericResources") + var genericResources: kotlin.collections.MutableList? = null, + // HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + @Json(name = "HttpProxy") + var httpProxy: kotlin.String? = null, + // HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + @Json(name = "HttpsProxy") + var httpsProxy: kotlin.String? = null, + // Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. + @Json(name = "NoProxy") + var noProxy: kotlin.String? = null, + // Hostname of the host. + @Json(name = "Name") + var name: kotlin.String? = null, + // 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. + @Json(name = "Labels") + var labels: kotlin.collections.MutableList? = null, + // Indicates if experimental features are enabled on the daemon. + @Json(name = "ExperimentalBuild") + var experimentalBuild: kotlin.Boolean? = null, + // Version string of the daemon. + @Json(name = "ServerVersion") + var serverVersion: kotlin.String? = null, + // 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. + @Json(name = "Runtimes") + var runtimes: kotlin.collections.MutableMap? = null, + // Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. + @Json(name = "DefaultRuntime") + var defaultRuntime: kotlin.String? = "runc", + @Json(name = "Swarm") + var swarm: SwarmInfo? = null, + // Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. + @Json(name = "LiveRestoreEnabled") + var liveRestoreEnabled: kotlin.Boolean? = false, + // Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. + @Json(name = "Isolation") + var isolation: SystemInfo.Isolation? = Isolation.Default, + // Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + @Json(name = "InitBinary") + var initBinary: kotlin.String? = null, + @Json(name = "ContainerdCommit") + var containerdCommit: Commit? = null, + @Json(name = "RuncCommit") + var runcCommit: Commit? = null, + @Json(name = "InitCommit") + var initCommit: Commit? = null, + // List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. + @Json(name = "SecurityOptions") + var securityOptions: kotlin.collections.MutableList? = null, + // Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. + @Json(name = "ProductLicense") + var productLicense: kotlin.String? = null, + // List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. + @Json(name = "DefaultAddressPools") + var defaultAddressPools: kotlin.collections.MutableList? = null, + // List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, + // List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. + @Json(name = "CDISpecDirs") + var cdISpecDirs: kotlin.collections.MutableList? = null, +) { + /** + * The driver to use for managing cgroups. + * + * Values: Cgroupfs,Systemd,None + */ + @JsonClass(generateAdapter = false) + enum class CgroupDriver(val value: kotlin.String) { + @Json(name = "cgroupfs") + Cgroupfs("cgroupfs"), + + @Json(name = "systemd") + Systemd("systemd"), + + @Json(name = "none") + None("none"), + } + + /** + * The version of the cgroup. + * + * Values: V1,V2 + */ + @JsonClass(generateAdapter = false) + enum class CgroupVersion(val value: kotlin.String) { + @Json(name = "1") + V1("1"), + + @Json(name = "2") + V2("2"), + } + + /** + * Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. + * + * Values: Default,Hyperv,Process,EMPTY + */ + @JsonClass(generateAdapter = false) + enum class Isolation(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "hyperv") + Hyperv("hyperv"), + + @Json(name = "process") + Process("process"), + + @Json(name = "") + EMPTY(""), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt new file mode 100644 index 00000000..020a6ee8 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param base The network address in CIDR format + * @param propertySize The network pool size + */ +@JsonClass(generateAdapter = true) +data class SystemInfoDefaultAddressPoolsInner( + // The network address in CIDR format + @Json(name = "Base") + var base: kotlin.String? = null, + // The network pool size + @Json(name = "Size") + var propertySize: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt new file mode 100644 index 00000000..4625f802 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt @@ -0,0 +1,74 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Response of Engine API: GET \"/version\" + * + * @param platform + * @param components Information about system components + * @param version The version of the daemon + * @param apiVersion The default (and highest) API version that is supported by the daemon + * @param minAPIVersion The minimum API version that is supported by the daemon + * @param gitCommit The Git commit of the source code that was used to build the daemon + * @param goVersion The version Go used to compile the daemon, and the version of the Go runtime in use. + * @param os The operating system that the daemon is running on (\"linux\" or \"windows\") + * @param arch The architecture that the daemon is running on + * @param kernelVersion The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. + * @param experimental Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. + * @param buildTime The date and time that the daemon was compiled. + */ +@JsonClass(generateAdapter = true) +data class SystemVersion( + @Json(name = "Platform") + var platform: SystemVersionPlatform? = null, + // Information about system components + @Json(name = "Components") + var components: kotlin.collections.MutableList? = null, + // The version of the daemon + @Json(name = "Version") + var version: kotlin.String? = null, + // The default (and highest) API version that is supported by the daemon + @Json(name = "ApiVersion") + var apiVersion: kotlin.String? = null, + // The minimum API version that is supported by the daemon + @Json(name = "MinAPIVersion") + var minAPIVersion: kotlin.String? = null, + // The Git commit of the source code that was used to build the daemon + @Json(name = "GitCommit") + var gitCommit: kotlin.String? = null, + // The version Go used to compile the daemon, and the version of the Go runtime in use. + @Json(name = "GoVersion") + var goVersion: kotlin.String? = null, + // The operating system that the daemon is running on (\"linux\" or \"windows\") + @Json(name = "Os") + var os: kotlin.String? = null, + // The architecture that the daemon is running on + @Json(name = "Arch") + var arch: kotlin.String? = null, + // The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. + @Json(name = "KernelVersion") + var kernelVersion: kotlin.String? = null, + // Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. + @Json(name = "Experimental") + var experimental: kotlin.Boolean? = null, + // The date and time that the daemon was compiled. + @Json(name = "BuildTime") + var buildTime: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt new file mode 100644 index 00000000..3b69fcd9 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the component + * @param version Version of the component + * @param details Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. + */ +@JsonClass(generateAdapter = true) +data class SystemVersionComponentsInner( + // Name of the component + @Json(name = "Name") + var name: kotlin.String, + // Version of the component + @Json(name = "Version") + var version: kotlin.String, + // Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. + @Json(name = "Details") + var details: kotlin.Any? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt new file mode 100644 index 00000000..3f4e6037 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + */ +@JsonClass(generateAdapter = true) +data class SystemVersionPlatform( + @Json(name = "Name") + var name: kotlin.String, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt new file mode 100644 index 00000000..01248c68 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the issuer of leaf TLS certificates and the trusted root CA certificate. + * + * @param trustRoot The root CA certificate(s) that are used to validate leaf TLS certificates. + * @param certIssuerSubject The base64-url-safe-encoded raw subject bytes of the issuer. + * @param certIssuerPublicKey The base64-url-safe-encoded raw public key bytes of the issuer. + */ +@JsonClass(generateAdapter = true) +data class TLSInfo( + // The root CA certificate(s) that are used to validate leaf TLS certificates. + @Json(name = "TrustRoot") + var trustRoot: kotlin.String? = null, + // The base64-url-safe-encoded raw subject bytes of the issuer. + @Json(name = "CertIssuerSubject") + var certIssuerSubject: kotlin.String? = null, + // The base64-url-safe-encoded raw public key bytes of the issuer. + @Json(name = "CertIssuerPublicKey") + var certIssuerPublicKey: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt new file mode 100644 index 00000000..61d83a42 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt @@ -0,0 +1,75 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID The ID of the task. + * @param version + * @param createdAt + * @param updatedAt + * @param name Name of the task. + * @param labels User-defined key/value metadata. + * @param spec + * @param serviceID The ID of the service this task is part of. + * @param slot + * @param nodeID The ID of the node that this task is on. + * @param assignedGenericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + * @param status + * @param desiredState + * @param jobIteration + */ +@JsonClass(generateAdapter = true) +data class Task( + // The ID of the task. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + // Name of the task. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Spec") + var spec: TaskSpec? = null, + // The ID of the service this task is part of. + @Json(name = "ServiceID") + var serviceID: kotlin.String? = null, + @Json(name = "Slot") + var slot: kotlin.Int? = null, + // The ID of the node that this task is on. + @Json(name = "NodeID") + var nodeID: kotlin.String? = null, + // User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + @Json(name = "AssignedGenericResources") + var assignedGenericResources: kotlin.collections.MutableList? = null, + @Json(name = "Status") + var status: TaskStatus? = null, + @Json(name = "DesiredState") + var desiredState: TaskState? = null, + @Json(name = "JobIteration") + var jobIteration: ObjectVersion? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt new file mode 100644 index 00000000..2596a359 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt @@ -0,0 +1,60 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * User modifiable task configuration. + * + * @param pluginSpec + * @param containerSpec + * @param networkAttachmentSpec + * @param resources + * @param restartPolicy + * @param placement + * @param forceUpdate A counter that triggers an update even if no relevant parameters have been changed. + * @param runtime Runtime is the type of runtime specified for the task executor. + * @param networks Specifies which networks the service should attach to. + * @param logDriver + */ +@JsonClass(generateAdapter = true) +data class TaskSpec( + @Json(name = "PluginSpec") + var pluginSpec: TaskSpecPluginSpec? = null, + @Json(name = "ContainerSpec") + var containerSpec: TaskSpecContainerSpec? = null, + @Json(name = "NetworkAttachmentSpec") + var networkAttachmentSpec: TaskSpecNetworkAttachmentSpec? = null, + @Json(name = "Resources") + var resources: TaskSpecResources? = null, + @Json(name = "RestartPolicy") + var restartPolicy: TaskSpecRestartPolicy? = null, + @Json(name = "Placement") + var placement: TaskSpecPlacement? = null, + // A counter that triggers an update even if no relevant parameters have been changed. + @Json(name = "ForceUpdate") + var forceUpdate: kotlin.Int? = null, + // Runtime is the type of runtime specified for the task executor. + @Json(name = "Runtime") + var runtime: kotlin.String? = null, + // Specifies which networks the service should attach to. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "LogDriver") + var logDriver: TaskSpecLogDriver? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt new file mode 100644 index 00000000..d7561f08 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt @@ -0,0 +1,152 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Container spec for the service.


> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`. + * + * @param image The image name to use for the container + * @param labels User-defined key/value data. + * @param command The command to be run in the image. + * @param args Arguments to the command. + * @param hostname The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. + * @param env A list of environment variables in the form `VAR=value`. + * @param dir The working directory for commands to run in. + * @param user The user inside the container. + * @param groups A list of additional groups that the container process will run as. + * @param privileges + * @param TTY Whether a pseudo-TTY should be allocated. + * @param openStdin Open `stdin` + * @param readOnly Mount the container's root filesystem as read only. + * @param mounts Specification for mounts to be added to containers created as part of the service. + * @param stopSignal Signal to stop the container. + * @param stopGracePeriod Amount of time to wait for the container to terminate before forcefully killing it. + * @param healthCheck + * @param hosts A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] + * @param dnSConfig + * @param secrets Secrets contains references to zero or more secrets that will be exposed to the service. + * @param configs Configs contains references to zero or more configs that will be exposed to the service. + * @param isolation Isolation technology of the containers running the service. (Windows only) + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param sysctls Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. + * @param capabilityAdd A list of kernel capabilities to add to the default set for the container. + * @param capabilityDrop A list of kernel capabilities to drop from the default set for the container. + * @param ulimits A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpec( + // The image name to use for the container + @Json(name = "Image") + var image: kotlin.String? = null, + // User-defined key/value data. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // The command to be run in the image. + @Json(name = "Command") + var command: kotlin.collections.MutableList? = null, + // Arguments to the command. + @Json(name = "Args") + var args: kotlin.collections.MutableList? = null, + // The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // A list of environment variables in the form `VAR=value`. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // The working directory for commands to run in. + @Json(name = "Dir") + var dir: kotlin.String? = null, + // The user inside the container. + @Json(name = "User") + var user: kotlin.String? = null, + // A list of additional groups that the container process will run as. + @Json(name = "Groups") + var groups: kotlin.collections.MutableList? = null, + @Json(name = "Privileges") + var privileges: TaskSpecContainerSpecPrivileges? = null, + // Whether a pseudo-TTY should be allocated. + @Json(name = "TTY") + var TTY: kotlin.Boolean? = null, + // Open `stdin` + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = null, + // Mount the container's root filesystem as read only. + @Json(name = "ReadOnly") + var readOnly: kotlin.Boolean? = null, + // Specification for mounts to be added to containers created as part of the service. + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + // Signal to stop the container. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = null, + // Amount of time to wait for the container to terminate before forcefully killing it. + @Json(name = "StopGracePeriod") + var stopGracePeriod: kotlin.Long? = null, + @Json(name = "HealthCheck") + var healthCheck: HealthConfig? = null, + // A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] + @Json(name = "Hosts") + var hosts: kotlin.collections.MutableList? = null, + @Json(name = "DNSConfig") + var dnSConfig: TaskSpecContainerSpecDNSConfig? = null, + // Secrets contains references to zero or more secrets that will be exposed to the service. + @Json(name = "Secrets") + var secrets: kotlin.collections.MutableList? = null, + // Configs contains references to zero or more configs that will be exposed to the service. + @Json(name = "Configs") + var configs: kotlin.collections.MutableList? = null, + // Isolation technology of the containers running the service. (Windows only) + @Json(name = "Isolation") + var isolation: TaskSpecContainerSpec.Isolation? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. + @Json(name = "Sysctls") + var sysctls: kotlin.collections.MutableMap? = null, + // A list of kernel capabilities to add to the default set for the container. + @Json(name = "CapabilityAdd") + var capabilityAdd: kotlin.collections.MutableList? = null, + // A list of kernel capabilities to drop from the default set for the container. + @Json(name = "CapabilityDrop") + var capabilityDrop: kotlin.collections.MutableList? = null, + // A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, +) { + /** + * Isolation technology of the containers running the service. (Windows only) + * + * Values: Default,Process,Hyperv,EMPTY + */ + @JsonClass(generateAdapter = false) + enum class Isolation(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "process") + Process("process"), + + @Json(name = "hyperv") + Hyperv("hyperv"), + + @Json(name = "") + EMPTY(""), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt new file mode 100644 index 00000000..52cf4da7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param file + * @param runtime Runtime represents a target that is not mounted into the container but is used by the task


> **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive + * @param configID ConfigID represents the ID of the specific config that we're referencing. + * @param configName ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecConfigsInner( + @Json(name = "File") + var file: TaskSpecContainerSpecConfigsInnerFile? = null, + // Runtime represents a target that is not mounted into the container but is used by the task


> **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive + @Json(name = "Runtime") + var runtime: kotlin.Any? = null, + // ConfigID represents the ID of the specific config that we're referencing. + @Json(name = "ConfigID") + var configID: kotlin.String? = null, + // ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. + @Json(name = "ConfigName") + var configName: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt new file mode 100644 index 00000000..c57c6547 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * File represents a specific target that is backed by a file.


> **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive + * + * @param name Name represents the final filename in the filesystem. + * @param UID UID represents the file UID. + * @param GID GID represents the file GID. + * @param mode Mode represents the FileMode of the file. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecConfigsInnerFile( + // Name represents the final filename in the filesystem. + @Json(name = "Name") + var name: kotlin.String? = null, + // UID represents the file UID. + @Json(name = "UID") + var UID: kotlin.String? = null, + // GID represents the file GID. + @Json(name = "GID") + var GID: kotlin.String? = null, + // Mode represents the FileMode of the file. + @Json(name = "Mode") + var mode: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt new file mode 100644 index 00000000..48dfb94f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for DNS related configurations in resolver configuration file (`resolv.conf`). + * + * @param nameservers The IP addresses of the name servers. + * @param search A search list for host-name lookup. + * @param options A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecDNSConfig( + // The IP addresses of the name servers. + @Json(name = "Nameservers") + var nameservers: kotlin.collections.MutableList? = null, + // A search list for host-name lookup. + @Json(name = "Search") + var search: kotlin.collections.MutableList? = null, + // A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). + @Json(name = "Options") + var options: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt new file mode 100644 index 00000000..75f7f6b5 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Security options for the container + * + * @param credentialSpec + * @param seLinuxContext + * @param seccomp + * @param appArmor + * @param noNewPrivileges Configuration of the no_new_privs bit in the container + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivileges( + @Json(name = "CredentialSpec") + var credentialSpec: TaskSpecContainerSpecPrivilegesCredentialSpec? = null, + @Json(name = "SELinuxContext") + var seLinuxContext: TaskSpecContainerSpecPrivilegesSELinuxContext? = null, + @Json(name = "Seccomp") + var seccomp: TaskSpecContainerSpecPrivilegesSeccomp? = null, + @Json(name = "AppArmor") + var appArmor: TaskSpecContainerSpecPrivilegesAppArmor? = null, + // Configuration of the no_new_privs bit in the container + @Json(name = "NoNewPrivileges") + var noNewPrivileges: kotlin.Boolean? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt new file mode 100644 index 00000000..c0abe9d9 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt @@ -0,0 +1,44 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Options for configuring AppArmor on the container + * + * @param mode + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesAppArmor( + @Json(name = "Mode") + var mode: TaskSpecContainerSpecPrivilegesAppArmor.Mode? = null, +) { + /** + * + * + * Values: Default,Disabled + */ + @JsonClass(generateAdapter = false) + enum class Mode(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "disabled") + Disabled("disabled"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt new file mode 100644 index 00000000..3f3ddb8b --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * CredentialSpec for managed service account (Windows only) + * + * @param config Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + * @param file Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + * @param registry Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs`


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesCredentialSpec( + // Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + @Json(name = "Config") + var config: kotlin.String? = null, + // Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + @Json(name = "File") + var file: kotlin.String? = null, + // Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs`


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + @Json(name = "Registry") + var registry: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt new file mode 100644 index 00000000..4d1bc6e3 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * SELinux labels of the container + * + * @param disable Disable SELinux + * @param user SELinux user label + * @param role SELinux role label + * @param type SELinux type label + * @param level SELinux level label + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesSELinuxContext( + // Disable SELinux + @Json(name = "Disable") + var disable: kotlin.Boolean? = null, + // SELinux user label + @Json(name = "User") + var user: kotlin.String? = null, + // SELinux role label + @Json(name = "Role") + var role: kotlin.String? = null, + // SELinux type label + @Json(name = "Type") + var type: kotlin.String? = null, + // SELinux level label + @Json(name = "Level") + var level: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt new file mode 100644 index 00000000..1e97933d --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Options for configuring seccomp on the container + * + * @param mode + * @param profile The custom seccomp profile as a json object + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesSeccomp( + @Json(name = "Mode") + var mode: TaskSpecContainerSpecPrivilegesSeccomp.Mode? = null, + // The custom seccomp profile as a json object + @Json(name = "Profile") + var profile: kotlin.String? = null, +) { + /** + * + * + * Values: Default,Unconfined,Custom + */ + @JsonClass(generateAdapter = false) + enum class Mode(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "unconfined") + Unconfined("unconfined"), + + @Json(name = "custom") + Custom("custom"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt new file mode 100644 index 00000000..9610bf14 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt @@ -0,0 +1,38 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param file + * @param secretID SecretID represents the ID of the specific secret that we're referencing. + * @param secretName SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecSecretsInner( + @Json(name = "File") + var file: TaskSpecContainerSpecSecretsInnerFile? = null, + // SecretID represents the ID of the specific secret that we're referencing. + @Json(name = "SecretID") + var secretID: kotlin.String? = null, + // SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. + @Json(name = "SecretName") + var secretName: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt new file mode 100644 index 00000000..d826a4a1 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * File represents a specific target that is backed by a file. + * + * @param name Name represents the final filename in the filesystem. + * @param UID UID represents the file UID. + * @param GID GID represents the file GID. + * @param mode Mode represents the FileMode of the file. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecSecretsInnerFile( + // Name represents the final filename in the filesystem. + @Json(name = "Name") + var name: kotlin.String? = null, + // UID represents the file UID. + @Json(name = "UID") + var UID: kotlin.String? = null, + // GID represents the file GID. + @Json(name = "GID") + var GID: kotlin.String? = null, + // Mode represents the FileMode of the file. + @Json(name = "Mode") + var mode: kotlin.Int? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt new file mode 100644 index 00000000..d2da8e5e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified. + * + * @param name + * @param options + */ +@JsonClass(generateAdapter = true) +data class TaskSpecLogDriver( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt new file mode 100644 index 00000000..9da84bd1 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Read-only spec type for non-swarm containers attached to swarm overlay networks.


> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`. + * + * @param containerID ID of the container represented by this task + */ +@JsonClass(generateAdapter = true) +data class TaskSpecNetworkAttachmentSpec( + // ID of the container represented by this task + @Json(name = "ContainerID") + var containerID: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt new file mode 100644 index 00000000..48ec3c98 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param constraints An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). + * @param preferences Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. + * @param maxReplicas Maximum number of replicas for per node (default value is 0, which is unlimited) + * @param platforms Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPlacement( + // An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). + @Json(name = "Constraints") + var constraints: kotlin.collections.MutableList? = null, + // Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. + @Json(name = "Preferences") + var preferences: kotlin.collections.MutableList? = null, + // Maximum number of replicas for per node (default value is 0, which is unlimited) + @Json(name = "MaxReplicas") + var maxReplicas: kotlin.Long? = 0L, + // Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. + @Json(name = "Platforms") + var platforms: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt new file mode 100644 index 00000000..153c8988 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param spread + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPlacementPreferencesInner( + @Json(name = "Spread") + var spread: TaskSpecPlacementPreferencesInnerSpread? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt new file mode 100644 index 00000000..14dec45c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param spreadDescriptor label descriptor, such as `engine.labels.az`. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPlacementPreferencesInnerSpread( + // label descriptor, such as `engine.labels.az`. + @Json(name = "SpreadDescriptor") + var spreadDescriptor: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt new file mode 100644 index 00000000..c67c19fc --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Plugin spec for the service. *(Experimental release only.)*


> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`. + * + * @param name The name or 'alias' to use for the plugin. + * @param remote The plugin image reference to use. + * @param disabled Disable the plugin once scheduled. + * @param pluginPrivilege + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPluginSpec( + // The name or 'alias' to use for the plugin. + @Json(name = "Name") + var name: kotlin.String? = null, + // The plugin image reference to use. + @Json(name = "Remote") + var remote: kotlin.String? = null, + // Disable the plugin once scheduled. + @Json(name = "Disabled") + var disabled: kotlin.Boolean? = null, + @Json(name = "PluginPrivilege") + var pluginPrivilege: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt new file mode 100644 index 00000000..2696e48e --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Resource requirements which apply to each individual container created as part of the service. + * + * @param limits + * @param reservations + */ +@JsonClass(generateAdapter = true) +data class TaskSpecResources( + @Json(name = "Limits") + var limits: Limit? = null, + @Json(name = "Reservations") + var reservations: ResourceObject? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt new file mode 100644 index 00000000..2c4b496a --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt @@ -0,0 +1,60 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for the restart policy which applies to containers created as part of this service. + * + * @param condition Condition for restart. + * @param delay Delay between restart attempts. + * @param maxAttempts Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). + * @param window Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). + */ +@JsonClass(generateAdapter = true) +data class TaskSpecRestartPolicy( + // Condition for restart. + @Json(name = "Condition") + var condition: TaskSpecRestartPolicy.Condition? = null, + // Delay between restart attempts. + @Json(name = "Delay") + var delay: kotlin.Long? = null, + // Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). + @Json(name = "MaxAttempts") + var maxAttempts: kotlin.Long? = 0L, + // Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). + @Json(name = "Window") + var window: kotlin.Long? = 0L, +) { + /** + * Condition for restart. + * + * Values: None,OnFailure,Any + */ + @JsonClass(generateAdapter = false) + enum class Condition(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "on-failure") + OnFailure("on-failure"), + + @Json(name = "any") + Any("any"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt new file mode 100644 index 00000000..cda67294 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt @@ -0,0 +1,101 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * Values: New,Allocated,Pending,Assigned,Accepted,Preparing,Ready,Starting,Running,Complete,Shutdown,Failed,Rejected,Remove,Orphaned + */ + +@JsonClass(generateAdapter = false) +enum class TaskState(val value: kotlin.String) { + @Json(name = "new") + New("new"), + + @Json(name = "allocated") + Allocated("allocated"), + + @Json(name = "pending") + Pending("pending"), + + @Json(name = "assigned") + Assigned("assigned"), + + @Json(name = "accepted") + Accepted("accepted"), + + @Json(name = "preparing") + Preparing("preparing"), + + @Json(name = "ready") + Ready("ready"), + + @Json(name = "starting") + Starting("starting"), + + @Json(name = "running") + Running("running"), + + @Json(name = "complete") + Complete("complete"), + + @Json(name = "shutdown") + Shutdown("shutdown"), + + @Json(name = "failed") + Failed("failed"), + + @Json(name = "rejected") + Rejected("rejected"), + + @Json(name = "remove") + Remove("remove"), + + @Json(name = "orphaned") + Orphaned("orphaned"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is TaskState) "$data" else null + + /** + * Returns a valid [TaskState] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): TaskState? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt new file mode 100644 index 00000000..58b067ab --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents the status of a task. + * + * @param timestamp + * @param state + * @param message + * @param err + * @param containerStatus + * @param portStatus + */ +@JsonClass(generateAdapter = true) +data class TaskStatus( + @Json(name = "Timestamp") + var timestamp: kotlin.String? = null, + @Json(name = "State") + var state: TaskState? = null, + @Json(name = "Message") + var message: kotlin.String? = null, + @Json(name = "Err") + var err: kotlin.String? = null, + @Json(name = "ContainerStatus") + var containerStatus: ContainerStatus? = null, + @Json(name = "PortStatus") + var portStatus: PortStatus? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt new file mode 100644 index 00000000..b5a9f291 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param path Device path + * @param rate Rate + */ +@JsonClass(generateAdapter = true) +data class ThrottleDevice( + // Device path + @Json(name = "Path") + var path: kotlin.String? = null, + // Rate + @Json(name = "Rate") + var rate: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt new file mode 100644 index 00000000..7252fe84 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param unlockKey The swarm's unlock key. + */ +@JsonClass(generateAdapter = true) +data class UnlockKeyResponse( + // The swarm's unlock key. + @Json(name = "UnlockKey") + var unlockKey: kotlin.String? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt new file mode 100644 index 00000000..c986185c --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt @@ -0,0 +1,79 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the volume. + * @param driver Name of the volume driver used by the volume. + * @param mountpoint Mount path of the volume on the host. + * @param options The driver specific options used when creating the volume. + * @param createdAt Date/Time the volume was created. + * @param status Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. + * @param labels User-defined key/value metadata. + * @param scope The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. + * @param clusterVolume + * @param usageData + */ +@JsonClass(generateAdapter = true) +data class Volume( + // Name of the volume. + @Json(name = "Name") + var name: kotlin.String, + // Name of the volume driver used by the volume. + @Json(name = "Driver") + var driver: kotlin.String, + // Mount path of the volume on the host. + @Json(name = "Mountpoint") + var mountpoint: kotlin.String, + // The driver specific options used when creating the volume. + @Json(name = "Options") + var options: kotlin.collections.MutableMap?, + // Date/Time the volume was created. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. + @Json(name = "Status") + var status: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. + @Json(name = "Scope") + var scope: Volume.Scope? = Scope.Local, + @Json(name = "ClusterVolume") + var clusterVolume: ClusterVolume? = null, + @Json(name = "UsageData") + var usageData: VolumeUsageData? = null, +) { + /** + * The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. + * + * Values: Local,Global + */ + @JsonClass(generateAdapter = false) + enum class Scope(val value: kotlin.String) { + @Json(name = "local") + Local("local"), + + @Json(name = "global") + Global("global"), + } +} diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt new file mode 100644 index 00000000..09fa21bb --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt @@ -0,0 +1,46 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Volume configuration + * + * @param name The new volume's name. If not specified, Docker generates a name. + * @param driver Name of the volume driver to use. + * @param driverOpts A mapping of driver options and values. These options are passed directly to the driver and are driver specific. + * @param labels User-defined key/value metadata. + * @param clusterVolumeSpec + */ +@JsonClass(generateAdapter = true) +data class VolumeCreateOptions( + // The new volume's name. If not specified, Docker generates a name. + @Json(name = "Name") + var name: kotlin.String? = null, + // Name of the volume driver to use. + @Json(name = "Driver") + var driver: kotlin.String? = "local", + // A mapping of driver options and values. These options are passed directly to the driver and are driver specific. + @Json(name = "DriverOpts") + var driverOpts: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "ClusterVolumeSpec") + var clusterVolumeSpec: ClusterVolumeSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt new file mode 100644 index 00000000..0292cf47 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Volume list response + * + * @param volumes List of volumes + * @param warnings Warnings that occurred when fetching the list of volumes. + */ +@JsonClass(generateAdapter = true) +data class VolumeListResponse( + // List of volumes + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableList? = null, + // Warnings that occurred when fetching the list of volumes. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt new file mode 100644 index 00000000..b5c37a0f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param volumesDeleted Volumes that were deleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class VolumePruneResponse( + // Volumes that were deleted + @Json(name = "VolumesDeleted") + var volumesDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt new file mode 100644 index 00000000..0c94e57f --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Volume configuration + * + * @param spec + */ +@JsonClass(generateAdapter = true) +data class VolumeUpdateRequest( + @Json(name = "Spec") + var spec: ClusterVolumeSpec? = null, +) diff --git a/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt new file mode 100644 index 00000000..b9fee8d7 --- /dev/null +++ b/api-model-v1-44/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints. + * + * @param propertySize Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") + * @param refCount The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. + */ +@JsonClass(generateAdapter = true) +data class VolumeUsageData( + // Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") + @Json(name = "Size") + var propertySize: kotlin.Long = -1L, + // The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. + @Json(name = "RefCount") + var refCount: kotlin.Long = -1L, +) diff --git a/api-model-v1-44/src/test/java/de/gesellix/docker/remote/api/ContainerCreateRequestTest.java b/api-model-v1-44/src/test/java/de/gesellix/docker/remote/api/ContainerCreateRequestTest.java new file mode 100644 index 00000000..d7ba2c18 --- /dev/null +++ b/api-model-v1-44/src/test/java/de/gesellix/docker/remote/api/ContainerCreateRequestTest.java @@ -0,0 +1,21 @@ +package de.gesellix.docker.remote.api; + +import org.junit.jupiter.api.Test; + +import java.lang.reflect.Field; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ContainerCreateRequestTest { + + @Test + public void ensureContainerCreateRequestFields() { + Field[] containerConfigFields = ContainerConfig.class.getDeclaredFields(); + + Field[] containerCreateRequestFields = ContainerCreateRequest.class.getDeclaredFields(); + + assertEquals( + containerConfigFields.length + 1 /* HostConfig */ + 1 /* NetworkingConfig */, + containerCreateRequestFields.length); + } +} diff --git a/api-model-v1-44/src/test/java/de/gesellix/docker/remote/api/ContainerUpdateRequestTest.java b/api-model-v1-44/src/test/java/de/gesellix/docker/remote/api/ContainerUpdateRequestTest.java new file mode 100644 index 00000000..aa055322 --- /dev/null +++ b/api-model-v1-44/src/test/java/de/gesellix/docker/remote/api/ContainerUpdateRequestTest.java @@ -0,0 +1,21 @@ +package de.gesellix.docker.remote.api; + +import org.junit.jupiter.api.Test; + +import java.lang.reflect.Field; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ContainerUpdateRequestTest { + + @Test + public void ensureContainerUpdateRequestFields() { + Field[] resourcesFields = Resources.class.getDeclaredFields(); + + Field[] containerUpdateRequestFields = ContainerUpdateRequest.class.getDeclaredFields(); + + assertEquals( + resourcesFields.length + 1 /* RestartPolicy */, + containerUpdateRequestFields.length); + } +} diff --git a/api-model-v1-52/.gitignore b/api-model-v1-52/.gitignore new file mode 100644 index 00000000..e6d38dac --- /dev/null +++ b/api-model-v1-52/.gitignore @@ -0,0 +1,24 @@ +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.ear + +# exclude jar for gradle wrapper +!gradle/wrapper/*.jar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +# build files +**/target +target +.gradle +build + +**/de/gesellix/docker/remote/client/api +**/de/gesellix/docker/remote/api/infrastructure diff --git a/api-model-v1-52/.openapi-generator-ignore b/api-model-v1-52/.openapi-generator-ignore new file mode 100644 index 00000000..7484ee59 --- /dev/null +++ b/api-model-v1-52/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/api-model-v1-52/.openapi-generator/FILES b/api-model-v1-52/.openapi-generator/FILES new file mode 100644 index 00000000..e186a81a --- /dev/null +++ b/api-model-v1-52/.openapi-generator/FILES @@ -0,0 +1,540 @@ +README.md +build.gradle +docs/Address.md +docs/AuthConfig.md +docs/AuthResponse.md +docs/BuildCache.md +docs/BuildCacheDiskUsage.md +docs/BuildInfo.md +docs/BuildPruneResponse.md +docs/ChangeType.md +docs/ClusterInfo.md +docs/ClusterVolume.md +docs/ClusterVolumeInfo.md +docs/ClusterVolumePublishStatusInner.md +docs/ClusterVolumeSpec.md +docs/ClusterVolumeSpecAccessMode.md +docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md +docs/ClusterVolumeSpecAccessModeCapacityRange.md +docs/ClusterVolumeSpecAccessModeSecretsInner.md +docs/Commit.md +docs/Config.md +docs/ConfigApi.md +docs/ConfigCreateRequest.md +docs/ConfigReference.md +docs/ConfigSpec.md +docs/ContainerApi.md +docs/ContainerBlkioStatEntry.md +docs/ContainerBlkioStats.md +docs/ContainerCPUStats.md +docs/ContainerCPUUsage.md +docs/ContainerConfig.md +docs/ContainerCreateRequest.md +docs/ContainerCreateResponse.md +docs/ContainerInspectResponse.md +docs/ContainerMemoryStats.md +docs/ContainerNetworkStats.md +docs/ContainerPidsStats.md +docs/ContainerPruneResponse.md +docs/ContainerState.md +docs/ContainerStatsResponse.md +docs/ContainerStatus.md +docs/ContainerStorageStats.md +docs/ContainerSummary.md +docs/ContainerSummaryHealth.md +docs/ContainerSummaryHostConfig.md +docs/ContainerSummaryNetworkSettings.md +docs/ContainerThrottlingData.md +docs/ContainerTopResponse.md +docs/ContainerUpdateRequest.md +docs/ContainerUpdateResponse.md +docs/ContainerWaitExitError.md +docs/ContainerWaitResponse.md +docs/ContainerdInfo.md +docs/ContainerdInfoNamespaces.md +docs/ContainersDiskUsage.md +docs/CreateImageInfo.md +docs/DeviceInfo.md +docs/DeviceMapping.md +docs/DeviceRequest.md +docs/DistributionApi.md +docs/DistributionInspect.md +docs/Driver.md +docs/DriverData.md +docs/EndpointIPAMConfig.md +docs/EndpointPortConfig.md +docs/EndpointResource.md +docs/EndpointSettings.md +docs/EndpointSpec.md +docs/EngineDescription.md +docs/EngineDescriptionPluginsInner.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/FilesystemChange.md +docs/FirewallInfo.md +docs/GenericResourcesInner.md +docs/GenericResourcesInnerDiscreteResourceSpec.md +docs/GenericResourcesInnerNamedResourceSpec.md +docs/Health.md +docs/HealthConfig.md +docs/HealthcheckResult.md +docs/HistoryResponseItem.md +docs/HostConfig.md +docs/HostConfigAllOfLogConfig.md +docs/IDResponse.md +docs/IPAM.md +docs/IPAMConfig.md +docs/IPAMStatus.md +docs/ImageApi.md +docs/ImageConfig.md +docs/ImageDeleteResponseItem.md +docs/ImageID.md +docs/ImageInspect.md +docs/ImageInspectMetadata.md +docs/ImageInspectRootFS.md +docs/ImageManifestSummary.md +docs/ImageManifestSummaryAttestationData.md +docs/ImageManifestSummaryImageData.md +docs/ImageManifestSummaryImageDataSize.md +docs/ImageManifestSummarySize.md +docs/ImagePruneResponse.md +docs/ImageSearchResponseItem.md +docs/ImageSummary.md +docs/ImagesDiskUsage.md +docs/IndexInfo.md +docs/JoinTokens.md +docs/Limit.md +docs/LocalNodeState.md +docs/ManagerStatus.md +docs/Mount.md +docs/MountBindOptions.md +docs/MountImageOptions.md +docs/MountPoint.md +docs/MountTmpfsOptions.md +docs/MountVolumeOptions.md +docs/MountVolumeOptionsDriverConfig.md +docs/Network.md +docs/NetworkApi.md +docs/NetworkAttachmentConfig.md +docs/NetworkConnectRequest.md +docs/NetworkCreateRequest.md +docs/NetworkCreateResponse.md +docs/NetworkDisconnectRequest.md +docs/NetworkInspect.md +docs/NetworkPruneResponse.md +docs/NetworkSettings.md +docs/NetworkStatus.md +docs/NetworkSummary.md +docs/NetworkTaskInfo.md +docs/NetworkingConfig.md +docs/Node.md +docs/NodeApi.md +docs/NodeDescription.md +docs/NodeSpec.md +docs/NodeState.md +docs/NodeStatus.md +docs/OCIDescriptor.md +docs/OCIPlatform.md +docs/ObjectVersion.md +docs/PeerInfo.md +docs/PeerNode.md +docs/Platform.md +docs/Plugin.md +docs/PluginApi.md +docs/PluginConfig.md +docs/PluginConfigArgs.md +docs/PluginConfigInterface.md +docs/PluginConfigLinux.md +docs/PluginConfigNetwork.md +docs/PluginConfigRootfs.md +docs/PluginConfigUser.md +docs/PluginDevice.md +docs/PluginEnv.md +docs/PluginMount.md +docs/PluginPrivilege.md +docs/PluginSettings.md +docs/PluginsInfo.md +docs/PortBinding.md +docs/PortStatus.md +docs/PortSummary.md +docs/ProcessConfig.md +docs/ProgressDetail.md +docs/PushImageInfo.md +docs/Reachability.md +docs/RegistryServiceConfig.md +docs/ResourceObject.md +docs/Resources.md +docs/ResourcesBlkioWeightDeviceInner.md +docs/ResourcesUlimitsInner.md +docs/RestartPolicy.md +docs/RootFSStorage.md +docs/RootFSStorageSnapshot.md +docs/Runtime.md +docs/Secret.md +docs/SecretApi.md +docs/SecretCreateRequest.md +docs/SecretSpec.md +docs/Service.md +docs/ServiceApi.md +docs/ServiceCreateRequest.md +docs/ServiceCreateResponse.md +docs/ServiceEndpoint.md +docs/ServiceEndpointVirtualIPsInner.md +docs/ServiceInfo.md +docs/ServiceJobStatus.md +docs/ServiceServiceStatus.md +docs/ServiceSpec.md +docs/ServiceSpecMode.md +docs/ServiceSpecModeReplicated.md +docs/ServiceSpecModeReplicatedJob.md +docs/ServiceSpecRollbackConfig.md +docs/ServiceSpecUpdateConfig.md +docs/ServiceUpdateRequest.md +docs/ServiceUpdateResponse.md +docs/ServiceUpdateStatus.md +docs/SessionApi.md +docs/Storage.md +docs/SubnetStatus.md +docs/Swarm.md +docs/SwarmApi.md +docs/SwarmInfo.md +docs/SwarmInitRequest.md +docs/SwarmJoinRequest.md +docs/SwarmSpec.md +docs/SwarmSpecCAConfig.md +docs/SwarmSpecCAConfigExternalCAsInner.md +docs/SwarmSpecDispatcher.md +docs/SwarmSpecEncryptionConfig.md +docs/SwarmSpecOrchestration.md +docs/SwarmSpecRaft.md +docs/SwarmSpecTaskDefaults.md +docs/SwarmSpecTaskDefaultsLogDriver.md +docs/SwarmUnlockRequest.md +docs/SystemApi.md +docs/SystemDataUsageResponse.md +docs/SystemInfo.md +docs/SystemInfoDefaultAddressPoolsInner.md +docs/SystemVersion.md +docs/SystemVersionComponentsInner.md +docs/SystemVersionPlatform.md +docs/TLSInfo.md +docs/Task.md +docs/TaskApi.md +docs/TaskSpec.md +docs/TaskSpecContainerSpec.md +docs/TaskSpecContainerSpecConfigsInner.md +docs/TaskSpecContainerSpecConfigsInnerFile.md +docs/TaskSpecContainerSpecDNSConfig.md +docs/TaskSpecContainerSpecPrivileges.md +docs/TaskSpecContainerSpecPrivilegesAppArmor.md +docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md +docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md +docs/TaskSpecContainerSpecPrivilegesSeccomp.md +docs/TaskSpecContainerSpecSecretsInner.md +docs/TaskSpecContainerSpecSecretsInnerFile.md +docs/TaskSpecLogDriver.md +docs/TaskSpecNetworkAttachmentSpec.md +docs/TaskSpecPlacement.md +docs/TaskSpecPlacementPreferencesInner.md +docs/TaskSpecPlacementPreferencesInnerSpread.md +docs/TaskSpecPluginSpec.md +docs/TaskSpecResources.md +docs/TaskSpecRestartPolicy.md +docs/TaskState.md +docs/TaskStatus.md +docs/ThrottleDevice.md +docs/UnlockKeyResponse.md +docs/Volume.md +docs/VolumeApi.md +docs/VolumeCreateRequest.md +docs/VolumeListResponse.md +docs/VolumePruneResponse.md +docs/VolumeUpdateRequest.md +docs/VolumeUsageData.md +docs/VolumesDiskUsage.md +gradle/wrapper/gradle-wrapper.jar +gradle/wrapper/gradle-wrapper.properties +gradlew +gradlew.bat +settings.gradle +src/main/kotlin/de/gesellix/docker/remote/api/Address.kt +src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/AuthResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildCacheDiskUsage.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt +src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt +src/main/kotlin/de/gesellix/docker/remote/api/Config.kt +src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt +src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStatEntry.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStats.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUStats.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUUsage.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerMemoryStats.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerNetworkStats.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerPidsStats.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatsResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerStorageStats.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHealth.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerThrottlingData.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfoNamespaces.kt +src/main/kotlin/de/gesellix/docker/remote/api/ContainersDiskUsage.kt +src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/DeviceInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt +src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt +src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt +src/main/kotlin/de/gesellix/docker/remote/api/DriverData.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointResource.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt +src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt +src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt +src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt +src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt +src/main/kotlin/de/gesellix/docker/remote/api/FirewallInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/Health.kt +src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt +src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt +src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/IDResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt +src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/IPAMStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryAttestationData.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageData.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageDataSize.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummarySize.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/ImagesDiskUsage.kt +src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt +src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt +src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt +src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountImageOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt +src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/Network.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkInspect.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkTaskInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/Node.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt +src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt +src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt +src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt +src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt +src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt +src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt +src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt +src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/PortSummary.kt +src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt +src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt +src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt +src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt +src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt +src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorage.kt +src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorageSnapshot.kt +src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt +src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt +src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/Service.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/Storage.kt +src/main/kotlin/de/gesellix/docker/remote/api/SubnetStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt +src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt +src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt +src/main/kotlin/de/gesellix/docker/remote/api/Task.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt +src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt +src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt +src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt +src/main/kotlin/de/gesellix/docker/remote/api/VolumesDiskUsage.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ApiAbstractions.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ApiClient.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ApiResponse.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/BigDecimalAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/BigIntegerAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ByteArrayAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/Errors.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/LocalDateAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/LocalDateTimeAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/OffsetDateTimeAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/PartConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/RequestConfig.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/RequestMethod.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/ResponseExtensions.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/Serializer.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/URIAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/api/infrastructure/UUIDAdapter.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ConfigApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ContainerApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/DistributionApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ExecApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ImageApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/NetworkApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/NodeApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/PluginApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SecretApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/ServiceApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SessionApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SwarmApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/SystemApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/TaskApi.kt +src/main/kotlin/de/gesellix/docker/remote/client/api/VolumeApi.kt diff --git a/api-model-v1-52/.openapi-generator/VERSION b/api-model-v1-52/.openapi-generator/VERSION new file mode 100644 index 00000000..6328c542 --- /dev/null +++ b/api-model-v1-52/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.17.0 diff --git a/api-model-v1-52/README.md b/api-model-v1-52/README.md new file mode 100644 index 00000000..27d3e622 --- /dev/null +++ b/api-model-v1-52/README.md @@ -0,0 +1,479 @@ +# de.gesellix.docker.remote.api - Kotlin client library for 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.50) is used. +For example, calling `/info` is the same as calling `/v1.52/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 the 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\", + \"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...\" +} +``` + + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client. + +- API version: 1.52 +- Package version: +- Generator version: 7.17.0 +- Build package: org.openapitools.codegen.languages.KotlinClientCodegen + +## Requires + +* Kotlin 2.2.20 +* Gradle 8.14 + +## Build + +First, create the gradle wrapper script: + +``` +gradle wrapper +``` + +Then, run: + +``` +./gradlew check assemble +``` + +This runs all tests and packages the library. + +## Features/Implementation Notes + +* Supports JSON inputs/outputs, File inputs, and Form inputs. +* Supports collection formats for query parameters: csv, tsv, ssv, pipes. +* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions. +* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets. + + +## Documentation for API Endpoints + +All URIs are relative to *http://localhost/v1.52* + +| Class | Method | HTTP request | Description | +| ------------ | ------------- | ------------- | ------------- | +| *ConfigApi* | [**configCreate**](docs/ConfigApi.md#configcreate) | **POST** /configs/create | Create a config | +| *ConfigApi* | [**configDelete**](docs/ConfigApi.md#configdelete) | **DELETE** /configs/{id} | Delete a config | +| *ConfigApi* | [**configInspect**](docs/ConfigApi.md#configinspect) | **GET** /configs/{id} | Inspect a config | +| *ConfigApi* | [**configList**](docs/ConfigApi.md#configlist) | **GET** /configs | List configs | +| *ConfigApi* | [**configUpdate**](docs/ConfigApi.md#configupdate) | **POST** /configs/{id}/update | Update a Config | +| *ContainerApi* | [**containerArchive**](docs/ContainerApi.md#containerarchive) | **GET** /containers/{id}/archive | Get an archive of a filesystem resource in a container | +| *ContainerApi* | [**containerArchiveInfo**](docs/ContainerApi.md#containerarchiveinfo) | **HEAD** /containers/{id}/archive | Get information about files in a container | +| *ContainerApi* | [**containerAttach**](docs/ContainerApi.md#containerattach) | **POST** /containers/{id}/attach | Attach to a container | +| *ContainerApi* | [**containerAttachWebsocket**](docs/ContainerApi.md#containerattachwebsocket) | **GET** /containers/{id}/attach/ws | Attach to a container via a websocket | +| *ContainerApi* | [**containerChanges**](docs/ContainerApi.md#containerchanges) | **GET** /containers/{id}/changes | Get changes on a container’s filesystem | +| *ContainerApi* | [**containerCreate**](docs/ContainerApi.md#containercreate) | **POST** /containers/create | Create a container | +| *ContainerApi* | [**containerDelete**](docs/ContainerApi.md#containerdelete) | **DELETE** /containers/{id} | Remove a container | +| *ContainerApi* | [**containerExport**](docs/ContainerApi.md#containerexport) | **GET** /containers/{id}/export | Export a container | +| *ContainerApi* | [**containerInspect**](docs/ContainerApi.md#containerinspect) | **GET** /containers/{id}/json | Inspect a container | +| *ContainerApi* | [**containerKill**](docs/ContainerApi.md#containerkill) | **POST** /containers/{id}/kill | Kill a container | +| *ContainerApi* | [**containerList**](docs/ContainerApi.md#containerlist) | **GET** /containers/json | List containers | +| *ContainerApi* | [**containerLogs**](docs/ContainerApi.md#containerlogs) | **GET** /containers/{id}/logs | Get container logs | +| *ContainerApi* | [**containerPause**](docs/ContainerApi.md#containerpause) | **POST** /containers/{id}/pause | Pause a container | +| *ContainerApi* | [**containerPrune**](docs/ContainerApi.md#containerprune) | **POST** /containers/prune | Delete stopped containers | +| *ContainerApi* | [**containerRename**](docs/ContainerApi.md#containerrename) | **POST** /containers/{id}/rename | Rename a container | +| *ContainerApi* | [**containerResize**](docs/ContainerApi.md#containerresize) | **POST** /containers/{id}/resize | Resize a container TTY | +| *ContainerApi* | [**containerRestart**](docs/ContainerApi.md#containerrestart) | **POST** /containers/{id}/restart | Restart a container | +| *ContainerApi* | [**containerStart**](docs/ContainerApi.md#containerstart) | **POST** /containers/{id}/start | Start a container | +| *ContainerApi* | [**containerStats**](docs/ContainerApi.md#containerstats) | **GET** /containers/{id}/stats | Get container stats based on resource usage | +| *ContainerApi* | [**containerStop**](docs/ContainerApi.md#containerstop) | **POST** /containers/{id}/stop | Stop a container | +| *ContainerApi* | [**containerTop**](docs/ContainerApi.md#containertop) | **GET** /containers/{id}/top | List processes running inside a container | +| *ContainerApi* | [**containerUnpause**](docs/ContainerApi.md#containerunpause) | **POST** /containers/{id}/unpause | Unpause a container | +| *ContainerApi* | [**containerUpdate**](docs/ContainerApi.md#containerupdate) | **POST** /containers/{id}/update | Update a container | +| *ContainerApi* | [**containerWait**](docs/ContainerApi.md#containerwait) | **POST** /containers/{id}/wait | Wait for a container | +| *ContainerApi* | [**putContainerArchive**](docs/ContainerApi.md#putcontainerarchive) | **PUT** /containers/{id}/archive | Extract an archive of files or folders to a directory in a container | +| *DistributionApi* | [**distributionInspect**](docs/DistributionApi.md#distributioninspect) | **GET** /distribution/{name}/json | Get image information from the registry | +| *ExecApi* | [**containerExec**](docs/ExecApi.md#containerexec) | **POST** /containers/{id}/exec | Create an exec instance | +| *ExecApi* | [**execInspect**](docs/ExecApi.md#execinspect) | **GET** /exec/{id}/json | Inspect an exec instance | +| *ExecApi* | [**execResize**](docs/ExecApi.md#execresize) | **POST** /exec/{id}/resize | Resize an exec instance | +| *ExecApi* | [**execStart**](docs/ExecApi.md#execstart) | **POST** /exec/{id}/start | Start an exec instance | +| *ImageApi* | [**buildPrune**](docs/ImageApi.md#buildprune) | **POST** /build/prune | Delete builder cache | +| *ImageApi* | [**imageBuild**](docs/ImageApi.md#imagebuild) | **POST** /build | Build an image | +| *ImageApi* | [**imageCommit**](docs/ImageApi.md#imagecommit) | **POST** /commit | Create a new image from a container | +| *ImageApi* | [**imageCreate**](docs/ImageApi.md#imagecreate) | **POST** /images/create | Create an image | +| *ImageApi* | [**imageDelete**](docs/ImageApi.md#imagedelete) | **DELETE** /images/{name} | Remove an image | +| *ImageApi* | [**imageGet**](docs/ImageApi.md#imageget) | **GET** /images/{name}/get | Export an image | +| *ImageApi* | [**imageGetAll**](docs/ImageApi.md#imagegetall) | **GET** /images/get | Export several images | +| *ImageApi* | [**imageHistory**](docs/ImageApi.md#imagehistory) | **GET** /images/{name}/history | Get the history of an image | +| *ImageApi* | [**imageInspect**](docs/ImageApi.md#imageinspect) | **GET** /images/{name}/json | Inspect an image | +| *ImageApi* | [**imageList**](docs/ImageApi.md#imagelist) | **GET** /images/json | List Images | +| *ImageApi* | [**imageLoad**](docs/ImageApi.md#imageload) | **POST** /images/load | Import images | +| *ImageApi* | [**imagePrune**](docs/ImageApi.md#imageprune) | **POST** /images/prune | Delete unused images | +| *ImageApi* | [**imagePush**](docs/ImageApi.md#imagepush) | **POST** /images/{name}/push | Push an image | +| *ImageApi* | [**imageSearch**](docs/ImageApi.md#imagesearch) | **GET** /images/search | Search images | +| *ImageApi* | [**imageTag**](docs/ImageApi.md#imagetag) | **POST** /images/{name}/tag | Tag an image | +| *NetworkApi* | [**networkConnect**](docs/NetworkApi.md#networkconnect) | **POST** /networks/{id}/connect | Connect a container to a network | +| *NetworkApi* | [**networkCreate**](docs/NetworkApi.md#networkcreate) | **POST** /networks/create | Create a network | +| *NetworkApi* | [**networkDelete**](docs/NetworkApi.md#networkdelete) | **DELETE** /networks/{id} | Remove a network | +| *NetworkApi* | [**networkDisconnect**](docs/NetworkApi.md#networkdisconnect) | **POST** /networks/{id}/disconnect | Disconnect a container from a network | +| *NetworkApi* | [**networkInspect**](docs/NetworkApi.md#networkinspect) | **GET** /networks/{id} | Inspect a network | +| *NetworkApi* | [**networkList**](docs/NetworkApi.md#networklist) | **GET** /networks | List networks | +| *NetworkApi* | [**networkPrune**](docs/NetworkApi.md#networkprune) | **POST** /networks/prune | Delete unused networks | +| *NodeApi* | [**nodeDelete**](docs/NodeApi.md#nodedelete) | **DELETE** /nodes/{id} | Delete a node | +| *NodeApi* | [**nodeInspect**](docs/NodeApi.md#nodeinspect) | **GET** /nodes/{id} | Inspect a node | +| *NodeApi* | [**nodeList**](docs/NodeApi.md#nodelist) | **GET** /nodes | List nodes | +| *NodeApi* | [**nodeUpdate**](docs/NodeApi.md#nodeupdate) | **POST** /nodes/{id}/update | Update a node | +| *PluginApi* | [**getPluginPrivileges**](docs/PluginApi.md#getpluginprivileges) | **GET** /plugins/privileges | Get plugin privileges | +| *PluginApi* | [**pluginCreate**](docs/PluginApi.md#plugincreate) | **POST** /plugins/create | Create a plugin | +| *PluginApi* | [**pluginDelete**](docs/PluginApi.md#plugindelete) | **DELETE** /plugins/{name} | Remove a plugin | +| *PluginApi* | [**pluginDisable**](docs/PluginApi.md#plugindisable) | **POST** /plugins/{name}/disable | Disable a plugin | +| *PluginApi* | [**pluginEnable**](docs/PluginApi.md#pluginenable) | **POST** /plugins/{name}/enable | Enable a plugin | +| *PluginApi* | [**pluginInspect**](docs/PluginApi.md#plugininspect) | **GET** /plugins/{name}/json | Inspect a plugin | +| *PluginApi* | [**pluginList**](docs/PluginApi.md#pluginlist) | **GET** /plugins | List plugins | +| *PluginApi* | [**pluginPull**](docs/PluginApi.md#pluginpull) | **POST** /plugins/pull | Install a plugin | +| *PluginApi* | [**pluginPush**](docs/PluginApi.md#pluginpush) | **POST** /plugins/{name}/push | Push a plugin | +| *PluginApi* | [**pluginSet**](docs/PluginApi.md#pluginset) | **POST** /plugins/{name}/set | Configure a plugin | +| *PluginApi* | [**pluginUpgrade**](docs/PluginApi.md#pluginupgrade) | **POST** /plugins/{name}/upgrade | Upgrade a plugin | +| *SecretApi* | [**secretCreate**](docs/SecretApi.md#secretcreate) | **POST** /secrets/create | Create a secret | +| *SecretApi* | [**secretDelete**](docs/SecretApi.md#secretdelete) | **DELETE** /secrets/{id} | Delete a secret | +| *SecretApi* | [**secretInspect**](docs/SecretApi.md#secretinspect) | **GET** /secrets/{id} | Inspect a secret | +| *SecretApi* | [**secretList**](docs/SecretApi.md#secretlist) | **GET** /secrets | List secrets | +| *SecretApi* | [**secretUpdate**](docs/SecretApi.md#secretupdate) | **POST** /secrets/{id}/update | Update a Secret | +| *ServiceApi* | [**serviceCreate**](docs/ServiceApi.md#servicecreate) | **POST** /services/create | Create a service | +| *ServiceApi* | [**serviceDelete**](docs/ServiceApi.md#servicedelete) | **DELETE** /services/{id} | Delete a service | +| *ServiceApi* | [**serviceInspect**](docs/ServiceApi.md#serviceinspect) | **GET** /services/{id} | Inspect a service | +| *ServiceApi* | [**serviceList**](docs/ServiceApi.md#servicelist) | **GET** /services | List services | +| *ServiceApi* | [**serviceLogs**](docs/ServiceApi.md#servicelogs) | **GET** /services/{id}/logs | Get service logs | +| *ServiceApi* | [**serviceUpdate**](docs/ServiceApi.md#serviceupdate) | **POST** /services/{id}/update | Update a service | +| *SessionApi* | [**session**](docs/SessionApi.md#session) | **POST** /session | Initialize interactive session | +| *SwarmApi* | [**swarmInit**](docs/SwarmApi.md#swarminit) | **POST** /swarm/init | Initialize a new swarm | +| *SwarmApi* | [**swarmInspect**](docs/SwarmApi.md#swarminspect) | **GET** /swarm | Inspect swarm | +| *SwarmApi* | [**swarmJoin**](docs/SwarmApi.md#swarmjoin) | **POST** /swarm/join | Join an existing swarm | +| *SwarmApi* | [**swarmLeave**](docs/SwarmApi.md#swarmleave) | **POST** /swarm/leave | Leave a swarm | +| *SwarmApi* | [**swarmUnlock**](docs/SwarmApi.md#swarmunlock) | **POST** /swarm/unlock | Unlock a locked manager | +| *SwarmApi* | [**swarmUnlockkey**](docs/SwarmApi.md#swarmunlockkey) | **GET** /swarm/unlockkey | Get the unlock key | +| *SwarmApi* | [**swarmUpdate**](docs/SwarmApi.md#swarmupdate) | **POST** /swarm/update | Update a swarm | +| *SystemApi* | [**systemAuth**](docs/SystemApi.md#systemauth) | **POST** /auth | Check auth configuration | +| *SystemApi* | [**systemDataUsage**](docs/SystemApi.md#systemdatausage) | **GET** /system/df | Get data usage information | +| *SystemApi* | [**systemEvents**](docs/SystemApi.md#systemevents) | **GET** /events | Monitor events | +| *SystemApi* | [**systemInfo**](docs/SystemApi.md#systeminfo) | **GET** /info | Get system information | +| *SystemApi* | [**systemPing**](docs/SystemApi.md#systemping) | **GET** /_ping | Ping | +| *SystemApi* | [**systemPingHead**](docs/SystemApi.md#systempinghead) | **HEAD** /_ping | Ping | +| *SystemApi* | [**systemVersion**](docs/SystemApi.md#systemversion) | **GET** /version | Get version | +| *TaskApi* | [**taskInspect**](docs/TaskApi.md#taskinspect) | **GET** /tasks/{id} | Inspect a task | +| *TaskApi* | [**taskList**](docs/TaskApi.md#tasklist) | **GET** /tasks | List tasks | +| *TaskApi* | [**taskLogs**](docs/TaskApi.md#tasklogs) | **GET** /tasks/{id}/logs | Get task logs | +| *VolumeApi* | [**volumeCreate**](docs/VolumeApi.md#volumecreate) | **POST** /volumes/create | Create a volume | +| *VolumeApi* | [**volumeDelete**](docs/VolumeApi.md#volumedelete) | **DELETE** /volumes/{name} | Remove a volume | +| *VolumeApi* | [**volumeInspect**](docs/VolumeApi.md#volumeinspect) | **GET** /volumes/{name} | Inspect a volume | +| *VolumeApi* | [**volumeList**](docs/VolumeApi.md#volumelist) | **GET** /volumes | List volumes | +| *VolumeApi* | [**volumePrune**](docs/VolumeApi.md#volumeprune) | **POST** /volumes/prune | Delete unused volumes | +| *VolumeApi* | [**volumeUpdate**](docs/VolumeApi.md#volumeupdate) | **PUT** /volumes/{name} | \"Update a volume. Valid only for Swarm cluster volumes\" | + + + +## Documentation for Models + + - [de.gesellix.docker.remote.api.Address](docs/Address.md) + - [de.gesellix.docker.remote.api.AuthConfig](docs/AuthConfig.md) + - [de.gesellix.docker.remote.api.AuthResponse](docs/AuthResponse.md) + - [de.gesellix.docker.remote.api.BuildCache](docs/BuildCache.md) + - [de.gesellix.docker.remote.api.BuildCacheDiskUsage](docs/BuildCacheDiskUsage.md) + - [de.gesellix.docker.remote.api.BuildInfo](docs/BuildInfo.md) + - [de.gesellix.docker.remote.api.BuildPruneResponse](docs/BuildPruneResponse.md) + - [de.gesellix.docker.remote.api.ChangeType](docs/ChangeType.md) + - [de.gesellix.docker.remote.api.ClusterInfo](docs/ClusterInfo.md) + - [de.gesellix.docker.remote.api.ClusterVolume](docs/ClusterVolume.md) + - [de.gesellix.docker.remote.api.ClusterVolumeInfo](docs/ClusterVolumeInfo.md) + - [de.gesellix.docker.remote.api.ClusterVolumePublishStatusInner](docs/ClusterVolumePublishStatusInner.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpec](docs/ClusterVolumeSpec.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessMode](docs/ClusterVolumeSpecAccessMode.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessModeAccessibilityRequirements](docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessModeCapacityRange](docs/ClusterVolumeSpecAccessModeCapacityRange.md) + - [de.gesellix.docker.remote.api.ClusterVolumeSpecAccessModeSecretsInner](docs/ClusterVolumeSpecAccessModeSecretsInner.md) + - [de.gesellix.docker.remote.api.Commit](docs/Commit.md) + - [de.gesellix.docker.remote.api.Config](docs/Config.md) + - [de.gesellix.docker.remote.api.ConfigCreateRequest](docs/ConfigCreateRequest.md) + - [de.gesellix.docker.remote.api.ConfigReference](docs/ConfigReference.md) + - [de.gesellix.docker.remote.api.ConfigSpec](docs/ConfigSpec.md) + - [de.gesellix.docker.remote.api.ContainerBlkioStatEntry](docs/ContainerBlkioStatEntry.md) + - [de.gesellix.docker.remote.api.ContainerBlkioStats](docs/ContainerBlkioStats.md) + - [de.gesellix.docker.remote.api.ContainerCPUStats](docs/ContainerCPUStats.md) + - [de.gesellix.docker.remote.api.ContainerCPUUsage](docs/ContainerCPUUsage.md) + - [de.gesellix.docker.remote.api.ContainerConfig](docs/ContainerConfig.md) + - [de.gesellix.docker.remote.api.ContainerCreateRequest](docs/ContainerCreateRequest.md) + - [de.gesellix.docker.remote.api.ContainerCreateResponse](docs/ContainerCreateResponse.md) + - [de.gesellix.docker.remote.api.ContainerInspectResponse](docs/ContainerInspectResponse.md) + - [de.gesellix.docker.remote.api.ContainerMemoryStats](docs/ContainerMemoryStats.md) + - [de.gesellix.docker.remote.api.ContainerNetworkStats](docs/ContainerNetworkStats.md) + - [de.gesellix.docker.remote.api.ContainerPidsStats](docs/ContainerPidsStats.md) + - [de.gesellix.docker.remote.api.ContainerPruneResponse](docs/ContainerPruneResponse.md) + - [de.gesellix.docker.remote.api.ContainerState](docs/ContainerState.md) + - [de.gesellix.docker.remote.api.ContainerStatsResponse](docs/ContainerStatsResponse.md) + - [de.gesellix.docker.remote.api.ContainerStatus](docs/ContainerStatus.md) + - [de.gesellix.docker.remote.api.ContainerStorageStats](docs/ContainerStorageStats.md) + - [de.gesellix.docker.remote.api.ContainerSummary](docs/ContainerSummary.md) + - [de.gesellix.docker.remote.api.ContainerSummaryHealth](docs/ContainerSummaryHealth.md) + - [de.gesellix.docker.remote.api.ContainerSummaryHostConfig](docs/ContainerSummaryHostConfig.md) + - [de.gesellix.docker.remote.api.ContainerSummaryNetworkSettings](docs/ContainerSummaryNetworkSettings.md) + - [de.gesellix.docker.remote.api.ContainerThrottlingData](docs/ContainerThrottlingData.md) + - [de.gesellix.docker.remote.api.ContainerTopResponse](docs/ContainerTopResponse.md) + - [de.gesellix.docker.remote.api.ContainerUpdateRequest](docs/ContainerUpdateRequest.md) + - [de.gesellix.docker.remote.api.ContainerUpdateResponse](docs/ContainerUpdateResponse.md) + - [de.gesellix.docker.remote.api.ContainerWaitExitError](docs/ContainerWaitExitError.md) + - [de.gesellix.docker.remote.api.ContainerWaitResponse](docs/ContainerWaitResponse.md) + - [de.gesellix.docker.remote.api.ContainerdInfo](docs/ContainerdInfo.md) + - [de.gesellix.docker.remote.api.ContainerdInfoNamespaces](docs/ContainerdInfoNamespaces.md) + - [de.gesellix.docker.remote.api.ContainersDiskUsage](docs/ContainersDiskUsage.md) + - [de.gesellix.docker.remote.api.CreateImageInfo](docs/CreateImageInfo.md) + - [de.gesellix.docker.remote.api.DeviceInfo](docs/DeviceInfo.md) + - [de.gesellix.docker.remote.api.DeviceMapping](docs/DeviceMapping.md) + - [de.gesellix.docker.remote.api.DeviceRequest](docs/DeviceRequest.md) + - [de.gesellix.docker.remote.api.DistributionInspect](docs/DistributionInspect.md) + - [de.gesellix.docker.remote.api.Driver](docs/Driver.md) + - [de.gesellix.docker.remote.api.DriverData](docs/DriverData.md) + - [de.gesellix.docker.remote.api.EndpointIPAMConfig](docs/EndpointIPAMConfig.md) + - [de.gesellix.docker.remote.api.EndpointPortConfig](docs/EndpointPortConfig.md) + - [de.gesellix.docker.remote.api.EndpointResource](docs/EndpointResource.md) + - [de.gesellix.docker.remote.api.EndpointSettings](docs/EndpointSettings.md) + - [de.gesellix.docker.remote.api.EndpointSpec](docs/EndpointSpec.md) + - [de.gesellix.docker.remote.api.EngineDescription](docs/EngineDescription.md) + - [de.gesellix.docker.remote.api.EngineDescriptionPluginsInner](docs/EngineDescriptionPluginsInner.md) + - [de.gesellix.docker.remote.api.ErrorDetail](docs/ErrorDetail.md) + - [de.gesellix.docker.remote.api.ErrorResponse](docs/ErrorResponse.md) + - [de.gesellix.docker.remote.api.EventActor](docs/EventActor.md) + - [de.gesellix.docker.remote.api.EventMessage](docs/EventMessage.md) + - [de.gesellix.docker.remote.api.ExecConfig](docs/ExecConfig.md) + - [de.gesellix.docker.remote.api.ExecInspectResponse](docs/ExecInspectResponse.md) + - [de.gesellix.docker.remote.api.ExecStartConfig](docs/ExecStartConfig.md) + - [de.gesellix.docker.remote.api.FilesystemChange](docs/FilesystemChange.md) + - [de.gesellix.docker.remote.api.FirewallInfo](docs/FirewallInfo.md) + - [de.gesellix.docker.remote.api.GenericResourcesInner](docs/GenericResourcesInner.md) + - [de.gesellix.docker.remote.api.GenericResourcesInnerDiscreteResourceSpec](docs/GenericResourcesInnerDiscreteResourceSpec.md) + - [de.gesellix.docker.remote.api.GenericResourcesInnerNamedResourceSpec](docs/GenericResourcesInnerNamedResourceSpec.md) + - [de.gesellix.docker.remote.api.Health](docs/Health.md) + - [de.gesellix.docker.remote.api.HealthConfig](docs/HealthConfig.md) + - [de.gesellix.docker.remote.api.HealthcheckResult](docs/HealthcheckResult.md) + - [de.gesellix.docker.remote.api.HistoryResponseItem](docs/HistoryResponseItem.md) + - [de.gesellix.docker.remote.api.HostConfig](docs/HostConfig.md) + - [de.gesellix.docker.remote.api.HostConfigAllOfLogConfig](docs/HostConfigAllOfLogConfig.md) + - [de.gesellix.docker.remote.api.IDResponse](docs/IDResponse.md) + - [de.gesellix.docker.remote.api.IPAM](docs/IPAM.md) + - [de.gesellix.docker.remote.api.IPAMConfig](docs/IPAMConfig.md) + - [de.gesellix.docker.remote.api.IPAMStatus](docs/IPAMStatus.md) + - [de.gesellix.docker.remote.api.ImageConfig](docs/ImageConfig.md) + - [de.gesellix.docker.remote.api.ImageDeleteResponseItem](docs/ImageDeleteResponseItem.md) + - [de.gesellix.docker.remote.api.ImageID](docs/ImageID.md) + - [de.gesellix.docker.remote.api.ImageInspect](docs/ImageInspect.md) + - [de.gesellix.docker.remote.api.ImageInspectMetadata](docs/ImageInspectMetadata.md) + - [de.gesellix.docker.remote.api.ImageInspectRootFS](docs/ImageInspectRootFS.md) + - [de.gesellix.docker.remote.api.ImageManifestSummary](docs/ImageManifestSummary.md) + - [de.gesellix.docker.remote.api.ImageManifestSummaryAttestationData](docs/ImageManifestSummaryAttestationData.md) + - [de.gesellix.docker.remote.api.ImageManifestSummaryImageData](docs/ImageManifestSummaryImageData.md) + - [de.gesellix.docker.remote.api.ImageManifestSummaryImageDataSize](docs/ImageManifestSummaryImageDataSize.md) + - [de.gesellix.docker.remote.api.ImageManifestSummarySize](docs/ImageManifestSummarySize.md) + - [de.gesellix.docker.remote.api.ImagePruneResponse](docs/ImagePruneResponse.md) + - [de.gesellix.docker.remote.api.ImageSearchResponseItem](docs/ImageSearchResponseItem.md) + - [de.gesellix.docker.remote.api.ImageSummary](docs/ImageSummary.md) + - [de.gesellix.docker.remote.api.ImagesDiskUsage](docs/ImagesDiskUsage.md) + - [de.gesellix.docker.remote.api.IndexInfo](docs/IndexInfo.md) + - [de.gesellix.docker.remote.api.JoinTokens](docs/JoinTokens.md) + - [de.gesellix.docker.remote.api.Limit](docs/Limit.md) + - [de.gesellix.docker.remote.api.LocalNodeState](docs/LocalNodeState.md) + - [de.gesellix.docker.remote.api.ManagerStatus](docs/ManagerStatus.md) + - [de.gesellix.docker.remote.api.Mount](docs/Mount.md) + - [de.gesellix.docker.remote.api.MountBindOptions](docs/MountBindOptions.md) + - [de.gesellix.docker.remote.api.MountImageOptions](docs/MountImageOptions.md) + - [de.gesellix.docker.remote.api.MountPoint](docs/MountPoint.md) + - [de.gesellix.docker.remote.api.MountTmpfsOptions](docs/MountTmpfsOptions.md) + - [de.gesellix.docker.remote.api.MountVolumeOptions](docs/MountVolumeOptions.md) + - [de.gesellix.docker.remote.api.MountVolumeOptionsDriverConfig](docs/MountVolumeOptionsDriverConfig.md) + - [de.gesellix.docker.remote.api.Network](docs/Network.md) + - [de.gesellix.docker.remote.api.NetworkAttachmentConfig](docs/NetworkAttachmentConfig.md) + - [de.gesellix.docker.remote.api.NetworkConnectRequest](docs/NetworkConnectRequest.md) + - [de.gesellix.docker.remote.api.NetworkCreateRequest](docs/NetworkCreateRequest.md) + - [de.gesellix.docker.remote.api.NetworkCreateResponse](docs/NetworkCreateResponse.md) + - [de.gesellix.docker.remote.api.NetworkDisconnectRequest](docs/NetworkDisconnectRequest.md) + - [de.gesellix.docker.remote.api.NetworkInspect](docs/NetworkInspect.md) + - [de.gesellix.docker.remote.api.NetworkPruneResponse](docs/NetworkPruneResponse.md) + - [de.gesellix.docker.remote.api.NetworkSettings](docs/NetworkSettings.md) + - [de.gesellix.docker.remote.api.NetworkStatus](docs/NetworkStatus.md) + - [de.gesellix.docker.remote.api.NetworkSummary](docs/NetworkSummary.md) + - [de.gesellix.docker.remote.api.NetworkTaskInfo](docs/NetworkTaskInfo.md) + - [de.gesellix.docker.remote.api.NetworkingConfig](docs/NetworkingConfig.md) + - [de.gesellix.docker.remote.api.Node](docs/Node.md) + - [de.gesellix.docker.remote.api.NodeDescription](docs/NodeDescription.md) + - [de.gesellix.docker.remote.api.NodeSpec](docs/NodeSpec.md) + - [de.gesellix.docker.remote.api.NodeState](docs/NodeState.md) + - [de.gesellix.docker.remote.api.NodeStatus](docs/NodeStatus.md) + - [de.gesellix.docker.remote.api.OCIDescriptor](docs/OCIDescriptor.md) + - [de.gesellix.docker.remote.api.OCIPlatform](docs/OCIPlatform.md) + - [de.gesellix.docker.remote.api.ObjectVersion](docs/ObjectVersion.md) + - [de.gesellix.docker.remote.api.PeerInfo](docs/PeerInfo.md) + - [de.gesellix.docker.remote.api.PeerNode](docs/PeerNode.md) + - [de.gesellix.docker.remote.api.Platform](docs/Platform.md) + - [de.gesellix.docker.remote.api.Plugin](docs/Plugin.md) + - [de.gesellix.docker.remote.api.PluginConfig](docs/PluginConfig.md) + - [de.gesellix.docker.remote.api.PluginConfigArgs](docs/PluginConfigArgs.md) + - [de.gesellix.docker.remote.api.PluginConfigInterface](docs/PluginConfigInterface.md) + - [de.gesellix.docker.remote.api.PluginConfigLinux](docs/PluginConfigLinux.md) + - [de.gesellix.docker.remote.api.PluginConfigNetwork](docs/PluginConfigNetwork.md) + - [de.gesellix.docker.remote.api.PluginConfigRootfs](docs/PluginConfigRootfs.md) + - [de.gesellix.docker.remote.api.PluginConfigUser](docs/PluginConfigUser.md) + - [de.gesellix.docker.remote.api.PluginDevice](docs/PluginDevice.md) + - [de.gesellix.docker.remote.api.PluginEnv](docs/PluginEnv.md) + - [de.gesellix.docker.remote.api.PluginMount](docs/PluginMount.md) + - [de.gesellix.docker.remote.api.PluginPrivilege](docs/PluginPrivilege.md) + - [de.gesellix.docker.remote.api.PluginSettings](docs/PluginSettings.md) + - [de.gesellix.docker.remote.api.PluginsInfo](docs/PluginsInfo.md) + - [de.gesellix.docker.remote.api.PortBinding](docs/PortBinding.md) + - [de.gesellix.docker.remote.api.PortStatus](docs/PortStatus.md) + - [de.gesellix.docker.remote.api.PortSummary](docs/PortSummary.md) + - [de.gesellix.docker.remote.api.ProcessConfig](docs/ProcessConfig.md) + - [de.gesellix.docker.remote.api.ProgressDetail](docs/ProgressDetail.md) + - [de.gesellix.docker.remote.api.PushImageInfo](docs/PushImageInfo.md) + - [de.gesellix.docker.remote.api.Reachability](docs/Reachability.md) + - [de.gesellix.docker.remote.api.RegistryServiceConfig](docs/RegistryServiceConfig.md) + - [de.gesellix.docker.remote.api.ResourceObject](docs/ResourceObject.md) + - [de.gesellix.docker.remote.api.Resources](docs/Resources.md) + - [de.gesellix.docker.remote.api.ResourcesBlkioWeightDeviceInner](docs/ResourcesBlkioWeightDeviceInner.md) + - [de.gesellix.docker.remote.api.ResourcesUlimitsInner](docs/ResourcesUlimitsInner.md) + - [de.gesellix.docker.remote.api.RestartPolicy](docs/RestartPolicy.md) + - [de.gesellix.docker.remote.api.RootFSStorage](docs/RootFSStorage.md) + - [de.gesellix.docker.remote.api.RootFSStorageSnapshot](docs/RootFSStorageSnapshot.md) + - [de.gesellix.docker.remote.api.Runtime](docs/Runtime.md) + - [de.gesellix.docker.remote.api.Secret](docs/Secret.md) + - [de.gesellix.docker.remote.api.SecretCreateRequest](docs/SecretCreateRequest.md) + - [de.gesellix.docker.remote.api.SecretSpec](docs/SecretSpec.md) + - [de.gesellix.docker.remote.api.Service](docs/Service.md) + - [de.gesellix.docker.remote.api.ServiceCreateRequest](docs/ServiceCreateRequest.md) + - [de.gesellix.docker.remote.api.ServiceCreateResponse](docs/ServiceCreateResponse.md) + - [de.gesellix.docker.remote.api.ServiceEndpoint](docs/ServiceEndpoint.md) + - [de.gesellix.docker.remote.api.ServiceEndpointVirtualIPsInner](docs/ServiceEndpointVirtualIPsInner.md) + - [de.gesellix.docker.remote.api.ServiceInfo](docs/ServiceInfo.md) + - [de.gesellix.docker.remote.api.ServiceJobStatus](docs/ServiceJobStatus.md) + - [de.gesellix.docker.remote.api.ServiceServiceStatus](docs/ServiceServiceStatus.md) + - [de.gesellix.docker.remote.api.ServiceSpec](docs/ServiceSpec.md) + - [de.gesellix.docker.remote.api.ServiceSpecMode](docs/ServiceSpecMode.md) + - [de.gesellix.docker.remote.api.ServiceSpecModeReplicated](docs/ServiceSpecModeReplicated.md) + - [de.gesellix.docker.remote.api.ServiceSpecModeReplicatedJob](docs/ServiceSpecModeReplicatedJob.md) + - [de.gesellix.docker.remote.api.ServiceSpecRollbackConfig](docs/ServiceSpecRollbackConfig.md) + - [de.gesellix.docker.remote.api.ServiceSpecUpdateConfig](docs/ServiceSpecUpdateConfig.md) + - [de.gesellix.docker.remote.api.ServiceUpdateRequest](docs/ServiceUpdateRequest.md) + - [de.gesellix.docker.remote.api.ServiceUpdateResponse](docs/ServiceUpdateResponse.md) + - [de.gesellix.docker.remote.api.ServiceUpdateStatus](docs/ServiceUpdateStatus.md) + - [de.gesellix.docker.remote.api.Storage](docs/Storage.md) + - [de.gesellix.docker.remote.api.SubnetStatus](docs/SubnetStatus.md) + - [de.gesellix.docker.remote.api.Swarm](docs/Swarm.md) + - [de.gesellix.docker.remote.api.SwarmInfo](docs/SwarmInfo.md) + - [de.gesellix.docker.remote.api.SwarmInitRequest](docs/SwarmInitRequest.md) + - [de.gesellix.docker.remote.api.SwarmJoinRequest](docs/SwarmJoinRequest.md) + - [de.gesellix.docker.remote.api.SwarmSpec](docs/SwarmSpec.md) + - [de.gesellix.docker.remote.api.SwarmSpecCAConfig](docs/SwarmSpecCAConfig.md) + - [de.gesellix.docker.remote.api.SwarmSpecCAConfigExternalCAsInner](docs/SwarmSpecCAConfigExternalCAsInner.md) + - [de.gesellix.docker.remote.api.SwarmSpecDispatcher](docs/SwarmSpecDispatcher.md) + - [de.gesellix.docker.remote.api.SwarmSpecEncryptionConfig](docs/SwarmSpecEncryptionConfig.md) + - [de.gesellix.docker.remote.api.SwarmSpecOrchestration](docs/SwarmSpecOrchestration.md) + - [de.gesellix.docker.remote.api.SwarmSpecRaft](docs/SwarmSpecRaft.md) + - [de.gesellix.docker.remote.api.SwarmSpecTaskDefaults](docs/SwarmSpecTaskDefaults.md) + - [de.gesellix.docker.remote.api.SwarmSpecTaskDefaultsLogDriver](docs/SwarmSpecTaskDefaultsLogDriver.md) + - [de.gesellix.docker.remote.api.SwarmUnlockRequest](docs/SwarmUnlockRequest.md) + - [de.gesellix.docker.remote.api.SystemDataUsageResponse](docs/SystemDataUsageResponse.md) + - [de.gesellix.docker.remote.api.SystemInfo](docs/SystemInfo.md) + - [de.gesellix.docker.remote.api.SystemInfoDefaultAddressPoolsInner](docs/SystemInfoDefaultAddressPoolsInner.md) + - [de.gesellix.docker.remote.api.SystemVersion](docs/SystemVersion.md) + - [de.gesellix.docker.remote.api.SystemVersionComponentsInner](docs/SystemVersionComponentsInner.md) + - [de.gesellix.docker.remote.api.SystemVersionPlatform](docs/SystemVersionPlatform.md) + - [de.gesellix.docker.remote.api.TLSInfo](docs/TLSInfo.md) + - [de.gesellix.docker.remote.api.Task](docs/Task.md) + - [de.gesellix.docker.remote.api.TaskSpec](docs/TaskSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpec](docs/TaskSpecContainerSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecConfigsInner](docs/TaskSpecContainerSpecConfigsInner.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecConfigsInnerFile](docs/TaskSpecContainerSpecConfigsInnerFile.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecDNSConfig](docs/TaskSpecContainerSpecDNSConfig.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivileges](docs/TaskSpecContainerSpecPrivileges.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesAppArmor](docs/TaskSpecContainerSpecPrivilegesAppArmor.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesCredentialSpec](docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesSELinuxContext](docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecPrivilegesSeccomp](docs/TaskSpecContainerSpecPrivilegesSeccomp.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecSecretsInner](docs/TaskSpecContainerSpecSecretsInner.md) + - [de.gesellix.docker.remote.api.TaskSpecContainerSpecSecretsInnerFile](docs/TaskSpecContainerSpecSecretsInnerFile.md) + - [de.gesellix.docker.remote.api.TaskSpecLogDriver](docs/TaskSpecLogDriver.md) + - [de.gesellix.docker.remote.api.TaskSpecNetworkAttachmentSpec](docs/TaskSpecNetworkAttachmentSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecPlacement](docs/TaskSpecPlacement.md) + - [de.gesellix.docker.remote.api.TaskSpecPlacementPreferencesInner](docs/TaskSpecPlacementPreferencesInner.md) + - [de.gesellix.docker.remote.api.TaskSpecPlacementPreferencesInnerSpread](docs/TaskSpecPlacementPreferencesInnerSpread.md) + - [de.gesellix.docker.remote.api.TaskSpecPluginSpec](docs/TaskSpecPluginSpec.md) + - [de.gesellix.docker.remote.api.TaskSpecResources](docs/TaskSpecResources.md) + - [de.gesellix.docker.remote.api.TaskSpecRestartPolicy](docs/TaskSpecRestartPolicy.md) + - [de.gesellix.docker.remote.api.TaskState](docs/TaskState.md) + - [de.gesellix.docker.remote.api.TaskStatus](docs/TaskStatus.md) + - [de.gesellix.docker.remote.api.ThrottleDevice](docs/ThrottleDevice.md) + - [de.gesellix.docker.remote.api.UnlockKeyResponse](docs/UnlockKeyResponse.md) + - [de.gesellix.docker.remote.api.Volume](docs/Volume.md) + - [de.gesellix.docker.remote.api.VolumeCreateRequest](docs/VolumeCreateRequest.md) + - [de.gesellix.docker.remote.api.VolumeListResponse](docs/VolumeListResponse.md) + - [de.gesellix.docker.remote.api.VolumePruneResponse](docs/VolumePruneResponse.md) + - [de.gesellix.docker.remote.api.VolumeUpdateRequest](docs/VolumeUpdateRequest.md) + - [de.gesellix.docker.remote.api.VolumeUsageData](docs/VolumeUsageData.md) + - [de.gesellix.docker.remote.api.VolumesDiskUsage](docs/VolumesDiskUsage.md) + + + +## Documentation for Authorization + +Endpoints do not require authorization. + diff --git a/api-model-v1-52/build.gradle.kts b/api-model-v1-52/build.gradle.kts new file mode 100644 index 00000000..42554050 --- /dev/null +++ b/api-model-v1-52/build.gradle.kts @@ -0,0 +1,233 @@ +import java.text.SimpleDateFormat +import java.util.* + +plugins { + id("java") + alias(libs.plugins.kotlinJvm) + id("com.google.devtools.ksp") + id("maven-publish") + id("signing") + id("com.github.ben-manes.versions") + id("org.sonatype.gradle.plugins.scan") + id("io.freefair.maven-central.validate-poms") + id("org.openapi.generator") + id("org.jlleitschuh.gradle.ktlint") +} + +val remoteApiVersion = "1.52" + +logger.lifecycle("checking base: ${file(layout.buildDirectory.dir("generated")).path}") +configure { + filter { +// see https://github.com/JLLeitschuh/ktlint-gradle/issues/579 + exclude("**/generated/**") + exclude { + it.file.path.startsWith(file(layout.buildDirectory.dir("generated")).path) + } + exclude("**/build.gradle.kts") + exclude { + it.file.path.endsWith("build.gradle.kts") + } + } +} + +openApiGenerate { + inputSpec.set(file("./docker-engine-api-v$remoteApiVersion.yaml").absolutePath) + configFile.set(file("./openapi-generator-config.yaml").absolutePath) + outputDir.set(file(".").absolutePath) +} +val openApiGenerateCleanupBuildScript by tasks.register("openApiGenerateCleanupBuildScript") { + group = "openapi tools" + mustRunAfter(tasks.openApiGenerate) + doLast { + listOf( + "build.gradle", + "gradlew", + "gradlew.bat", + "settings.gradle" + ).onEach { + file(it).delete() + } + listOf( + "gradle" + ).onEach { + file(it).deleteRecursively() + } + } +} +val openApiGenerateCleanupGeneratedCode by tasks.register("openApiGenerateCleanupGeneratedCode") { + group = "openapi tools" + mustRunAfter(tasks.openApiGenerate) + doLast { + listOf( + "src/main/kotlin/de/gesellix/docker/remote/api/infrastructure", + "src/main/kotlin/de/gesellix/docker/remote/client", + "src/test/kotlin/de/gesellix/docker/remote/api/infrastructure", + "src/test/kotlin/de/gesellix/docker/remote/api", + "src/test/kotlin/de/gesellix/docker/remote/client", + ).onEach { + file(it).deleteRecursively() + } + } +} + +tasks.runKtlintFormatOverKotlinScripts.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +tasks.ktlintKotlinScriptFormat.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +tasks.ktlintMainSourceSetFormat.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +tasks.loadKtlintReporters.get().mustRunAfter(tasks.openApiGenerate, openApiGenerateCleanupBuildScript, openApiGenerateCleanupGeneratedCode) +// tasks.ktlintFormat.get().dependsOn( +// tasks.openApiGenerate, +// openApiGenerateCleanupBuildScript, +// openApiGenerateCleanupGeneratedCode, +// tasks.named("ktlintGeneratedByKspKotlinSourceSetFormat") +// ) +val updateApiModelSources by tasks.register("updateApiModelSources") { + group = "openapi tools" + dependsOn( + tasks.openApiGenerate, + openApiGenerateCleanupBuildScript +// openApiGenerateCleanupGeneratedCode + ) + +// TODO try to re-enable this one, +// so that a single task can perform everything all at once. +// finalizedBy(tasks.ktlintFormat) +} + +// TODO find a better solution. +// This is a deprecated workaround, +// because the 'kspKotlin' task isn't present at +// evaluation time. +afterEvaluate { + tasks.findByName("kspKotlin")?.mustRunAfter(tasks.openApiGenerate) +} + +repositories { + mavenCentral() +} + +dependencies { + constraints { + listOf(libs.bundles.okio).forEach { + implementation(it) { + version { + strictly(libs.versions.okioVersionrange.get()) + prefer(libs.versions.okio.get()) + } + } + } + } + implementation(libs.kotlinJdk8) + + implementation(libs.moshi) + ksp("com.squareup.moshi:moshi-kotlin-codegen:${libs.versions.moshi.get()}") + compileOnly(libs.okhttp) + + testImplementation("org.junit.jupiter:junit-jupiter-api:5.13.4") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.13.4") + testRuntimeOnly("cglib:cglib-nodep:3.3.0") + testImplementation("org.junit.platform:junit-platform-launcher:1.13.4") + testImplementation("org.junit.platform:junit-platform-commons:1.13.4") +// testImplementation("io.kotlintest:kotlintest-runner-junit5:3.4.2") +} + +java { + toolchain { + // The org.openapi.generator requires JDK 11 to generate the sources. + // Generated code still works with Java 8. + // See below where we use Java 8 to perform checks + // See https://github.com/OpenAPITools/openapi-generator/pull/15553 for details. + languageVersion.set(JavaLanguageVersion.of(11)) + } +} + +tasks { + withType { + options.encoding = "UTF-8" + } + withType { + useJUnitPlatform() + + java { + toolchain { + // See above: the org.openapi.generator requires JDK 11 to generate the sources. + // We're trying to ensure that the generated code still works with Java 8. + languageVersion.set(JavaLanguageVersion.of(8)) + } + } + } +} + +val javadocJar by tasks.registering(Jar::class) { + dependsOn("classes") + archiveClassifier.set("javadoc") + from(tasks.javadoc) +} + +val sourcesJar by tasks.registering(Jar::class) { + dependsOn("classes") + archiveClassifier.set("sources") + from(sourceSets.main.get().allSource) +} + +artifacts { + add("archives", sourcesJar.get()) + add("archives", javadocJar.get()) +} + +fun findProperty(s: String) = project.findProperty(s) as String? + +val isSnapshot = project.version == "unspecified" +val artifactVersion = if (!isSnapshot) project.version as String else SimpleDateFormat("yyyy-MM-dd\'T\'HH-mm-ss").format(Date())!! +val publicationName = "dockerRemoteApiModel" +publishing { + repositories { + maven { + name = "GitHubPackages" + url = uri("https://maven.pkg.github.com/${property("github.package-registry.owner")}/${property("github.package-registry.repository")}") + credentials { + username = System.getenv("GITHUB_ACTOR") ?: findProperty("github.package-registry.username") + password = System.getenv("GITHUB_TOKEN") ?: findProperty("github.package-registry.password") + } + } + } + publications { + register(publicationName, MavenPublication::class) { + pom { + name.set("docker-remote-api-model") + description.set("API model for the Docker remote api v$remoteApiVersion") + url.set("https://github.com/docker-client/docker-remote-api") + licenses { + license { + name.set("MIT") + url.set("https://opensource.org/licenses/MIT") + } + } + developers { + developer { + id.set("gesellix") + name.set("Tobias Gesellchen") + email.set("tobias@gesellix.de") + } + } + scm { + connection.set("scm:git:github.com/docker-client/docker-remote-api.git") + developerConnection.set("scm:git:ssh://github.com/docker-client/docker-remote-api.git") + url.set("https://github.com/docker-client/docker-remote-api") + } + } + artifactId = "docker-remote-api-model-${remoteApiVersion.replace(Regex("\\."), "-")}" + version = artifactVersion + from(components["java"]) + artifact(sourcesJar.get()) + artifact(javadocJar.get()) + } + } +} + +signing { + val signingKey: String? by project + val signingPassword: String? by project + useInMemoryPgpKeys(signingKey, signingPassword) + sign(publishing.publications[publicationName]) +} diff --git a/api-model-v1-52/docker-engine-api-v1.52.yaml b/api-model-v1-52/docker-engine-api-v1.52.yaml new file mode 100644 index 00000000..4006fecc --- /dev/null +++ b/api-model-v1-52/docker-engine-api-v1.52.yaml @@ -0,0 +1,13565 @@ +# A Swagger 2.0 (a.k.a. OpenAPI) definition of the Engine API. +# +# This is used for generating API documentation and the types used by the +# client/server. See api/README.md for more information. +# +# Some style notes: +# - This file is used by ReDoc, which allows GitHub Flavored Markdown in +# descriptions. +# - There is no maximum line length, for ease of editing and pretty diffs. +# - operationIds are in the format "NounVerb", with a singular noun. + +swagger: "2.0" +schemes: + - "http" + - "https" +produces: + - "application/json" + - "text/plain" +consumes: + - "application/json" + - "text/plain" +basePath: "/v1.52" +info: + title: "Docker Engine API" + version: "1.52" + x-logo: + url: "https://docs.docker.com/assets/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 + 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.50) is used. + For example, calling `/info` is the same as calling `/v1.52/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 the 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", + "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 tags on paths define the menu sections in the ReDoc documentation, so +# the usage of tags must make sense for that: +# - They should be singular, not plural. +# - There should not be too many tags, or the menu becomes unwieldy. For +# example, it is preferable to add a path to the "System" tag instead of +# creating a tag with a single path in it. +# - The order of tags in this list defines the order in the menu. +tags: + # Primary objects + - name: "Container" + x-displayName: "Containers" + description: | + Create and manage containers. + - name: "Image" + x-displayName: "Images" + - name: "Network" + x-displayName: "Networks" + description: | + Networks are user-defined networks that containers can be attached to. + See the [networking documentation](https://docs.docker.com/network/) + for more information. + - name: "Volume" + x-displayName: "Volumes" + description: | + Create and manage persistent storage that can be attached to containers. + - name: "Exec" + x-displayName: "Exec" + description: | + Run new commands inside running containers. Refer to the + [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, + then start it. These two API endpoints are wrapped up in a single command-line + command, `docker exec`. + + # Swarm things + - name: "Swarm" + x-displayName: "Swarm" + description: | + Engines can be clustered together in a swarm. Refer to the + [swarm mode documentation](https://docs.docker.com/engine/swarm/) + for more information. + - name: "Node" + x-displayName: "Nodes" + description: | + Nodes are instances of the Engine participating in a swarm. Swarm mode + must be enabled for these endpoints to work. + - name: "Service" + x-displayName: "Services" + description: | + Services are the definitions of tasks to run on a swarm. Swarm mode must + be enabled for these endpoints to work. + - name: "Task" + x-displayName: "Tasks" + description: | + A task is a container running on a swarm. It is the atomic scheduling unit + of swarm. Swarm mode must be enabled for these endpoints to work. + - name: "Secret" + x-displayName: "Secrets" + description: | + Secrets are sensitive data that can be used by services. Swarm mode must + be enabled for these endpoints to work. + - name: "Config" + x-displayName: "Configs" + description: | + Configs are application configurations that can be used by services. Swarm + mode must be enabled for these endpoints to work. + # System things + - name: "Plugin" + x-displayName: "Plugins" + - name: "System" + x-displayName: "System" + +definitions: + PortSummary: + type: "object" + description: | + Describes a port-mapping between the container and the host. + required: [PrivatePort, Type] + properties: + IP: + type: "string" + format: "ip-address" + description: "Host IP address that the container's port is mapped to" + x-go-type: + type: Addr + import: + package: net/netip + PrivatePort: + type: "integer" + format: "uint16" + x-nullable: false + description: "Port on the container" + PublicPort: + type: "integer" + format: "uint16" + description: "Port exposed on the host" + Type: + type: "string" + x-nullable: false + enum: ["tcp", "udp", "sctp"] + example: + PrivatePort: 8080 + PublicPort: 80 + Type: "tcp" + + MountPoint: + type: "object" + description: | + MountPoint represents a mount point configuration inside the container. + This is used for reporting the mountpoints in use by a container. + properties: + Type: + description: | + The mount type: + + - `bind` a mount of a file or directory from the host into the container. + - `volume` a docker volume with the given `Name`. + - `image` a docker image + - `tmpfs` a `tmpfs`. + - `npipe` a named pipe from the host into the container. + - `cluster` a Swarm cluster volume + type: "string" + enum: + - "bind" + - "volume" + - "image" + - "tmpfs" + - "npipe" + - "cluster" + example: "volume" + Name: + description: | + Name is the name reference to the underlying data defined by `Source` + e.g., the volume name. + type: "string" + example: "myvolume" + Source: + description: | + Source location of the mount. + + For volumes, this contains the storage location of the volume (within + `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains + the source (host) part of the bind-mount. For `tmpfs` mount points, this + field is empty. + type: "string" + example: "/var/lib/docker/volumes/myvolume/_data" + Destination: + description: | + Destination is the path relative to the container root (`/`) where + the `Source` is mounted inside the container. + type: "string" + example: "/usr/share/nginx/html/" + Driver: + description: | + Driver is the volume driver used to create the volume (if it is a volume). + type: "string" + example: "local" + Mode: + description: | + Mode is a comma separated list of options supplied by the user when + creating the bind/volume mount. + + The default is platform-specific (`"z"` on Linux, empty on Windows). + type: "string" + example: "z" + RW: + description: | + Whether the mount is mounted writable (read-write). + type: "boolean" + example: true + Propagation: + description: | + Propagation describes how mounts are propagated from the host into the + mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) + for details. This field is not used on Windows. + type: "string" + example: "" + + DeviceMapping: + type: "object" + description: "A device mapping between the host and container" + properties: + PathOnHost: + type: "string" + PathInContainer: + type: "string" + CgroupPermissions: + type: "string" + example: + PathOnHost: "/dev/deviceName" + PathInContainer: "/dev/deviceName" + CgroupPermissions: "mrw" + + DeviceRequest: + type: "object" + description: "A request for devices to be sent to device drivers" + properties: + Driver: + description: | + The name of the device driver to use for this request. + + Note that if this is specified the capabilities are ignored when + selecting a device driver. + type: "string" + example: "nvidia" + Count: + type: "integer" + example: -1 + DeviceIDs: + type: "array" + items: + type: "string" + example: + - "0" + - "1" + - "GPU-fef8089b-4820-abfc-e83e-94318197576e" + Capabilities: + description: | + A list of capabilities; an OR list of AND lists of capabilities. + + Note that if a driver is specified the capabilities have no effect on + selecting a driver as the driver name is used directly. + + Note that if no driver is specified the capabilities are used to + select a driver with the required capabilities. + type: "array" + items: + type: "array" + items: + type: "string" + example: + # gpu AND nvidia AND compute + - ["gpu", "nvidia", "compute"] + Options: + description: | + Driver-specific options, specified as a key/value pairs. These options + are passed directly to the driver. + type: "object" + additionalProperties: + type: "string" + + ThrottleDevice: + type: "object" + properties: + Path: + description: "Device path" + type: "string" + Rate: + description: "Rate" + type: "integer" + format: "int64" + minimum: 0 + + Mount: + type: "object" + properties: + Target: + description: "Container path." + type: "string" + Source: + description: "Mount source (e.g. a volume name, a host path)." + type: "string" + Type: + description: | + The mount type. Available types: + + - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. + - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. + - `image` Mounts an image. + - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. + - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. + - `cluster` a Swarm cluster volume + type: "string" + enum: + - "bind" + - "volume" + - "image" + - "tmpfs" + - "npipe" + - "cluster" + ReadOnly: + description: "Whether the mount should be read-only." + type: "boolean" + Consistency: + description: "The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`." + type: "string" + BindOptions: + description: "Optional configuration for the `bind` type." + type: "object" + properties: + Propagation: + description: "A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`." + type: "string" + enum: + - "private" + - "rprivate" + - "shared" + - "rshared" + - "slave" + - "rslave" + NonRecursive: + description: "Disable recursive bind mount." + type: "boolean" + default: false + CreateMountpoint: + description: "Create mount point on host if missing" + type: "boolean" + default: false + ReadOnlyNonRecursive: + description: | + Make the mount non-recursively read-only, but still leave the mount recursive + (unless NonRecursive is set to `true` in conjunction). + + Added in v1.44, before that version all read-only mounts were + non-recursive by default. To match the previous behaviour this + will default to `true` for clients on versions prior to v1.44. + type: "boolean" + default: false + ReadOnlyForceRecursive: + description: "Raise an error if the mount cannot be made recursively read-only." + type: "boolean" + default: false + VolumeOptions: + description: "Optional configuration for the `volume` type." + type: "object" + properties: + NoCopy: + description: "Populate volume with data from the target." + type: "boolean" + default: false + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + DriverConfig: + description: "Map of driver specific options" + type: "object" + properties: + Name: + description: "Name of the driver to use to create the volume." + type: "string" + Options: + description: "key/value map of driver specific options." + type: "object" + additionalProperties: + type: "string" + Subpath: + description: "Source path inside the volume. Must be relative without any back traversals." + type: "string" + example: "dir-inside-volume/subdirectory" + ImageOptions: + description: "Optional configuration for the `image` type." + type: "object" + properties: + Subpath: + description: "Source path inside the image. Must be relative without any back traversals." + type: "string" + example: "dir-inside-image/subdirectory" + TmpfsOptions: + description: "Optional configuration for the `tmpfs` type." + type: "object" + properties: + SizeBytes: + description: "The size for the tmpfs mount in bytes." + type: "integer" + format: "int64" + Mode: + description: "The permission mode for the tmpfs mount in an integer." + type: "integer" + Options: + description: | + The options to be passed to the tmpfs mount. An array of arrays. + Flag options should be provided as 1-length arrays. Other types + should be provided as as 2-length arrays, where the first item is + the key and the second the value. + type: "array" + items: + type: "array" + minItems: 1 + maxItems: 2 + items: + type: "string" + example: + [["noexec"]] + + RestartPolicy: + description: | + 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. + type: "object" + properties: + Name: + 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" + MaximumRetryCount: + type: "integer" + description: | + If `on-failure` is used, the number of times to retry before giving up. + + Resources: + description: "A container's resources (cgroups config, ulimits, etc)" + type: "object" + properties: + # Applicable to all platforms + CpuShares: + description: | + An integer value representing this container's relative CPU weight + versus other containers. + type: "integer" + Memory: + description: "Memory limit in bytes." + type: "integer" + format: "int64" + default: 0 + # Applicable to UNIX platforms + CgroupParent: + description: | + Path to `cgroups` under which the container's `cgroup` is created. If + the path is not absolute, the path is considered to be relative to the + `cgroups` path of the init process. Cgroups are created if they do not + already exist. + type: "string" + BlkioWeight: + description: "Block IO weight (relative weight)." + type: "integer" + minimum: 0 + maximum: 1000 + BlkioWeightDevice: + description: | + Block IO weight (relative device weight) in the form: + + ``` + [{"Path": "device_path", "Weight": weight}] + ``` + type: "array" + items: + type: "object" + properties: + Path: + type: "string" + Weight: + type: "integer" + minimum: 0 + BlkioDeviceReadBps: + description: | + Limit read rate (bytes per second) from a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + BlkioDeviceWriteBps: + description: | + Limit write rate (bytes per second) to a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + BlkioDeviceReadIOps: + description: | + Limit read rate (IO per second) from a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + BlkioDeviceWriteIOps: + description: | + Limit write rate (IO per second) to a device, in the form: + + ``` + [{"Path": "device_path", "Rate": rate}] + ``` + type: "array" + items: + $ref: "#/definitions/ThrottleDevice" + CpuPeriod: + description: "The length of a CPU period in microseconds." + type: "integer" + format: "int64" + CpuQuota: + description: | + Microseconds of CPU time that the container can get in a CPU period. + type: "integer" + format: "int64" + CpuRealtimePeriod: + description: | + The length of a CPU real-time period in microseconds. Set to 0 to + allocate no time allocated to real-time tasks. + type: "integer" + format: "int64" + CpuRealtimeRuntime: + description: | + The length of a CPU real-time runtime in microseconds. Set to 0 to + allocate no time allocated to real-time tasks. + type: "integer" + format: "int64" + CpusetCpus: + description: | + CPUs in which to allow execution (e.g., `0-3`, `0,1`). + type: "string" + example: "0-3" + CpusetMems: + description: | + Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only + effective on NUMA systems. + type: "string" + Devices: + description: "A list of devices to add to the container." + type: "array" + items: + $ref: "#/definitions/DeviceMapping" + DeviceCgroupRules: + description: "a list of cgroup rules to apply to the container" + type: "array" + items: + type: "string" + example: "c 13:* rwm" + DeviceRequests: + description: | + A list of requests for devices to be sent to device drivers. + type: "array" + items: + $ref: "#/definitions/DeviceRequest" + MemoryReservation: + description: "Memory soft limit in bytes." + type: "integer" + format: "int64" + MemorySwap: + description: | + Total memory limit (memory + swap). Set as `-1` to enable unlimited + swap. + type: "integer" + format: "int64" + MemorySwappiness: + description: | + Tune a container's memory swappiness behavior. Accepts an integer + between 0 and 100. + type: "integer" + format: "int64" + minimum: 0 + maximum: 100 + NanoCpus: + description: "CPU quota in units of 10-9 CPUs." + type: "integer" + format: "int64" + OomKillDisable: + description: "Disable OOM Killer for the container." + type: "boolean" + Init: + description: | + Run an init inside the container that forwards signals and reaps + processes. This field is omitted if empty, and the default (as + configured on the daemon) is used. + type: "boolean" + x-nullable: true + PidsLimit: + description: | + Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` + to not change. + type: "integer" + format: "int64" + x-nullable: true + Ulimits: + description: | + A list of resource limits to set in the container. For example: + + ``` + {"Name": "nofile", "Soft": 1024, "Hard": 2048} + ``` + type: "array" + items: + type: "object" + properties: + Name: + description: "Name of ulimit" + type: "string" + Soft: + description: "Soft limit" + type: "integer" + Hard: + description: "Hard limit" + type: "integer" + # Applicable to Windows + CpuCount: + description: | + The number of usable CPUs (Windows only). + + On Windows Server containers, the processor resource controls are + mutually exclusive. The order of precedence is `CPUCount` first, then + `CPUShares`, and `CPUPercent` last. + type: "integer" + format: "int64" + CpuPercent: + description: | + The usable percentage of the available CPUs (Windows only). + + On Windows Server containers, the processor resource controls are + mutually exclusive. The order of precedence is `CPUCount` first, then + `CPUShares`, and `CPUPercent` last. + type: "integer" + format: "int64" + IOMaximumIOps: + description: "Maximum IOps for the container system drive (Windows only)" + type: "integer" + format: "int64" + IOMaximumBandwidth: + description: | + Maximum IO in bytes per second for the container system drive + (Windows only). + type: "integer" + format: "int64" + + Limit: + description: | + An object describing a limit on resources which can be requested by a task. + type: "object" + properties: + NanoCPUs: + type: "integer" + format: "int64" + example: 4000000000 + MemoryBytes: + type: "integer" + format: "int64" + example: 8272408576 + Pids: + description: | + Limits the maximum number of PIDs in the container. Set `0` for unlimited. + type: "integer" + format: "int64" + default: 0 + example: 100 + + ResourceObject: + description: | + An object describing the resources which can be advertised by a node and + requested by a task. + type: "object" + properties: + NanoCPUs: + type: "integer" + format: "int64" + example: 4000000000 + MemoryBytes: + type: "integer" + format: "int64" + example: 8272408576 + GenericResources: + $ref: "#/definitions/GenericResources" + + GenericResources: + description: | + User-defined resources can be either Integer resources (e.g, `SSD=3`) or + String resources (e.g, `GPU=UUID1`). + type: "array" + items: + type: "object" + properties: + NamedResourceSpec: + type: "object" + properties: + Kind: + type: "string" + Value: + type: "string" + DiscreteResourceSpec: + type: "object" + properties: + Kind: + type: "string" + Value: + type: "integer" + format: "int64" + example: + - DiscreteResourceSpec: + Kind: "SSD" + Value: 3 + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID1" + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID2" + + HealthConfig: + description: "A test to perform to check that the container is healthy." + type: "object" + properties: + Test: + description: | + The test to perform. Possible values are: + + - `[]` inherit healthcheck from image or parent image + - `["NONE"]` disable healthcheck + - `["CMD", args...]` exec arguments directly + - `["CMD-SHELL", command]` run command with system's default shell + type: "array" + items: + type: "string" + Interval: + description: | + The time to wait between checks in nanoseconds. It should be 0 or at + least 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + Timeout: + description: | + The time to wait before considering the check to have hung. It should + be 0 or at least 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + Retries: + description: | + The number of consecutive failures needed to consider a container as + unhealthy. 0 means inherit. + type: "integer" + StartPeriod: + description: | + Start period for the container to initialize before starting + health-retries countdown in nanoseconds. It should be 0 or at least + 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + StartInterval: + description: | + The time to wait between checks in nanoseconds during the start period. + It should be 0 or at least 1000000 (1 ms). 0 means inherit. + type: "integer" + format: "int64" + + Health: + description: | + Health stores information about the container's healthcheck results. + type: "object" +# x-nullable: true + properties: + Status: + description: | + Status is one of `none`, `starting`, `healthy` or `unhealthy` + + - "none" Indicates there is no healthcheck + - "starting" Starting indicates that the container is not yet ready + - "healthy" Healthy indicates that the container is running correctly + - "unhealthy" Unhealthy indicates that the container has a problem + type: "string" + enum: + - "none" + - "starting" + - "healthy" + - "unhealthy" + example: "healthy" + FailingStreak: + description: "FailingStreak is the number of consecutive failures" + type: "integer" + example: 0 + Log: + type: "array" + description: | + Log contains the last few results (oldest first) + items: + x-nullable: true + $ref: "#/definitions/HealthcheckResult" + + HealthcheckResult: + description: | + HealthcheckResult stores information about a single run of a healthcheck probe + type: "object" +# x-nullable: true + properties: + Start: + description: | + Date and time at which this check started in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "date-time" + example: "2020-01-04T10:44:24.496525531Z" + End: + description: | + Date and time at which this check ended in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2020-01-04T10:45:21.364524523Z" + ExitCode: + description: | + ExitCode meanings: + + - `0` healthy + - `1` unhealthy + - `2` reserved (considered unhealthy) + - other values: error running probe + type: "integer" + example: 0 + Output: + description: "Output from last check" + type: "string" + + HostConfig: + description: "Container configuration that depends on the host we are running on" + allOf: + - $ref: "#/definitions/Resources" + - type: "object" + properties: + # Applicable to all platforms + Binds: + type: "array" + description: | + A list of volume bindings for this container. Each volume binding + is a string in one of these forms: + + - `host-src:container-dest[:options]` to bind-mount a host path + into the container. Both `host-src`, and `container-dest` must + be an _absolute_ path. + - `volume-name:container-dest[:options]` to bind-mount a volume + managed by a volume driver into the container. `container-dest` + must be an _absolute_ path. + + `options` is an optional, comma-delimited list of: + + - `nocopy` disables automatic copying of data from the container + path to the volume. The `nocopy` flag only applies to named volumes. + - `[ro|rw]` mounts a volume read-only or read-write, respectively. + If omitted or set to `rw`, volumes are mounted read-write. + - `[z|Z]` applies SELinux labels to allow or deny multiple containers + to read and write to the same volume. + - `z`: a _shared_ content label is applied to the content. This + label indicates that multiple containers can share the volume + content, for both reading and writing. + - `Z`: a _private unshared_ label is applied to the content. + This label indicates that only the current container can use + a private volume. Labeling systems such as SELinux require + proper labels to be placed on volume content that is mounted + into a container. Without a label, the security system can + prevent a container's processes from using the content. By + default, the labels set by the host operating system are not + modified. + - `[[r]shared|[r]slave|[r]private]` specifies mount + [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). + This only applies to bind-mounted volumes, not internal volumes + or named volumes. Mount propagation requires the source mount + point (the location where the source directory is mounted in the + host operating system) to have the correct propagation properties. + For shared volumes, the source mount point must be set to `shared`. + For slave volumes, the mount must be set to either `shared` or + `slave`. + items: + type: "string" + ContainerIDFile: + type: "string" + description: "Path to a file where the container ID is written" + example: "" + LogConfig: + type: "object" + description: "The logging configuration for this container" + properties: + Type: + description: |- + Name of the logging driver used for the container or "none" + if logging is disabled. + type: "string" + enum: + - "local" + - "json-file" + - "syslog" + - "journald" + - "gelf" + - "fluentd" + - "awslogs" + - "splunk" + - "etwlogs" + - "none" + Config: + description: |- + Driver-specific configuration options for the logging driver. + type: "object" + additionalProperties: + type: "string" + example: + "max-file": "5" + "max-size": "10m" + NetworkMode: + type: "string" + description: | + Network mode to use for this container. Supported standard values + are: `bridge`, `host`, `none`, and `container:`. Any + other value is taken as a custom network's name to which this + container should connect to. + PortBindings: + $ref: "#/definitions/PortMap" + RestartPolicy: + $ref: "#/definitions/RestartPolicy" + AutoRemove: + type: "boolean" + description: | + Automatically remove the container when the container's process + exits. This has no effect if `RestartPolicy` is set. + VolumeDriver: + type: "string" + description: "Driver that this container uses to mount volumes." + VolumesFrom: + type: "array" + description: | + A list of volumes to inherit from another container, specified in + the form `[:]`. + items: + type: "string" + Mounts: + description: | + Specification for mounts to be added to the container. + type: "array" + items: + $ref: "#/definitions/Mount" + ConsoleSize: + type: "array" + description: | + Initial console size, as an `[height, width]` array. + x-nullable: true + minItems: 2 + maxItems: 2 + items: + type: "integer" + minimum: 0 + example: [80, 64] + Annotations: + type: "object" + description: | + Arbitrary non-identifying metadata attached to container and + provided to the runtime when the container is started. + additionalProperties: + type: "string" + + # Applicable to UNIX platforms + CapAdd: + type: "array" + description: | + A list of kernel capabilities to add to the container. Conflicts + with option 'Capabilities'. + items: + type: "string" + CapDrop: + type: "array" + description: | + A list of kernel capabilities to drop from the container. Conflicts + with option 'Capabilities'. + items: + type: "string" + CgroupnsMode: + type: "string" + enum: + - "private" + - "host" + description: | + cgroup namespace mode for the container. Possible values are: + + - `"private"`: the container runs in its own private cgroup namespace + - `"host"`: use the host system's cgroup namespace + + If not specified, the daemon default is used, which can either be `"private"` + or `"host"`, depending on daemon version, kernel support and configuration. + Dns: + type: "array" + description: "A list of DNS servers for the container to use." + items: + type: "string" + format: "ip-address" + x-go-type: + type: Addr + import: + package: net/netip + DnsOptions: + type: "array" + description: "A list of DNS options." + items: + type: "string" + DnsSearch: + type: "array" + description: "A list of DNS search domains." + items: + type: "string" + ExtraHosts: + type: "array" + description: | + A list of hostnames/IP mappings to add to the container's `/etc/hosts` + file. Specified in the form `["hostname:IP"]`. + items: + type: "string" + GroupAdd: + type: "array" + description: | + A list of additional groups that the container process will run as. + items: + type: "string" + IpcMode: + type: "string" + description: | + IPC sharing mode for the container. Possible values are: + + - `"none"`: own private IPC namespace, with /dev/shm not mounted + - `"private"`: own private IPC namespace + - `"shareable"`: own private IPC namespace, with a possibility to share it with other containers + - `"container:"`: join another (shareable) container's IPC namespace + - `"host"`: use the host system's IPC namespace + + If not specified, daemon default is used, which can either be `"private"` + or `"shareable"`, depending on daemon version and configuration. + Cgroup: + type: "string" + description: "Cgroup to use for the container." + Links: + type: "array" + description: | + A list of links for the container in the form `container_name:alias`. + items: + type: "string" + OomScoreAdj: + type: "integer" + description: | + An integer value containing the score given to the container in + order to tune OOM killer preferences. + example: 500 + PidMode: + type: "string" + description: | + Set the PID (Process) Namespace mode for the container. It can be + either: + + - `"container:"`: joins another container's PID namespace + - `"host"`: use the host's PID namespace inside the container + Privileged: + type: "boolean" + description: |- + Gives the container full access to the host. + PublishAllPorts: + type: "boolean" + description: | + Allocates an ephemeral host port for all of a container's + exposed ports. + + Ports are de-allocated when the container stops and allocated when + the container starts. The allocated port might be changed when + restarting the container. + + The port is selected from the ephemeral port range that depends on + the kernel. For example, on Linux the range is defined by + `/proc/sys/net/ipv4/ip_local_port_range`. + ReadonlyRootfs: + type: "boolean" + description: "Mount the container's root filesystem as read only." + SecurityOpt: + type: "array" + description: | + A list of string values to customize labels for MLS systems, such + as SELinux. + items: + type: "string" + StorageOpt: + type: "object" + description: | + Storage driver options for this container, in the form `{"size": "120G"}`. + additionalProperties: + type: "string" + Tmpfs: + type: "object" + description: | + A map of container directories which should be replaced by tmpfs + mounts, and their corresponding mount options. For example: + + ``` + { "/run": "rw,noexec,nosuid,size=65536k" } + ``` + additionalProperties: + type: "string" + UTSMode: + type: "string" + description: "UTS namespace to use for the container." + UsernsMode: + type: "string" + description: | + Sets the usernamespace mode for the container when usernamespace + remapping option is enabled. + ShmSize: + type: "integer" + format: "int64" + description: | + Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. + minimum: 0 + Sysctls: + type: "object" + x-nullable: true + description: |- + A list of kernel parameters (sysctls) to set in the container. + + This field is omitted if not set. + additionalProperties: + type: "string" + example: + "net.ipv4.ip_forward": "1" + Runtime: + type: "string" + x-nullable: true + description: |- + Runtime to use with this container. + # Applicable to Windows + Isolation: + type: "string" + description: | + Isolation technology of the container. (Windows only) + enum: + - "default" + - "process" + - "hyperv" + - "" + MaskedPaths: + type: "array" + description: | + The list of paths to be masked inside the container (this overrides + the default set of paths). + items: + type: "string" + example: + - "/proc/asound" + - "/proc/acpi" + - "/proc/kcore" + - "/proc/keys" + - "/proc/latency_stats" + - "/proc/timer_list" + - "/proc/timer_stats" + - "/proc/sched_debug" + - "/proc/scsi" + - "/sys/firmware" + - "/sys/devices/virtual/powercap" + ReadonlyPaths: + type: "array" + description: | + The list of paths to be set as read-only inside the container + (this overrides the default set of paths). + items: + type: "string" + example: + - "/proc/bus" + - "/proc/fs" + - "/proc/irq" + - "/proc/sys" + - "/proc/sysrq-trigger" + + ContainerConfig: + description: | + Configuration for a container that is portable between hosts. + type: "object" + properties: + Hostname: + description: | + The hostname to use for the container, as a valid RFC 1123 hostname. + type: "string" + example: "439f4e91bd1d" + Domainname: + description: | + The domain name to use for the container. + type: "string" + User: + description: |- + Commands run as this user inside the container. If omitted, commands + run as the user specified in the image the container was started from. + + Can be either user-name or UID, and optional group-name or GID, + separated by a colon (`[<:group-name|GID>]`). + type: "string" + example: "123:456" + AttachStdin: + description: "Whether to attach to `stdin`." + type: "boolean" + default: false + AttachStdout: + description: "Whether to attach to `stdout`." + type: "boolean" + default: true + AttachStderr: + description: "Whether to attach to `stderr`." + type: "boolean" + default: true + ExposedPorts: + description: | + An object mapping ports to an empty object in the form: + + `{"/": {}}` + type: "object" +# x-nullable: true + additionalProperties: + type: "object" + enum: + - {} + default: {} + example: { + "80/tcp": {}, + "443/tcp": {} + } + Tty: + description: | + Attach standard streams to a TTY, including `stdin` if it is not closed. + type: "boolean" + default: false + OpenStdin: + description: "Open `stdin`" + type: "boolean" + default: false + StdinOnce: + description: "Close `stdin` after one attached client disconnects" + type: "boolean" + default: false + Env: + description: | + A list of environment variables to set inside the container in the + form `["VAR=value", ...]`. A variable without `=` is removed from the + environment, rather than to have an empty value. + type: "array" + items: + type: "string" + example: + - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + Cmd: + description: | + Command to run specified as a string or an array of strings. + type: "array" + items: + type: "string" + example: ["/bin/sh"] + Healthcheck: + $ref: "#/definitions/HealthConfig" + ArgsEscaped: + description: "Command is already escaped (Windows only)" + type: "boolean" +# default: false + example: false +# x-nullable: true + Image: + description: | + The name (or reference) of the image to use when creating the container, + or which was used when the container was created. + type: "string" + example: "example-image:1.0" + Volumes: + description: | + An object mapping mount point paths inside the container to empty + objects. + type: "object" + additionalProperties: + type: "object" + enum: + - {} + default: {} + WorkingDir: + description: "The working directory for commands to run in." + type: "string" + example: "/public/" + Entrypoint: + description: | + The entry point for the container as a string or an array of strings. + + If the array consists of exactly one empty string (`[""]`) then the + entry point is reset to system default (i.e., the entry point used by + docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + type: "array" + items: + type: "string" + example: [] + NetworkDisabled: + description: "Disable networking for the container." + type: "boolean" +# x-nullable: true + OnBuild: + description: | + `ONBUILD` metadata that were defined in the image's `Dockerfile`. + type: "array" +# x-nullable: true + items: + type: "string" + example: [] + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + StopSignal: + description: | + Signal to stop a container as a string or unsigned integer. + type: "string" + default: "SIGTERM" + example: "SIGTERM" +# x-nullable: true + StopTimeout: + description: "Timeout to stop a container in seconds." + type: "integer" + default: 10 +# x-nullable: true + Shell: + description: | + Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + type: "array" +# x-nullable: true + items: + type: "string" + example: ["/bin/sh", "-c"] + + ImageConfig: + description: | + Configuration of the image. These fields are used as defaults + when starting a container from the image. + type: "object" + properties: + User: + description: "The user that commands are run as inside the container." + type: "string" + example: "web:web" + ExposedPorts: + description: | + An object mapping ports to an empty object in the form: + + `{"/": {}}` + type: "object" + x-nullable: true + additionalProperties: + type: "object" + enum: + - {} + default: {} + example: { + "80/tcp": {}, + "443/tcp": {} + } + Env: + description: | + A list of environment variables to set inside the container in the + form `["VAR=value", ...]`. A variable without `=` is removed from the + environment, rather than to have an empty value. + type: "array" + items: + type: "string" + example: + - "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" + Cmd: + description: | + Command to run specified as a string or an array of strings. + type: "array" + items: + type: "string" + example: ["/bin/sh"] + Healthcheck: + $ref: "#/definitions/HealthConfig" + ArgsEscaped: + description: "Command is already escaped (Windows only)" + type: "boolean" + default: false + example: false + x-nullable: true + Volumes: + description: | + An object mapping mount point paths inside the container to empty + objects. + type: "object" + additionalProperties: + type: "object" + enum: + - {} + default: {} + example: + "/app/data": {} + "/app/config": {} + WorkingDir: + description: "The working directory for commands to run in." + type: "string" + example: "/public/" + Entrypoint: + description: | + The entry point for the container as a string or an array of strings. + + If the array consists of exactly one empty string (`[""]`) then the + entry point is reset to system default (i.e., the entry point used by + docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + type: "array" + items: + type: "string" + example: [] + OnBuild: + description: | + `ONBUILD` metadata that were defined in the image's `Dockerfile`. + type: "array" + x-nullable: true + items: + type: "string" + example: [] + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + StopSignal: + description: | + Signal to stop a container as a string or unsigned integer. + type: "string" + example: "SIGTERM" + x-nullable: true + Shell: + description: | + Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + type: "array" + x-nullable: true + items: + type: "string" + example: ["/bin/sh", "-c"] + + NetworkingConfig: + description: | + NetworkingConfig represents the container's networking configuration for + each of its interfaces. + It is used for the networking configs specified in the `docker create` + and `docker network connect` commands. + type: "object" + properties: + EndpointsConfig: + description: | + A mapping of network name to endpoint configuration for that network. + The endpoint configuration can be left empty to connect to that + network with no particular endpoint configuration. + type: "object" + additionalProperties: + $ref: "#/definitions/EndpointSettings" + example: + # putting an example here, instead of using the example values from + # /definitions/EndpointSettings, because EndpointSettings contains + # operational data returned when inspecting a container that we don't + # accept here. + EndpointsConfig: + isolated_nw: + IPAMConfig: + IPv4Address: "172.20.30.33" + IPv6Address: "2001:db8:abcd::3033" + LinkLocalIPs: + - "169.254.34.68" + - "fe80::3468" + MacAddress: "02:42:ac:12:05:02" + Links: + - "container_1" + - "container_2" + Aliases: + - "server_x" + - "server_y" + database_nw: {} + + NetworkSettings: + description: "NetworkSettings exposes the network settings in the API" + type: "object" + properties: + SandboxID: + description: SandboxID uniquely represents a container's network stack. + type: "string" + example: "9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3" + SandboxKey: + description: SandboxKey is the full path of the netns handle + type: "string" + example: "/var/run/docker/netns/8ab54b426c38" + Ports: + $ref: "#/definitions/PortMap" + Networks: + description: | + Information about all networks that the container is connected to. + type: "object" + additionalProperties: + $ref: "#/definitions/EndpointSettings" + + Address: + description: Address represents an IPv4 or IPv6 IP address. + type: "object" + properties: + Addr: + description: IP address. + type: "string" + PrefixLen: + description: Mask length of the IP address. + type: "integer" + + PortMap: + description: | + PortMap describes the mapping of container ports to host ports, using the + container's port-number and protocol as key in the format `/`, + for example, `80/udp`. + + If a container's port is mapped for multiple protocols, separate entries + are added to the mapping table. + type: "object" + additionalProperties: + type: "array" + x-nullable: true + items: + $ref: "#/definitions/PortBinding" + example: + "443/tcp": + - HostIp: "127.0.0.1" + HostPort: "4443" + "80/tcp": + - HostIp: "0.0.0.0" + HostPort: "80" + - HostIp: "0.0.0.0" + HostPort: "8080" + "80/udp": + - HostIp: "0.0.0.0" + HostPort: "80" + "53/udp": + - HostIp: "0.0.0.0" + HostPort: "53" + "2377/tcp": null + + PortBinding: + description: | + PortBinding represents a binding between a host IP address and a host + port. + type: "object" + properties: + HostIp: + description: "Host IP address that the container's port is mapped to." + type: "string" + example: "127.0.0.1" + x-go-type: + type: Addr + import: + package: net/netip + HostPort: + description: "Host port number that the container's port is mapped to." + type: "string" + example: "4443" + + DriverData: + description: | + Information about the storage driver used to store the container's and + image's filesystem. + type: "object" + required: [Name] +# required: [Name, Data] + properties: + Name: + description: "Name of the storage driver." + type: "string" + x-nullable: false + example: "overlay2" + Data: + description: | + Low-level storage metadata, provided as key/value pairs. + + This information is driver-specific, and depends on the storage-driver + in use, and should be used for informational purposes only. + type: "object" +# x-nullable: false + additionalProperties: + type: "string" + example: { + "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged", + "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff", + "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work" + } + + Storage: + description: | + Information about the storage used by the container. + type: "object" + properties: + RootFS: + description: | + Information about the storage used for the container's root filesystem. + type: "object" + x-nullable: true + $ref: "#/definitions/RootFSStorage" + + RootFSStorage: + description: | + Information about the storage used for the container's root filesystem. + type: "object" + x-go-name: RootFSStorage + properties: + Snapshot: + description: | + Information about the snapshot used for the container's root filesystem. + type: "object" + x-nullable: true + $ref: "#/definitions/RootFSStorageSnapshot" + + RootFSStorageSnapshot: + description: | + Information about a snapshot backend of the container's root filesystem. + type: "object" + x-go-name: RootFSStorageSnapshot + properties: + Name: + description: "Name of the snapshotter." + type: "string" + x-nullable: false + + FilesystemChange: + description: | + Change in the container's filesystem. + type: "object" + required: [Path, Kind] + properties: + Path: + description: | + Path to file or directory that has changed. + type: "string" + x-nullable: false + Kind: + $ref: "#/definitions/ChangeType" + + ChangeType: + description: | + Kind of change + + Can be one of: + + - `0`: Modified ("C") + - `1`: Added ("A") + - `2`: Deleted ("D") + type: "integer" + format: "uint8" + enum: [0, 1, 2] + x-enum-varnames: ["T0", "T1", "T2"] + x-nullable: false + + ImageInspect: + description: | + Information about an image in the local image cache. + type: "object" + properties: + Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. + type: "string" + x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" + Descriptor: + description: | + Descriptor is an OCI descriptor of the image target. + In case of a multi-platform image, this descriptor points to the OCI index + or a manifest list. + + This field is only present if the daemon provides a multi-platform image store. + + WARNING: This is experimental and may change at any time without any backward + compatibility. + x-nullable: true + $ref: "#/definitions/OCIDescriptor" + Manifests: + description: | + Manifests is a list of image manifests available in this image. It + provides a more detailed view of the platform-specific image manifests or + other image-attached data like build attestations. + + Only available if the daemon provides a multi-platform image store + and the `manifests` option is set in the inspect request. + + WARNING: This is experimental and may change at any time without any backward + compatibility. + type: "array" + x-nullable: true + items: + $ref: "#/definitions/ImageManifestSummary" + RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same image, and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. + type: "array" + items: + type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" + RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. + type: "array" + items: + type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" + Comment: + description: | + Optional message that was set when committing or importing the image. + type: "string" + x-nullable: false + example: "" + Created: + description: | + Date and time at which the image was created, formatted in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + + This information is only available if present in the image, + and omitted otherwise. + type: "string" + format: "dateTime" + x-nullable: false + example: "2022-02-04T21:20:12.497794809Z" + Author: + description: | + Name of the author that was specified when committing the image, or as + specified through MAINTAINER (deprecated) in the Dockerfile. + type: "string" + x-nullable: false + example: "" + Config: + $ref: "#/definitions/ImageConfig" + Architecture: + description: | + Hardware CPU architecture that the image runs on. + type: "string" + x-nullable: false + example: "arm" + Variant: + description: | + CPU architecture variant (presently ARM-only). + type: "string" + x-nullable: true + example: "v7" + Os: + description: | + Operating System the image is built to run on. + type: "string" + x-nullable: false + example: "linux" + OsVersion: + description: | + Operating System version the image is built to run on (especially + for Windows). + type: "string" + example: "" +# x-nullable: true + Size: + description: | + Total size of the image including all layers it is composed of. + type: "integer" + format: "int64" + x-nullable: false + example: 1239828 + GraphDriver: + x-nullable: true + $ref: "#/definitions/DriverData" + RootFS: + description: | + Information about the image's RootFS, including the layer IDs. + type: "object" + required: [Type] + properties: + Type: + type: "string" + x-nullable: false + example: "layers" + Layers: + type: "array" + items: + type: "string" + example: + - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" + - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" + Metadata: + description: | + Additional metadata of the image in the local cache. This information + is local to the daemon, and not part of the image itself. + type: "object" + properties: + LastTagTime: + description: | + Date and time at which the image was last tagged in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + + This information is only available if the image was tagged locally, + and omitted otherwise. + type: "string" + format: "dateTime" + example: "2022-02-28T14:40:02.623929178Z" +# x-nullable: true + + ImageSummary: + type: "object" + x-go-name: "Summary" + required: + - Id + - ParentId +# - RepoTags +# - RepoDigests + - Created + - Size + - SharedSize +# - Labels + - Containers + properties: + Id: + description: | + ID is the content-addressable ID of an image. + + This identifier is a content-addressable digest calculated from the + image's configuration (which includes the digests of layers used by + the image). + + Note that this digest differs from the `RepoDigests` below, which + holds digests of image manifests that reference the image. + type: "string" + x-nullable: false + example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710" + ParentId: + description: | + ID of the parent image. + + Depending on how the image was created, this field may be empty and + is only set for images that were built/created locally. This field + is empty if the image was pulled from an image registry. + type: "string" + x-nullable: false + example: "" + RepoTags: + description: | + List of image names/tags in the local image cache that reference this + image. + + Multiple image tags can refer to the same image, and this list may be + empty if no tags reference the image, in which case the image is + "untagged", in which case it can still be referenced by its ID. + type: "array" +# x-nullable: false + items: + type: "string" + example: + - "example:1.0" + - "example:latest" + - "example:stable" + - "internal.registry.example.com:5000/example:1.0" + RepoDigests: + description: | + List of content-addressable digests of locally available image manifests + that the image is referenced from. Multiple manifests can refer to the + same image. + + These digests are usually only available if the image was either pulled + from a registry, or if the image was pushed to a registry, which is when + the manifest is generated and its digest calculated. + type: "array" +# x-nullable: false + items: + type: "string" + example: + - "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb" + - "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578" + Created: + description: | + Date and time at which the image was created as a Unix timestamp + (number of seconds since EPOCH). + type: "integer" + x-nullable: false + example: "1644009612" + Size: + description: | + Total size of the image including all layers it is composed of. + type: "integer" + format: "int64" + x-nullable: false + example: 172064416 + SharedSize: + description: | + Total size of image layers that are shared between this image and other + images. + + This size is not calculated by default. `-1` indicates that the value + has not been set / calculated. + type: "integer" + format: "int64" + x-nullable: false + example: 1239828 + Labels: + description: "User-defined key/value metadata." + type: "object" +# x-nullable: false + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Containers: + description: | + Number of containers using this image. Includes both stopped and running + containers. + + `-1` indicates that the value has not been set / calculated. + x-nullable: false + type: "integer" + example: 2 + Manifests: + description: | + Manifests is a list of manifests available in this image. + It provides a more detailed view of the platform-specific image manifests + or other image-attached data like build attestations. + + WARNING: This is experimental and may change at any time without any backward + compatibility. + type: "array" + x-nullable: false + x-omitempty: true + items: + $ref: "#/definitions/ImageManifestSummary" + Descriptor: + description: | + Descriptor is an OCI descriptor of the image target. + In case of a multi-platform image, this descriptor points to the OCI index + or a manifest list. + + This field is only present if the daemon provides a multi-platform image store. + + WARNING: This is experimental and may change at any time without any backward + compatibility. + x-nullable: true + $ref: "#/definitions/OCIDescriptor" + + ImagesDiskUsage: + type: "object" + x-go-name: "DiskUsage" + x-go-package: "github.com/moby/moby/api/types/image" + description: | + represents system data usage for image resources. + properties: + ActiveCount: + description: | + Count of active images. + type: "integer" + format: "int64" + example: 1 + TotalCount: + description: | + Count of all images. + type: "integer" + format: "int64" + example: 4 + Reclaimable: + description: | + Disk space that can be reclaimed by removing unused images. + type: "integer" + format: "int64" + example: 12345678 + TotalSize: + description: | + Disk space in use by images. + type: "integer" + format: "int64" + example: 98765432 + Items: + description: | + List of image summaries. + type: "array" + x-omitempty: true + items: + x-go-type: + type: Summary + + AuthConfig: + type: "object" + properties: + username: + type: "string" + password: + type: "string" + serveraddress: + type: "string" + example: + username: "hannibal" + password: "xxxx" + serveraddress: "https://index.docker.io/v1/" + + AuthResponse: + description: | + An identity token was generated successfully. + type: "object" + required: [Status] + properties: + Status: + description: "The status of the authentication" + type: "string" + example: "Login Succeeded" + x-nullable: false + IdentityToken: + description: "An opaque token used to authenticate a user after a successful login" + type: "string" + example: "9cbaf023786cd7..." + x-nullable: false + + ProcessConfig: + type: "object" + properties: + privileged: + type: "boolean" + user: + type: "string" + tty: + type: "boolean" + entrypoint: + type: "string" + arguments: + type: "array" + items: + type: "string" + + Volume: + type: "object" + required: [Name, Driver, Mountpoint, Options] +# required: [Name, Driver, Mountpoint, Labels, Scope, Options] + x-nullable: false + properties: + Name: + type: "string" + description: "Name of the volume." + x-nullable: false + example: "tardis" + Driver: + type: "string" + description: "Name of the volume driver used by the volume." + x-nullable: false + example: "custom" + Mountpoint: + type: "string" + description: "Mount path of the volume on the host." + x-nullable: false + example: "/var/lib/docker/volumes/tardis" + CreatedAt: + type: "string" + format: "dateTime" + description: "Date/Time the volume was created." + example: "2016-06-07T20:31:11.853781916Z" + Status: + type: "object" + description: | + Low-level details about the volume, provided by the volume driver. + Details are returned as a map with key/value pairs: + `{"key":"value","key2":"value2"}`. + + The `Status` field is optional, and is omitted if the volume driver + does not support this feature. + additionalProperties: + type: "object" + example: + hello: "world" + Labels: + type: "object" + description: "User-defined key/value metadata." +# x-nullable: false + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Scope: + type: "string" + description: | + The level at which the volume exists. Either `global` for cluster-wide, + or `local` for machine level. + default: "local" +# x-nullable: false + enum: ["local", "global"] + example: "local" + ClusterVolume: + $ref: "#/definitions/ClusterVolume" + Options: + type: "object" + x-nullable: true + description: | + The driver specific options used when creating the volume. + additionalProperties: + type: "string" + example: + device: "tmpfs" + o: "size=100m,uid=1000" + type: "tmpfs" + UsageData: + type: "object" + x-nullable: true + x-go-name: "UsageData" + required: [Size, RefCount] + description: | + Usage details about the volume. This information is used by the + `GET /system/df` endpoint, and omitted in other endpoints. + properties: + Size: + type: "integer" + format: "int64" + default: -1 + description: | + Amount of disk space used by the volume (in bytes). This information + is only available for volumes created with the `"local"` volume + driver. For volumes created with other volume drivers, this field + is set to `-1` ("not available") + x-nullable: false + RefCount: + type: "integer" + format: "int64" + default: -1 + description: | + The number of containers referencing this volume. This field + is set to `-1` if the reference-count is not available. + x-nullable: false + + VolumesDiskUsage: + type: "object" + x-go-name: "DiskUsage" + x-go-package: "github.com/moby/moby/api/types/volume" + description: | + represents system data usage for volume resources. + properties: + ActiveCount: + description: | + Count of active volumes. + type: "integer" + format: "int64" + example: 1 + TotalCount: + description: | + Count of all volumes. + type: "integer" + format: "int64" + example: 4 + Reclaimable: + description: | + Disk space that can be reclaimed by removing inactive volumes. + type: "integer" + format: "int64" + example: 12345678 + TotalSize: + description: | + Disk space in use by volumes. + type: "integer" + format: "int64" + example: 98765432 + Items: + description: | + List of volumes. + type: "array" + x-omitempty: true + items: + x-go-type: + type: Volume + + VolumeCreateRequest: + description: "Volume configuration" + type: "object" + title: "VolumeConfig" + x-go-name: "CreateRequest" + properties: + Name: + description: | + The new volume's name. If not specified, Docker generates a name. + type: "string" + x-nullable: false + example: "tardis" + Driver: + description: "Name of the volume driver to use." + type: "string" + default: "local" + x-nullable: false + example: "custom" + DriverOpts: + description: | + A mapping of driver options and values. These options are + passed directly to the driver and are driver specific. + type: "object" + additionalProperties: + type: "string" + example: + device: "tmpfs" + o: "size=100m,uid=1000" + type: "tmpfs" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + ClusterVolumeSpec: + $ref: "#/definitions/ClusterVolumeSpec" + + VolumeListResponse: + type: "object" + title: "VolumeListResponse" + x-go-name: "ListResponse" + description: "Volume list response" + properties: + Volumes: + type: "array" + description: "List of volumes" + items: + $ref: "#/definitions/Volume" + Warnings: + type: "array" + description: | + Warnings that occurred when fetching the list of volumes. + items: + type: "string" + example: [] + + Network: + type: "object" + properties: + Name: + description: | + Name of the network. + type: "string" + example: "my_network" + x-omitempty: false + Id: + description: | + ID that uniquely identifies a network on a single machine. + type: "string" + x-go-name: "ID" + x-omitempty: false + example: "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99" + Created: + description: | + Date and time at which the network was created in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + x-omitempty: false + x-go-type: + type: Time + import: + package: time + hints: + nullable: false + example: "2016-10-19T04:33:30.360899459Z" + Scope: + description: | + The level at which the network exists (e.g. `swarm` for cluster-wide + or `local` for machine level) + type: "string" + x-omitempty: false + example: "local" + Driver: + description: | + The name of the driver used to create the network (e.g. `bridge`, + `overlay`). + type: "string" + x-omitempty: false + example: "overlay" + EnableIPv4: + description: | + Whether the network was created with IPv4 enabled. + type: "boolean" + x-omitempty: false + example: true + EnableIPv6: + description: | + Whether the network was created with IPv6 enabled. + type: "boolean" + x-omitempty: false + example: false + IPAM: + description: | + The network's IP Address Management. + $ref: "#/definitions/IPAM" + x-nullable: false + x-omitempty: false + Internal: + description: | + Whether the network is created to only allow internal networking + connectivity. + type: "boolean" + x-nullable: false + x-omitempty: false + default: false + example: false + Attachable: + description: | + Whether a global / swarm scope network is manually attachable by regular + containers from workers in swarm mode. + type: "boolean" + x-nullable: false + x-omitempty: false + default: false + example: false + Ingress: + description: | + Whether the network is providing the routing-mesh for the swarm cluster. + type: "boolean" + x-nullable: false + x-omitempty: false + default: false + example: false + ConfigFrom: + $ref: "#/definitions/ConfigReference" + x-nullable: false + x-omitempty: false + ConfigOnly: + description: | + Whether the network is a config-only network. Config-only networks are + placeholder networks for network configurations to be used by other + networks. Config-only networks cannot be used directly to run containers + or services. + type: "boolean" + x-omitempty: false + x-nullable: false + default: false + Options: + description: | + Network-specific options uses when creating the network. + type: "object" + x-omitempty: false + additionalProperties: + type: "string" + example: + com.docker.network.bridge.default_bridge: "true" + com.docker.network.bridge.enable_icc: "true" + com.docker.network.bridge.enable_ip_masquerade: "true" + com.docker.network.bridge.host_binding_ipv4: "0.0.0.0" + com.docker.network.bridge.name: "docker0" + com.docker.network.driver.mtu: "1500" + Labels: + description: | + Metadata specific to the network being created. + type: "object" + x-omitempty: false + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Peers: + description: | + List of peer nodes for an overlay network. This field is only present + for overlay networks, and omitted for other network types. + type: "array" + x-omitempty: true + items: + $ref: "#/definitions/PeerInfo" + + NetworkSummary: + description: "Network list response item" + x-go-name: Summary + type: "object" + allOf: + - $ref: "#/definitions/Network" + + NetworkInspect: + description: 'The body of the "get network" http response message.' + x-go-name: Inspect + type: "object" + allOf: + - $ref: "#/definitions/Network" + properties: + Containers: + description: | + Contains endpoints attached to the network. + type: "object" + x-omitempty: false + additionalProperties: + $ref: "#/definitions/EndpointResource" + example: + 19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c: + Name: "test" + EndpointID: "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a" + MacAddress: "02:42:ac:13:00:02" + IPv4Address: "172.19.0.2/16" + IPv6Address: "" + Services: + description: | + List of services using the network. This field is only present for + swarm scope networks, and omitted for local scope networks. + type: "object" + x-omitempty: true + additionalProperties: + x-go-type: + type: ServiceInfo + hints: + nullable: false + Status: + description: > + provides runtime information about the network + such as the number of allocated IPs. + $ref: "#/definitions/NetworkStatus" + + NetworkStatus: + description: > + provides runtime information about the network + such as the number of allocated IPs. + type: "object" + x-go-name: Status + properties: + IPAM: + $ref: "#/definitions/IPAMStatus" + + ServiceInfo: + x-nullable: false + x-omitempty: false + description: > + represents service parameters with the list of service's tasks + type: "object" + properties: + VIP: + type: "string" + x-omitempty: false + x-go-type: + type: Addr + import: + package: net/netip + Ports: + type: "array" + x-omitempty: false + items: + type: "string" + LocalLBIndex: + type: "integer" + format: "int" + x-omitempty: false + x-go-type: + type: int + Tasks: + type: "array" + x-omitempty: false + items: + $ref: "#/definitions/NetworkTaskInfo" + + NetworkTaskInfo: + x-nullable: false + x-omitempty: false + x-go-name: Task + description: > + carries the information about one backend task + type: "object" + properties: + Name: + type: "string" + x-omitempty: false + EndpointID: + type: "string" + x-omitempty: false + EndpointIP: + type: "string" + x-omitempty: false + x-go-type: + type: Addr + import: + package: net/netip + Info: + type: "object" + x-omitempty: false + additionalProperties: + type: "string" + + ConfigReference: + x-nullable: false + x-omitempty: false + description: | + The config-only network source to provide the configuration for + this network. + type: "object" + properties: + Network: + description: | + The name of the config-only network that provides the network's + configuration. The specified network must be an existing config-only + network. Only network names are allowed, not network IDs. + type: "string" + x-omitempty: false + example: "config_only_network_01" + + IPAM: + type: "object" + x-nullable: false + x-omitempty: false + properties: + Driver: + description: "Name of the IPAM driver to use." + type: "string" + default: "default" + example: "default" + Config: + description: | + List of IPAM configuration options, specified as a map: + + ``` + {"Subnet": , "IPRange": , "Gateway": , "AuxAddress": } + ``` + type: "array" + items: + $ref: "#/definitions/IPAMConfig" + Options: + description: "Driver-specific options, specified as a map." + type: "object" + additionalProperties: + type: "string" + example: + foo: "bar" + + IPAMConfig: + type: "object" + properties: + Subnet: + type: "string" + example: "172.20.0.0/16" + IPRange: + type: "string" + example: "172.20.10.0/24" + Gateway: + type: "string" + example: "172.20.10.11" + AuxiliaryAddresses: + type: "object" + additionalProperties: + type: "string" + + IPAMStatus: + type: "object" + x-nullable: false + x-omitempty: false + properties: + Subnets: + type: "object" + additionalProperties: + $ref: "#/definitions/SubnetStatus" + example: + "172.16.0.0/16": + IPsInUse: 3 + DynamicIPsAvailable: 65533 + "2001:db8:abcd:0012::0/96": + IPsInUse: 5 + DynamicIPsAvailable: 4294967291 + x-go-type: + type: SubnetStatuses + kind: map + + SubnetStatus: + type: "object" + x-nullable: false + x-omitempty: false + properties: + IPsInUse: + description: > + Number of IP addresses in the subnet that are in use or reserved and + are therefore unavailable for allocation, saturating at 264 - 1. + type: integer + format: uint64 + x-omitempty: false + DynamicIPsAvailable: + description: > + Number of IP addresses within the network's IPRange for the subnet + that are available for allocation, saturating at 264 - 1. + type: integer + format: uint64 + x-omitempty: false + + EndpointResource: + type: "object" + description: > + contains network resources allocated and used for a + container in a network. + properties: + Name: + type: "string" + x-omitempty: false + example: "container_1" + EndpointID: + type: "string" + x-omitempty: false + example: "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a" + MacAddress: + type: "string" + x-omitempty: false + example: "02:42:ac:13:00:02" + x-go-type: + type: HardwareAddr + IPv4Address: + type: "string" + x-omitempty: false + example: "172.19.0.2/16" + x-go-type: + type: Prefix + import: + package: net/netip + IPv6Address: + type: "string" + x-omitempty: false + example: "" + x-go-type: + type: Prefix + import: + package: net/netip + + PeerInfo: + description: > + represents one peer of an overlay network. + type: "object" + x-nullable: false + properties: + Name: + description: + ID of the peer-node in the Swarm cluster. + type: "string" + x-omitempty: false + example: "6869d7c1732b" + IP: + description: + IP-address of the peer-node in the Swarm cluster. + type: "string" + x-omitempty: false + example: "10.133.77.91" + x-go-type: + type: Addr + import: + package: net/netip + + NetworkCreateResponse: + description: "OK response to NetworkCreate operation" + type: "object" + title: "NetworkCreateResponse" + x-go-name: "CreateResponse" + required: [Id, Warning] + properties: + Id: + description: "The ID of the created network." + type: "string" + x-nullable: false + example: "b5c4fc71e8022147cd25de22b22173de4e3b170134117172eb595cb91b4e7e5d" + Warning: + description: "Warnings encountered when creating the container" + type: "string" + x-nullable: false + example: "" + + BuildInfo: + type: "object" + properties: + id: + type: "string" + stream: + type: "string" + errorDetail: + $ref: "#/definitions/ErrorDetail" + status: + type: "string" + progressDetail: + $ref: "#/definitions/ProgressDetail" + aux: + $ref: "#/definitions/ImageID" + + BuildCache: + type: "object" + description: | + BuildCache contains information about a build cache record. + properties: + ID: + type: "string" + description: | + Unique ID of the build cache record. + example: "ndlpt0hhvkqcdfkputsk4cq9c" + Parents: + description: | + List of parent build cache record IDs. + type: "array" + items: + type: "string" + x-nullable: true + example: ["hw53o5aio51xtltp5xjp8v7fx"] + Type: + type: "string" + description: | + Cache record type. + example: "regular" + # see https://github.com/moby/buildkit/blob/fce4a32258dc9d9664f71a4831d5de10f0670677/client/diskusage.go#L75-L84 + enum: + - "internal" + - "frontend" + - "source.local" + - "source.git.checkout" + - "exec.cachemount" + - "regular" + Description: + type: "string" + description: | + Description of the build-step that produced the build cache. + example: "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache" + InUse: + type: "boolean" + description: | + Indicates if the build cache is in use. + example: false + Shared: + type: "boolean" + description: | + Indicates if the build cache is shared. + example: true + Size: + description: | + Amount of disk space used by the build cache (in bytes). + type: "integer" + example: 51 + CreatedAt: + description: | + Date and time at which the build cache was created in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-08-18T10:44:24.496525531Z" + LastUsedAt: + description: | + Date and time at which the build cache was last used in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + x-nullable: true + example: "2017-08-09T07:09:37.632105588Z" + UsageCount: + type: "integer" + example: 26 + + BuildCacheDiskUsage: + type: "object" + x-go-name: "DiskUsage" + x-go-package: "github.com/moby/moby/api/types/build" + description: | + represents system data usage for build cache resources. + properties: + ActiveCount: + description: | + Count of active build cache records. + type: "integer" + format: "int64" + example: 1 + TotalCount: + description: | + Count of all build cache records. + type: "integer" + format: "int64" + example: 4 + Reclaimable: + description: | + Disk space that can be reclaimed by removing inactive build cache records. + type: "integer" + format: "int64" + example: 12345678 + TotalSize: + description: | + Disk space in use by build cache records. + type: "integer" + format: "int64" + example: 98765432 + Items: + description: | + List of build cache records. + type: "array" + x-omitempty: true + items: + x-go-type: + type: CacheRecord + + ImageID: + type: "object" + description: "Image ID or Digest" + properties: + ID: + type: "string" + example: + ID: "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c" + + CreateImageInfo: + type: "object" + properties: + id: + type: "string" + errorDetail: + $ref: "#/definitions/ErrorDetail" + status: + type: "string" + progressDetail: + $ref: "#/definitions/ProgressDetail" + + PushImageInfo: + type: "object" + properties: + errorDetail: + $ref: "#/definitions/ErrorDetail" + status: + type: "string" + progressDetail: + $ref: "#/definitions/ProgressDetail" + + DeviceInfo: + type: "object" + description: | + DeviceInfo represents a device that can be used by a container. + properties: + Source: + type: "string" + example: "cdi" + description: | + The origin device driver. + ID: + type: "string" + example: "vendor.com/gpu=0" + description: | + The unique identifier for the device within its source driver. + For CDI devices, this would be an FQDN like "vendor.com/gpu=0". + + ErrorDetail: + type: "object" + properties: + code: + type: "integer" + message: + type: "string" + + ProgressDetail: + type: "object" + properties: + current: + type: "integer" + total: + type: "integer" + + ErrorResponse: + description: "Represents an error." + type: "object" + required: ["message"] + properties: + message: + description: "The error message." + type: "string" + x-nullable: false + example: + message: "Something went wrong." + + IDResponse: + description: "Response to an API call that returns just an Id" + type: "object" + x-go-name: "IDResponse" + required: ["Id"] + properties: + Id: + description: "The id of the newly created object." + type: "string" + x-nullable: false + + NetworkConnectRequest: + description: | + NetworkConnectRequest represents the data to be used to connect a container to a network. + type: "object" + x-go-name: "ConnectRequest" + required: ["Container"] + properties: + Container: + type: "string" + description: "The ID or name of the container to connect to the network." + x-nullable: false + example: "3613f73ba0e4" + EndpointConfig: + $ref: "#/definitions/EndpointSettings" + x-nullable: true + + NetworkDisconnectRequest: + description: | + NetworkDisconnectRequest represents the data to be used to disconnect a container from a network. + type: "object" + x-go-name: "DisconnectRequest" + required: ["Container"] + properties: + Container: + type: "string" + description: "The ID or name of the container to disconnect from the network." + x-nullable: false + example: "3613f73ba0e4" + Force: + type: "boolean" + description: "Force the container to disconnect from the network." + default: false + x-nullable: false + x-omitempty: false + example: false + + EndpointSettings: + description: "Configuration for a network endpoint." + type: "object" + properties: + # Configurations + IPAMConfig: + $ref: "#/definitions/EndpointIPAMConfig" + Links: + type: "array" + items: + type: "string" + example: + - "container_1" + - "container_2" + MacAddress: + description: | + MAC address for the endpoint on this network. The network driver might ignore this parameter. + type: "string" + example: "02:42:ac:11:00:04" + x-go-type: + type: HardwareAddr + Aliases: + type: "array" + items: + type: "string" + example: + - "server_x" + - "server_y" + DriverOpts: + description: | + DriverOpts is a mapping of driver options and values. These options + are passed directly to the driver and are driver specific. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + GwPriority: + description: | + This property determines which endpoint will provide the default + gateway for a container. The endpoint with the highest priority will + be used. If multiple endpoints have the same priority, endpoints are + lexicographically sorted based on their network name, and the one + that sorts first is picked. + type: "integer" + format: "int64" + example: + - 10 + + # Operational data + NetworkID: + description: | + Unique ID of the network. + type: "string" + example: "08754567f1f40222263eab4102e1c733ae697e8e354aa9cd6e18d7402835292a" + EndpointID: + description: | + Unique ID for the service endpoint in a Sandbox. + type: "string" + example: "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b" + Gateway: + description: | + Gateway address for this network. + type: "string" + example: "172.17.0.1" + IPAddress: + description: | + IPv4 address. + type: "string" + example: "172.17.0.4" + x-go-type: + type: Addr + import: + package: net/netip + IPPrefixLen: + description: | + Mask length of the IPv4 address. + type: "integer" + example: 16 + IPv6Gateway: + description: | + IPv6 gateway address. + type: "string" + example: "2001:db8:2::100" + x-go-type: + type: Addr + import: + package: net/netip + GlobalIPv6Address: + description: | + Global IPv6 address. + type: "string" + example: "2001:db8::5689" + x-go-type: + type: Addr + import: + package: net/netip + GlobalIPv6PrefixLen: + description: | + Mask length of the global IPv6 address. + type: "integer" + format: "int64" + example: 64 + DNSNames: + description: | + List of all DNS names an endpoint has on a specific network. This + list is based on the container name, network aliases, container short + ID, and hostname. + + These DNS names are non-fully qualified but can contain several dots. + You can get fully qualified DNS names by appending `.`. + For instance, if container name is `my.ctr` and the network is named + `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be + `my.ctr.testnet`. + type: array + items: + type: string + example: ["foobar", "server_x", "server_y", "my.ctr"] + + EndpointIPAMConfig: + description: | + EndpointIPAMConfig represents an endpoint's IPAM configuration. + type: "object" + x-nullable: true + properties: + IPv4Address: + type: "string" + example: "172.20.30.33" + x-go-type: + type: Addr + import: + package: net/netip + IPv6Address: + type: "string" + example: "2001:db8:abcd::3033" + x-go-type: + type: Addr + import: + package: net/netip + LinkLocalIPs: + type: "array" + items: + type: "string" + x-go-type: + type: Addr + import: + package: net/netip + example: + - "169.254.34.68" + - "fe80::3468" + + PluginMount: + type: "object" + x-go-name: "Mount" + x-nullable: false + required: [Name, Description, Settable, Source, Destination, Type, Options] + properties: + Name: + type: "string" + x-nullable: false + example: "some-mount" + Description: + type: "string" + x-nullable: false + example: "This is a mount that's used by the plugin." + Settable: + type: "array" + items: + type: "string" + Source: + type: "string" + example: "/var/lib/docker/plugins/" + Destination: + type: "string" + x-nullable: false + example: "/mnt/state" + Type: + type: "string" + x-nullable: false + example: "bind" + Options: + type: "array" + items: + type: "string" + example: + - "rbind" + - "rw" + + PluginDevice: + type: "object" + x-go-name: "Device" + required: [Name, Description, Settable, Path] + x-nullable: false + properties: + Name: + type: "string" + x-nullable: false + Description: + type: "string" + x-nullable: false + Settable: + type: "array" + items: + type: "string" + Path: + type: "string" + example: "/dev/fuse" + + PluginEnv: + type: "object" + x-go-name: "Env" + x-nullable: false + required: [Name, Description, Settable, Value] + properties: + Name: + x-nullable: false + type: "string" + Description: + x-nullable: false + type: "string" + Settable: + type: "array" + items: + type: "string" + Value: + type: "string" + + PluginPrivilege: + description: | + Describes a permission the user has to accept upon installing + the plugin. + type: "object" + x-go-name: "Privilege" + 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" + x-go-name: "Plugin" + required: [Settings, Enabled, Config, Name] + properties: + Id: + type: "string" + example: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078" + Name: + type: "string" + x-nullable: false + example: "tiborvass/sample-volume-plugin" + Enabled: + description: + True if the plugin is running. False if the plugin is not running, + only installed. + type: "boolean" + x-nullable: false + example: true + Settings: + description: "user-configurable settings for the plugin." + type: "object" + x-go-name: "Settings" + x-nullable: false + required: [Args, Devices, Env, Mounts] + properties: + Mounts: + type: "array" + items: + $ref: "#/definitions/PluginMount" + Env: + type: "array" + items: + type: "string" + example: + - "DEBUG=0" + Args: + type: "array" + items: + type: "string" + Devices: + type: "array" + items: + $ref: "#/definitions/PluginDevice" + PluginReference: + description: "plugin remote reference used to push/pull the plugin" + type: "string" + x-go-name: "PluginReference" + x-nullable: false + example: "localhost:5000/tiborvass/sample-volume-plugin:latest" + Config: + description: "The config of a plugin." + type: "object" + x-go-name: "Config" + x-nullable: false + required: + - Description + - Documentation + - Interface + - Entrypoint + - WorkDir + - Network + - Linux + - PidHost + - PropagatedMount + - IpcHost + - Mounts + - Env + - Args + properties: + Description: + type: "string" + x-nullable: false + example: "A sample volume plugin for Docker" + Documentation: + type: "string" + x-nullable: false + example: "https://docs.docker.com/engine/extend/plugins/" + Interface: + description: "The interface between Docker and the plugin" + x-nullable: false + type: "object" + x-go-name: "Interface" + required: [Types, Socket] + properties: + Types: + type: "array" + items: + type: "string" + x-go-type: + type: "CapabilityID" + example: + - "docker.volumedriver/1.0" + Socket: + type: "string" + x-nullable: false + example: "plugins.sock" + ProtocolScheme: + type: "string" + example: "some.protocol/v1.0" + description: "Protocol to use for clients connecting to the plugin." + enum: + - "" + - "moby.plugins.http/v1" + Entrypoint: + type: "array" + items: + type: "string" + example: + - "/usr/bin/sample-volume-plugin" + - "/data" + WorkDir: + type: "string" + x-nullable: false + example: "/bin/" + User: + type: "object" + x-go-name: "User" + x-nullable: false + properties: + UID: + type: "integer" + format: "uint32" + example: 1000 + GID: + type: "integer" + format: "uint32" + example: 1000 + Network: + type: "object" + x-go-name: "NetworkConfig" + x-nullable: false + required: [Type] + properties: + Type: + x-nullable: false + type: "string" + example: "host" + Linux: + type: "object" + x-go-name: "LinuxConfig" + x-nullable: false + required: [Capabilities, AllowAllDevices, Devices] + properties: + Capabilities: + type: "array" + items: + type: "string" + example: + - "CAP_SYS_ADMIN" + - "CAP_SYSLOG" + AllowAllDevices: + type: "boolean" + x-nullable: false + example: false + Devices: + type: "array" + items: + $ref: "#/definitions/PluginDevice" + PropagatedMount: + type: "string" + x-nullable: false + example: "/mnt/volumes" + IpcHost: + type: "boolean" + x-nullable: false + example: false + PidHost: + type: "boolean" + x-nullable: false + example: false + Mounts: + type: "array" + items: + $ref: "#/definitions/PluginMount" + Env: + type: "array" + items: + $ref: "#/definitions/PluginEnv" + example: + - Name: "DEBUG" + Description: "If set, prints debug messages" + Settable: null + Value: "0" + Args: + type: "object" + x-go-name: "Args" + x-nullable: false + required: [Name, Description, Settable, Value] + properties: + Name: + x-nullable: false + type: "string" + example: "args" + Description: + x-nullable: false + type: "string" + example: "command line arguments" + Settable: + type: "array" + items: + type: "string" + Value: + type: "array" + items: + type: "string" + rootfs: + type: "object" + x-go-name: "RootFS" + properties: + type: + type: "string" + example: "layers" + diff_ids: + type: "array" + items: + type: "string" + example: + - "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887" + - "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8" + + ObjectVersion: + description: | + The version number of the object such as node, service, etc. This is needed + to avoid conflicting writes. The client must send the version number along + with the modified specification when updating these objects. + + This approach ensures safe concurrency and determinism in that the change + on the object may not be applied if the version number has changed from the + last read. In other words, if two update requests specify the same base + version, only one of the requests can succeed. As a result, two separate + update requests that happen at the same time will not unintentionally + overwrite each other. + type: "object" + properties: + Index: + type: "integer" + format: "uint64" + example: 373531 + + NodeSpec: + type: "object" + properties: + Name: + description: "Name for the node." + type: "string" + example: "my-node" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + Role: + description: "Role of the node." + type: "string" + enum: + - "worker" + - "manager" + example: "manager" + Availability: + description: "Availability of the node." + type: "string" + enum: + - "active" + - "pause" + - "drain" + example: "active" + example: + Availability: "active" + Name: "node-name" + Role: "manager" + Labels: + foo: "bar" + + Node: + type: "object" + properties: + ID: + type: "string" + example: "24ifsmvkjbyhk" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + description: | + Date and time at which the node was added to the swarm in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-08-18T10:44:24.496525531Z" + UpdatedAt: + description: | + Date and time at which the node was last updated in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2017-08-09T07:09:37.632105588Z" + Spec: + $ref: "#/definitions/NodeSpec" + Description: + $ref: "#/definitions/NodeDescription" + Status: + $ref: "#/definitions/NodeStatus" + ManagerStatus: + $ref: "#/definitions/ManagerStatus" + + NodeDescription: + description: | + NodeDescription encapsulates the properties of the Node as reported by the + agent. + type: "object" + properties: + Hostname: + type: "string" + example: "bf3067039e47" + Platform: + $ref: "#/definitions/Platform" + Resources: + $ref: "#/definitions/ResourceObject" + Engine: + $ref: "#/definitions/EngineDescription" + TLSInfo: + $ref: "#/definitions/TLSInfo" + + Platform: + description: | + Platform represents the platform (Arch/OS). + type: "object" + properties: + Architecture: + description: | + Architecture represents the hardware architecture (for example, + `x86_64`). + type: "string" + example: "x86_64" + OS: + description: | + OS represents the Operating System (for example, `linux` or `windows`). + type: "string" + example: "linux" + + EngineDescription: + description: "EngineDescription provides information about an engine." + type: "object" + properties: + EngineVersion: + type: "string" + example: "17.06.0" + Labels: + type: "object" + additionalProperties: + type: "string" + example: + foo: "bar" + Plugins: + type: "array" + items: + type: "object" + properties: + Type: + type: "string" + Name: + type: "string" + example: + - Type: "Log" + Name: "awslogs" + - Type: "Log" + Name: "fluentd" + - Type: "Log" + Name: "gcplogs" + - Type: "Log" + Name: "gelf" + - Type: "Log" + Name: "journald" + - Type: "Log" + Name: "json-file" + - Type: "Log" + Name: "splunk" + - Type: "Log" + Name: "syslog" + - Type: "Network" + Name: "bridge" + - Type: "Network" + Name: "host" + - Type: "Network" + Name: "ipvlan" + - Type: "Network" + Name: "macvlan" + - Type: "Network" + Name: "null" + - Type: "Network" + Name: "overlay" + - Type: "Volume" + Name: "local" + - Type: "Volume" + Name: "localhost:5000/vieux/sshfs:latest" + - Type: "Volume" + Name: "vieux/sshfs:latest" + + TLSInfo: + description: | + Information about the issuer of leaf TLS certificates and the trusted root + CA certificate. + type: "object" + properties: + TrustRoot: + description: | + The root CA certificate(s) that are used to validate leaf TLS + certificates. + type: "string" + CertIssuerSubject: + description: + The base64-url-safe-encoded raw subject bytes of the issuer. + type: "string" + CertIssuerPublicKey: + description: | + The base64-url-safe-encoded raw public key bytes of the issuer. + type: "string" + example: + TrustRoot: | + -----BEGIN CERTIFICATE----- + MIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw + EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0 + MzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH + A0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf + 3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB + Af8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO + PQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz + pxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H + -----END CERTIFICATE----- + CertIssuerSubject: "MBMxETAPBgNVBAMTCHN3YXJtLWNh" + CertIssuerPublicKey: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==" + + NodeStatus: + description: | + NodeStatus represents the status of a node. + + It provides the current status of the node, as seen by the manager. + type: "object" + properties: + State: + $ref: "#/definitions/NodeState" + Message: + type: "string" + example: "" + Addr: + description: "IP address of the node." + type: "string" + example: "172.17.0.2" + + NodeState: + description: "NodeState represents the state of a node." + type: "string" + enum: + - "unknown" + - "down" + - "ready" + - "disconnected" + example: "ready" + + ManagerStatus: + description: | + ManagerStatus represents the status of a manager. + + It provides the current status of a node's manager component, if the node + is a manager. + x-nullable: true + type: "object" + properties: + Leader: + type: "boolean" + default: false + example: true + Reachability: + $ref: "#/definitions/Reachability" + Addr: + description: | + The IP address and port at which the manager is reachable. + type: "string" + example: "10.0.0.46:2377" + + Reachability: + description: "Reachability represents the reachability of a node." + type: "string" + enum: + - "unknown" + - "unreachable" + - "reachable" + example: "reachable" + + SwarmSpec: + description: "User modifiable swarm configuration." + type: "object" + properties: + Name: + description: "Name of the swarm." + type: "string" + example: "default" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.corp.type: "production" + com.example.corp.department: "engineering" + Orchestration: + description: "Orchestration configuration." + type: "object" + x-nullable: true + properties: + TaskHistoryRetentionLimit: + description: | + The number of historic tasks to keep per instance or node. If + negative, never remove completed or failed tasks. + type: "integer" + format: "int64" + example: 10 + Raft: + description: "Raft configuration." + type: "object" + properties: + SnapshotInterval: + description: "The number of log entries between snapshots." + type: "integer" + format: "uint64" + example: 10000 + KeepOldSnapshots: + description: | + The number of snapshots to keep beyond the current snapshot. + type: "integer" + format: "uint64" + LogEntriesForSlowFollowers: + description: | + The number of log entries to keep around to sync up slow followers + after a snapshot is created. + type: "integer" + format: "uint64" + example: 500 + ElectionTick: + description: | + The number of ticks that a follower will wait for a message from + the leader before becoming a candidate and starting an election. + `ElectionTick` must be greater than `HeartbeatTick`. + + A tick currently defaults to one second, so these translate + directly to seconds currently, but this is NOT guaranteed. + type: "integer" + example: 3 + HeartbeatTick: + description: | + The number of ticks between heartbeats. Every HeartbeatTick ticks, + the leader will send a heartbeat to the followers. + + A tick currently defaults to one second, so these translate + directly to seconds currently, but this is NOT guaranteed. + type: "integer" + example: 1 + Dispatcher: + description: "Dispatcher configuration." + type: "object" + x-nullable: true + properties: + HeartbeatPeriod: + description: | + The delay for an agent to send a heartbeat to the dispatcher. + type: "integer" + format: "int64" + example: 5000000000 + CAConfig: + description: "CA configuration." + type: "object" + x-nullable: true + properties: + NodeCertExpiry: + description: "The duration node certificates are issued for." + type: "integer" + format: "int64" + example: 7776000000000000 + ExternalCAs: + description: | + Configuration for forwarding signing requests to an external + certificate authority. + type: "array" + items: + type: "object" + properties: + Protocol: + description: | + Protocol for communication with the external CA (currently + only `cfssl` is supported). + type: "string" + enum: + - "cfssl" + default: "cfssl" + URL: + description: | + URL where certificate signing requests should be sent. + type: "string" + Options: + description: | + An object with key/value pairs that are interpreted as + protocol-specific options for the external CA driver. + type: "object" + additionalProperties: + type: "string" + CACert: + description: | + The root CA certificate (in PEM format) this external CA uses + to issue TLS certificates (assumed to be to the current swarm + root CA certificate if not provided). + type: "string" + SigningCACert: + description: | + The desired signing CA certificate for all swarm node TLS leaf + certificates, in PEM format. + type: "string" + SigningCAKey: + description: | + The desired signing CA key for all swarm node TLS leaf certificates, + in PEM format. + type: "string" + ForceRotate: + description: | + An integer whose purpose is to force swarm to generate a new + signing CA certificate and key, if none have been specified in + `SigningCACert` and `SigningCAKey` + format: "uint64" + type: "integer" + EncryptionConfig: + description: "Parameters related to encryption-at-rest." + type: "object" + properties: + AutoLockManagers: + description: | + If set, generate a key and use it to lock data stored on the + managers. + type: "boolean" + example: false + TaskDefaults: + description: "Defaults for creating tasks in this cluster." + type: "object" + properties: + LogDriver: + description: | + The log driver to use for tasks created in the orchestrator if + unspecified by a service. + + Updating this value only affects new tasks. Existing tasks continue + to use their previously configured log driver until recreated. + type: "object" + properties: + Name: + description: | + The log driver to use as a default for new tasks. + type: "string" + example: "json-file" + Options: + description: | + Driver-specific options for the selected log driver, specified + as key/value pairs. + type: "object" + additionalProperties: + type: "string" + example: + "max-file": "10" + "max-size": "100m" + + # The Swarm information for `GET /info`. It is the same as `GET /swarm`, but + # without `JoinTokens`. + ClusterInfo: + description: | + ClusterInfo represents information about the swarm as is returned by the + "/info" endpoint. Join-tokens are not included. + x-nullable: true + type: "object" + properties: + ID: + description: "The ID of the swarm." + type: "string" + example: "abajmipo7b4xz5ip2nrla6b11" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + description: | + Date and time at which the swarm was initialised in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2016-08-18T10:44:24.496525531Z" + UpdatedAt: + description: | + Date and time at which the swarm was last updated in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + example: "2017-08-09T07:09:37.632105588Z" + Spec: + $ref: "#/definitions/SwarmSpec" + TLSInfo: + $ref: "#/definitions/TLSInfo" + RootRotationInProgress: + description: | + Whether there is currently a root CA rotation in progress for the swarm + type: "boolean" + example: false + DataPathPort: + description: | + 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, the default port (4789) is used. + type: "integer" + format: "uint32" + default: 4789 + example: 4789 + DefaultAddrPool: + description: | + Default Address Pool specifies default subnet pools for global scope + networks. + type: "array" + items: + type: "string" + format: "CIDR" + example: ["10.10.0.0/16", "20.20.0.0/16"] + SubnetSize: + description: | + SubnetSize specifies the subnet size of the networks created from the + default subnet pool. + type: "integer" + format: "uint32" + maximum: 29 + default: 24 + example: 24 + + JoinTokens: + description: | + JoinTokens contains the tokens workers and managers need to join the swarm. + type: "object" + properties: + Worker: + description: | + The token workers can use to join the swarm. + type: "string" + example: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx" + Manager: + description: | + The token managers can use to join the swarm. + type: "string" + example: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" + + Swarm: + type: "object" + allOf: + - $ref: "#/definitions/ClusterInfo" + - type: "object" + properties: + JoinTokens: + $ref: "#/definitions/JoinTokens" + + TaskSpec: + description: "User modifiable task configuration." + type: "object" + properties: + PluginSpec: + type: "object" + description: | + Plugin spec for the service. *(Experimental release only.)* + +


+ + > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are + > mutually exclusive. PluginSpec is only used when the Runtime field + > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime + > field is set to `attachment`. + properties: + Name: + description: "The name or 'alias' to use for the plugin." + type: "string" + Remote: + description: "The plugin image reference to use." + type: "string" + Disabled: + description: "Disable the plugin once scheduled." + type: "boolean" + PluginPrivilege: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + ContainerSpec: + type: "object" + description: | + Container spec for the service. + +


+ + > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are + > mutually exclusive. PluginSpec is only used when the Runtime field + > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime + > field is set to `attachment`. + properties: + Image: + description: "The image name to use for the container" + type: "string" + Labels: + description: "User-defined key/value data." + type: "object" + additionalProperties: + type: "string" + Command: + description: "The command to be run in the image." + type: "array" + items: + type: "string" + Args: + description: "Arguments to the command." + type: "array" + items: + type: "string" + Hostname: + description: | + The hostname to use for the container, as a valid + [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. + type: "string" + Env: + description: | + A list of environment variables in the form `VAR=value`. + type: "array" + items: + type: "string" + Dir: + description: "The working directory for commands to run in." + type: "string" + User: + description: "The user inside the container." + type: "string" + Groups: + type: "array" + description: | + A list of additional groups that the container process will run as. + items: + type: "string" + Privileges: + type: "object" + description: "Security options for the container" + properties: + CredentialSpec: + type: "object" + description: "CredentialSpec for managed service account (Windows only)" + properties: + Config: + type: "string" + example: "0bt9dmxjvjiqermk6xrop3ekq" + description: | + Load credential spec from a Swarm Config with the given ID. + The specified config must also be present in the Configs + field with the Runtime property set. + +


+ + + > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, + > and `CredentialSpec.Config` are mutually exclusive. + File: + type: "string" + example: "spec.json" + description: | + Load credential spec from this file. The file is read by + the daemon, and must be present in the `CredentialSpecs` + subdirectory in the docker data directory, which defaults + to `C:\ProgramData\Docker\` on Windows. + + For example, specifying `spec.json` loads + `C:\ProgramData\Docker\CredentialSpecs\spec.json`. + +


+ + > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, + > and `CredentialSpec.Config` are mutually exclusive. + Registry: + type: "string" + description: | + Load credential spec from this value in the Windows + registry. The specified registry value must be located in: + + `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs` + +


+ + + > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, + > and `CredentialSpec.Config` are mutually exclusive. + SELinuxContext: + type: "object" + description: "SELinux labels of the container" + properties: + Disable: + type: "boolean" + description: "Disable SELinux" + User: + type: "string" + description: "SELinux user label" + Role: + type: "string" + description: "SELinux role label" + Type: + type: "string" + description: "SELinux type label" + Level: + type: "string" + description: "SELinux level label" + Seccomp: + type: "object" + description: "Options for configuring seccomp on the container" + properties: + Mode: + type: "string" + enum: + - "default" + - "unconfined" + - "custom" + Profile: + description: "The custom seccomp profile as a json object" + type: "string" + AppArmor: + type: "object" + description: "Options for configuring AppArmor on the container" + properties: + Mode: + type: "string" + enum: + - "default" + - "disabled" + NoNewPrivileges: + type: "boolean" + description: "Configuration of the no_new_privs bit in the container" + + TTY: + description: "Whether a pseudo-TTY should be allocated." + type: "boolean" + OpenStdin: + description: "Open `stdin`" + type: "boolean" + ReadOnly: + description: "Mount the container's root filesystem as read only." + type: "boolean" + Mounts: + description: | + Specification for mounts to be added to containers created as part + of the service. + type: "array" + items: + $ref: "#/definitions/Mount" + StopSignal: + description: "Signal to stop the container." + type: "string" + StopGracePeriod: + description: | + Amount of time to wait for the container to terminate before + forcefully killing it. + type: "integer" + format: "int64" + HealthCheck: + $ref: "#/definitions/HealthConfig" + Hosts: + type: "array" + description: | + A list of hostname/IP mappings to add to the container's `hosts` + file. The format of extra hosts is specified in the + [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) + man page: + + IP_address canonical_hostname [aliases] + items: + type: "string" + DNSConfig: + description: | + Specification for DNS related configurations in resolver configuration + file (`resolv.conf`). + type: "object" + properties: + Nameservers: + description: "The IP addresses of the name servers." + type: "array" + items: + type: "string" + Search: + description: "A search list for host-name lookup." + type: "array" + items: + type: "string" + Options: + description: | + A list of internal resolver variables to be modified (e.g., + `debug`, `ndots:3`, etc.). + type: "array" + items: + type: "string" + Secrets: + description: | + Secrets contains references to zero or more secrets that will be + exposed to the service. + type: "array" + items: + type: "object" + properties: + File: + description: | + File represents a specific target that is backed by a file. + type: "object" + properties: + Name: + description: | + Name represents the final filename in the filesystem. + type: "string" + UID: + description: "UID represents the file UID." + type: "string" + GID: + description: "GID represents the file GID." + type: "string" + Mode: + description: "Mode represents the FileMode of the file." + type: "integer" + format: "uint32" + SecretID: + description: | + SecretID represents the ID of the specific secret that we're + referencing. + type: "string" + SecretName: + description: | + SecretName is the name of the secret that this references, + but this is just provided for lookup/display purposes. The + secret in the reference will be identified by its ID. + type: "string" + OomScoreAdj: + type: "integer" + format: "int64" + description: | + An integer value containing the score given to the container in + order to tune OOM killer preferences. + example: 0 + Configs: + description: | + Configs contains references to zero or more configs that will be + exposed to the service. + type: "array" + items: + type: "object" + properties: + File: + description: | + File represents a specific target that is backed by a file. + +


+ + > **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive + type: "object" + properties: + Name: + description: | + Name represents the final filename in the filesystem. + type: "string" + UID: + description: "UID represents the file UID." + type: "string" + GID: + description: "GID represents the file GID." + type: "string" + Mode: + description: "Mode represents the FileMode of the file." + type: "integer" + format: "uint32" + Runtime: + description: | + Runtime represents a target that is not mounted into the + container but is used by the task + +


+ + > **Note**: `Configs.File` and `Configs.Runtime` are mutually + > exclusive + type: "object" + ConfigID: + description: | + ConfigID represents the ID of the specific config that we're + referencing. + type: "string" + ConfigName: + description: | + ConfigName is the name of the config that this references, + but this is just provided for lookup/display purposes. The + config in the reference will be identified by its ID. + type: "string" + Isolation: + type: "string" + description: | + Isolation technology of the containers running the service. + (Windows only) + enum: + - "default" + - "process" + - "hyperv" + - "" + Init: + description: | + Run an init inside the container that forwards signals and reaps + processes. This field is omitted if empty, and the default (as + configured on the daemon) is used. + type: "boolean" + x-nullable: true + Sysctls: + description: | + Set kernel namedspaced parameters (sysctls) in the container. + The Sysctls option on services accepts the same sysctls as the + are supported on containers. Note that while the same sysctls are + supported, no guarantees or checks are made about their + suitability for a clustered environment, and it's up to the user + to determine whether a given sysctl will work properly in a + Service. + type: "object" + additionalProperties: + type: "string" + # This option is not used by Windows containers + CapabilityAdd: + type: "array" + description: | + A list of kernel capabilities to add to the default set + for the container. + items: + type: "string" + example: + - "CAP_NET_RAW" + - "CAP_SYS_ADMIN" + - "CAP_SYS_CHROOT" + - "CAP_SYSLOG" + CapabilityDrop: + type: "array" + description: | + A list of kernel capabilities to drop from the default set + for the container. + items: + type: "string" + example: + - "CAP_NET_RAW" + Ulimits: + description: | + A list of resource limits to set in the container. For example: `{"Name": "nofile", "Soft": 1024, "Hard": 2048}`" + type: "array" + items: + type: "object" + properties: + Name: + description: "Name of ulimit" + type: "string" + Soft: + description: "Soft limit" + type: "integer" + Hard: + description: "Hard limit" + type: "integer" + NetworkAttachmentSpec: + description: | + Read-only spec type for non-swarm containers attached to swarm overlay + networks. + +


+ + > **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are + > mutually exclusive. PluginSpec is only used when the Runtime field + > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime + > field is set to `attachment`. + type: "object" + properties: + ContainerID: + description: "ID of the container represented by this task" + type: "string" + Resources: + description: | + Resource requirements which apply to each individual container created + as part of the service. + type: "object" + properties: + Limits: + description: "Define resources limits." + $ref: "#/definitions/Limit" + Reservations: + description: "Define resources reservation." + $ref: "#/definitions/ResourceObject" + SwapBytes: + description: | + Amount of swap in bytes - can only be used together with a memory limit. + If not specified, the default behaviour is to grant a swap space twice + as big as the memory limit. + Set to -1 to enable unlimited swap. + type: "integer" + format: "int64" + minimum: -1 + x-nullable: true + x-omitempty: true + MemorySwappiness: + description: | + Tune the service's containers' memory swappiness (0 to 100). + If not specified, defaults to the containers' OS' default, generally 60, + or whatever value was predefined in the image. + Set to -1 to unset a previously set value. + type: "integer" + format: "int64" + minimum: -1 + maximum: 100 + x-nullable: true + x-omitempty: true + RestartPolicy: + description: | + Specification for the restart policy which applies to containers + created as part of this service. + type: "object" + properties: + Condition: + description: "Condition for restart." + type: "string" + enum: + - "none" + - "on-failure" + - "any" + Delay: + description: "Delay between restart attempts." + type: "integer" + format: "int64" + MaxAttempts: + description: | + Maximum attempts to restart a given container before giving up + (default value is 0, which is ignored). + type: "integer" + format: "int64" + default: 0 + Window: + description: | + Windows is the time window used to evaluate the restart policy + (default value is 0, which is unbounded). + type: "integer" + format: "int64" + default: 0 + Placement: + type: "object" + properties: + Constraints: + description: | + An array of constraint expressions to limit the set of nodes where + a task can be scheduled. Constraint expressions can either use a + _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find + nodes that satisfy every expression (AND match). Constraints can + match node or Docker Engine labels as follows: + + node attribute | matches | example + ---------------------|--------------------------------|----------------------------------------------- + `node.id` | Node ID | `node.id==2ivku8v2gvtg4` + `node.hostname` | Node hostname | `node.hostname!=node-2` + `node.role` | Node role (`manager`/`worker`) | `node.role==manager` + `node.platform.os` | Node operating system | `node.platform.os==windows` + `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` + `node.labels` | User-defined node labels | `node.labels.security==high` + `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-24.04` + + `engine.labels` apply to Docker Engine labels like operating system, + drivers, etc. Swarm administrators add `node.labels` for operational + purposes by using the [`node update endpoint`](#operation/NodeUpdate). + + type: "array" + items: + type: "string" + example: + - "node.hostname!=node3.corp.example.com" + - "node.role!=manager" + - "node.labels.type==production" + - "node.platform.os==linux" + - "node.platform.arch==x86_64" + Preferences: + description: | + Preferences provide a way to make the scheduler aware of factors + such as topology. They are provided in order from highest to + lowest precedence. + type: "array" + items: + type: "object" + properties: + Spread: + type: "object" + properties: + SpreadDescriptor: + description: | + label descriptor, such as `engine.labels.az`. + type: "string" + example: + - Spread: + SpreadDescriptor: "node.labels.datacenter" + - Spread: + SpreadDescriptor: "node.labels.rack" + MaxReplicas: + description: | + Maximum number of replicas for per node (default value is 0, which + is unlimited) + type: "integer" + format: "int64" + default: 0 + Platforms: + description: | + Platforms stores all the platforms that the service's image can + run on. This field is used in the platform filter for scheduling. + If empty, then the platform filter is off, meaning there are no + scheduling restrictions. + type: "array" + items: + $ref: "#/definitions/Platform" + ForceUpdate: + description: | + A counter that triggers an update even if no relevant parameters have + been changed. + type: "integer" + format: "uint64" + Runtime: + description: | + Runtime is the type of runtime specified for the task executor. + type: "string" + Networks: + description: "Specifies which networks the service should attach to." + type: "array" + items: + $ref: "#/definitions/NetworkAttachmentConfig" + LogDriver: + description: | + Specifies the log driver to use for tasks created from this spec. If + not present, the default one for the swarm will be used, finally + falling back to the engine default if not specified. + type: "object" + properties: + Name: + type: "string" + Options: + type: "object" + additionalProperties: + type: "string" + + TaskState: + type: "string" + enum: + - "new" + - "allocated" + - "pending" + - "assigned" + - "accepted" + - "preparing" + - "ready" + - "starting" + - "running" + - "complete" + - "shutdown" + - "failed" + - "rejected" + - "remove" + - "orphaned" + + ContainerStatus: + type: "object" + description: "represents the status of a container." + properties: + ContainerID: + type: "string" + PID: + type: "integer" + ExitCode: + type: "integer" + + PortStatus: + type: "object" + description: "represents the port status of a task's host ports whose service has published host ports" + properties: + Ports: + type: "array" + items: + $ref: "#/definitions/EndpointPortConfig" + + TaskStatus: + type: "object" + description: "represents the status of a task." + properties: + Timestamp: + type: "string" + format: "dateTime" + State: + $ref: "#/definitions/TaskState" + Message: + type: "string" + Err: + type: "string" + ContainerStatus: + $ref: "#/definitions/ContainerStatus" + PortStatus: + $ref: "#/definitions/PortStatus" + + Task: + type: "object" + properties: + ID: + description: "The ID of the task." + type: "string" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Name: + description: "Name of the task." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + Spec: + $ref: "#/definitions/TaskSpec" + ServiceID: + description: "The ID of the service this task is part of." + type: "string" + Slot: + type: "integer" + NodeID: + description: "The ID of the node that this task is on." + type: "string" + AssignedGenericResources: + $ref: "#/definitions/GenericResources" + Status: + $ref: "#/definitions/TaskStatus" + DesiredState: + $ref: "#/definitions/TaskState" + JobIteration: + description: | + If the Service this Task belongs to is a job-mode service, contains + the JobIteration of the Service this Task was created for. Absent if + the Task was created for a Replicated or Global Service. + $ref: "#/definitions/ObjectVersion" + example: + ID: "0kzzo1i0y4jz6027t0k7aezc7" + Version: + Index: 71 + CreatedAt: "2016-06-07T21:07:31.171892745Z" + UpdatedAt: "2016-06-07T21:07:31.376370513Z" + Spec: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Slot: 1 + NodeID: "60gvrl6tm78dmak4yl7srz94v" + Status: + Timestamp: "2016-06-07T21:07:31.290032978Z" + State: "running" + Message: "started" + ContainerStatus: + ContainerID: "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035" + PID: 677 + DesiredState: "running" + NetworksAttachments: + - Network: + ID: "4qvuz4ko70xaltuqbt8956gd1" + Version: + Index: 18 + CreatedAt: "2016-06-07T20:31:11.912919752Z" + UpdatedAt: "2016-06-07T21:07:29.955277358Z" + Spec: + Name: "ingress" + Labels: + com.docker.swarm.internal: "true" + DriverConfiguration: {} + IPAMOptions: + Driver: {} + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + DriverState: + Name: "overlay" + Options: + com.docker.network.driver.overlay.vxlanid_list: "256" + IPAMOptions: + Driver: + Name: "default" + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + Addresses: + - "10.255.0.10/16" + AssignedGenericResources: + - DiscreteResourceSpec: + Kind: "SSD" + Value: 3 + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID1" + - NamedResourceSpec: + Kind: "GPU" + Value: "UUID2" + + ServiceSpec: + description: "User modifiable configuration for a service." + type: object + properties: + Name: + description: "Name of the service." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + TaskTemplate: + $ref: "#/definitions/TaskSpec" + Mode: + description: "Scheduling mode for the service." + type: "object" + properties: + Replicated: + type: "object" + properties: + Replicas: + type: "integer" + format: "int64" + Global: + type: "object" + ReplicatedJob: + description: | + The mode used for services with a finite number of tasks that run + to a completed state. + type: "object" + properties: + MaxConcurrent: + description: | + The maximum number of replicas to run simultaneously. + type: "integer" + format: "int64" + default: 1 + TotalCompletions: + description: | + The total number of replicas desired to reach the Completed + state. If unset, will default to the value of `MaxConcurrent` + type: "integer" + format: "int64" + GlobalJob: + description: | + The mode used for services which run a task to the completed state + on each valid node. + type: "object" + UpdateConfig: + description: "Specification for the update strategy of the service." + type: "object" + properties: + Parallelism: + description: | + Maximum number of tasks to be updated in one iteration (0 means + unlimited parallelism). + type: "integer" + format: "int64" + Delay: + description: "Amount of time between updates, in nanoseconds." + type: "integer" + format: "int64" + FailureAction: + description: | + Action to take if an updated task fails to run, or stops running + during the update. + type: "string" + enum: + - "continue" + - "pause" + - "rollback" + Monitor: + description: | + Amount of time to monitor each updated task for failures, in + nanoseconds. + type: "integer" + format: "int64" + MaxFailureRatio: + description: | + The fraction of tasks that may fail during an update before the + failure action is invoked, specified as a floating point number + between 0 and 1. + type: "number" + default: 0 + Order: + description: | + The order of operations when rolling out an updated task. Either + the old task is shut down before the new task is started, or the + new task is started before the old task is shut down. + type: "string" + enum: + - "stop-first" + - "start-first" + RollbackConfig: + description: "Specification for the rollback strategy of the service." + type: "object" + properties: + Parallelism: + description: | + Maximum number of tasks to be rolled back in one iteration (0 means + unlimited parallelism). + type: "integer" + format: "int64" + Delay: + description: | + Amount of time between rollback iterations, in nanoseconds. + type: "integer" + format: "int64" + FailureAction: + description: | + Action to take if an rolled back task fails to run, or stops + running during the rollback. + type: "string" + enum: + - "continue" + - "pause" + Monitor: + description: | + Amount of time to monitor each rolled back task for failures, in + nanoseconds. + type: "integer" + format: "int64" + MaxFailureRatio: + description: | + The fraction of tasks that may fail during a rollback before the + failure action is invoked, specified as a floating point number + between 0 and 1. + type: "number" + default: 0 + Order: + description: | + The order of operations when rolling back a task. Either the old + task is shut down before the new task is started, or the new task + is started before the old task is shut down. + type: "string" + enum: + - "stop-first" + - "start-first" + Networks: + description: | + Specifies which networks the service should attach to. + + Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + type: "array" + items: + $ref: "#/definitions/NetworkAttachmentConfig" + + EndpointSpec: + $ref: "#/definitions/EndpointSpec" + + EndpointPortConfig: + type: "object" + properties: + Name: + type: "string" + Protocol: + type: "string" + enum: + - "tcp" + - "udp" + - "sctp" + TargetPort: + description: "The port inside the container." + type: "integer" + PublishedPort: + description: "The port on the swarm hosts." + type: "integer" + PublishMode: + description: | + The mode in which port is published. + +


+ + - "ingress" makes the target port accessible on every node, + regardless of whether there is a task for the service running on + that node or not. + - "host" bypasses the routing mesh and publish the port directly on + the swarm node where that service is running. + + type: "string" + enum: + - "ingress" + - "host" + default: "ingress" + example: "ingress" + + EndpointSpec: + description: "Properties that can be configured to access and load balance a service." + type: "object" + properties: + Mode: + description: | + The mode of resolution to use for internal load balancing between tasks. + type: "string" + enum: + - "vip" + - "dnsrr" + default: "vip" + Ports: + description: | + List of exposed ports that this service is accessible on from the + outside. Ports can only be provided if `vip` resolution mode is used. + type: "array" + items: + $ref: "#/definitions/EndpointPortConfig" + + Service: + type: "object" + properties: + ID: + type: "string" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Spec: + $ref: "#/definitions/ServiceSpec" + Endpoint: + type: "object" + properties: + Spec: + $ref: "#/definitions/EndpointSpec" + Ports: + type: "array" + items: + $ref: "#/definitions/EndpointPortConfig" + VirtualIPs: + type: "array" + items: + type: "object" + properties: + NetworkID: + type: "string" + Addr: + type: "string" + UpdateStatus: + description: "The status of a service update." + type: "object" + properties: + State: + type: "string" + enum: + - "updating" + - "paused" + - "completed" + StartedAt: + type: "string" + format: "dateTime" + CompletedAt: + type: "string" + format: "dateTime" + Message: + type: "string" + ServiceStatus: + description: | + The status of the service's tasks. Provided only when requested as + part of a ServiceList operation. + type: "object" + properties: + RunningTasks: + description: | + The number of tasks for the service currently in the Running state. + type: "integer" + format: "uint64" + example: 7 + DesiredTasks: + description: | + The number of tasks for the service desired to be running. + For replicated services, this is the replica count from the + service spec. For global services, this is computed by taking + count of all tasks for the service with a Desired State other + than Shutdown. + type: "integer" + format: "uint64" + example: 10 + CompletedTasks: + description: | + The number of tasks for a job that are in the Completed state. + This field must be cross-referenced with the service type, as the + value of 0 may mean the service is not in a job mode, or it may + mean the job-mode service has no tasks yet Completed. + type: "integer" + format: "uint64" + JobStatus: + description: | + The status of the service when it is in one of ReplicatedJob or + GlobalJob modes. Absent on Replicated and Global mode services. The + JobIteration is an ObjectVersion, but unlike the Service's version, + does not need to be sent with an update request. + type: "object" + properties: + JobIteration: + description: | + JobIteration is a value increased each time a Job is executed, + successfully or otherwise. "Executed", in this case, means the + job as a whole has been started, not that an individual Task has + been launched. A job is "Executed" when its ServiceSpec is + updated. JobIteration can be used to disambiguate Tasks belonging + to different executions of a job. Though JobIteration will + increase with each subsequent execution, it may not necessarily + increase by 1, and so JobIteration should not be used to + $ref: "#/definitions/ObjectVersion" + LastExecution: + description: | + The last time, as observed by the server, that this job was + started. + type: "string" + format: "dateTime" + example: + ID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Version: + Index: 19 + CreatedAt: "2016-06-07T21:05:51.880065305Z" + UpdatedAt: "2016-06-07T21:07:29.962229872Z" + Spec: + Name: "hopeful_cori" + TaskTemplate: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ForceUpdate: 0 + Mode: + Replicated: + Replicas: 1 + UpdateConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + RollbackConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + EndpointSpec: + Mode: "vip" + Ports: + - + Protocol: "tcp" + TargetPort: 6379 + PublishedPort: 30001 + Endpoint: + Spec: + Mode: "vip" + Ports: + - + Protocol: "tcp" + TargetPort: 6379 + PublishedPort: 30001 + Ports: + - + Protocol: "tcp" + TargetPort: 6379 + PublishedPort: 30001 + VirtualIPs: + - + NetworkID: "4qvuz4ko70xaltuqbt8956gd1" + Addr: "10.255.0.2/16" + - + NetworkID: "4qvuz4ko70xaltuqbt8956gd1" + Addr: "10.255.0.3/16" + + ImageDeleteResponseItem: + type: "object" + x-go-name: "DeleteResponse" + properties: + Untagged: + description: "The image ID of an image that was untagged" + type: "string" + Deleted: + description: "The image ID of an image that was deleted" + type: "string" + + ServiceCreateResponse: + type: "object" + description: | + contains the information returned to a client on the + creation of a new service. + properties: + ID: + description: "The ID of the created service." + type: "string" + x-nullable: false + example: "ak7w3gjqoa3kuz8xcpnyy0pvl" + Warnings: + description: | + Optional warning message. + + FIXME(thaJeztah): this should have "omitempty" in the generated type. + type: "array" + x-nullable: true + items: + type: "string" + example: + - "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" + + ServiceUpdateResponse: + type: "object" + properties: + Warnings: + description: "Optional warning messages" + type: "array" + items: + type: "string" + example: + Warnings: + - "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found" + + ContainerInspectResponse: + type: "object" + title: "ContainerInspectResponse" + x-go-name: "InspectResponse" + properties: + Id: + description: |- + The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). + type: "string" + x-go-name: "ID" + minLength: 64 + maxLength: 64 + pattern: "^[0-9a-fA-F]{64}$" + example: "aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf" + Created: + description: |- + Date and time at which the container was created, formatted in + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + type: "string" + format: "dateTime" + x-nullable: true + example: "2025-02-17T17:43:39.64001363Z" + Path: + description: |- + The path to the command being run + type: "string" + example: "/bin/sh" + Args: + description: "The arguments to the command being run" + type: "array" + items: + type: "string" + example: + - "-c" + - "exit 9" + State: + $ref: "#/definitions/ContainerState" + Image: + description: |- + The ID (digest) of the image that this container was created from. + type: "string" + example: "sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782" + ResolvConfPath: + description: |- + Location of the `/etc/resolv.conf` generated for the container on the + host. + + This file is managed through the docker daemon, and should not be + accessed or modified by other tools. + type: "string" + example: "/var/lib/docker/containers/aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf/resolv.conf" + HostnamePath: + description: |- + Location of the `/etc/hostname` generated for the container on the + host. + + This file is managed through the docker daemon, and should not be + accessed or modified by other tools. + type: "string" + example: "/var/lib/docker/containers/aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf/hostname" + HostsPath: + description: |- + Location of the `/etc/hosts` generated for the container on the + host. + + This file is managed through the docker daemon, and should not be + accessed or modified by other tools. + type: "string" + example: "/var/lib/docker/containers/aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf/hosts" + LogPath: + description: |- + Location of the file used to buffer the container's logs. Depending on + the logging-driver used for the container, this field may be omitted. + + This file is managed through the docker daemon, and should not be + accessed or modified by other tools. + type: "string" + x-nullable: true + example: "/var/lib/docker/containers/5b7c7e2b992aa426584ce6c47452756066be0e503a08b4516a433a54d2f69e59/5b7c7e2b992aa426584ce6c47452756066be0e503a08b4516a433a54d2f69e59-json.log" + Name: + description: |- + The name associated with this container. + + For historic reasons, the name may be prefixed with a forward-slash (`/`). + type: "string" + example: "/funny_chatelet" + RestartCount: + description: |- + Number of times the container was restarted since it was created, + or since daemon was started. + type: "integer" + example: 0 + Driver: + description: |- + The storage-driver used for the container's filesystem (graph-driver + or snapshotter). + type: "string" + example: "overlayfs" + Platform: + description: |- + The platform (operating system) for which the container was created. + + This field was introduced for the experimental "LCOW" (Linux Containers + On Windows) features, which has been removed. In most cases, this field + is equal to the host's operating system (`linux` or `windows`). + type: "string" + example: "linux" + ImageManifestDescriptor: + $ref: "#/definitions/OCIDescriptor" + description: |- + OCI descriptor of the platform-specific manifest of the image + the container was created from. + + Note: Only available if the daemon provides a multi-platform + image store. + MountLabel: + description: |- + SELinux mount label set for the container. + type: "string" + example: "" + ProcessLabel: + description: |- + SELinux process label set for the container. + type: "string" + example: "" + AppArmorProfile: + description: |- + The AppArmor profile set for the container. + type: "string" + example: "" + ExecIDs: + description: |- + IDs of exec instances that are running in the container. + type: "array" + items: + type: "string" + x-nullable: true + example: + - "b35395de42bc8abd327f9dd65d913b9ba28c74d2f0734eeeae84fa1c616a0fca" + - "3fc1232e5cd20c8de182ed81178503dc6437f4e7ef12b52cc5e8de020652f1c4" + HostConfig: + $ref: "#/definitions/HostConfig" + GraphDriver: + $ref: "#/definitions/DriverData" + x-nullable: true + Storage: + $ref: "#/definitions/Storage" + x-nullable: true + SizeRw: + description: |- + The size of files that have been created or changed by this container. + + This field is omitted by default, and only set when size is requested + in the API request. + type: "integer" + format: "int64" + x-nullable: true + example: "122880" + SizeRootFs: + description: |- + The total size of all files in the read-only layers from the image + that the container uses. These layers can be shared between containers. + + This field is omitted by default, and only set when size is requested + in the API request. + type: "integer" + format: "int64" + x-nullable: true + example: "1653948416" + Mounts: + description: |- + List of mounts used by the container. + type: "array" + items: + $ref: "#/definitions/MountPoint" + Config: + $ref: "#/definitions/ContainerConfig" + NetworkSettings: + $ref: "#/definitions/NetworkSettings" + + ContainerSummary: + type: "object" + properties: + Id: + description: |- + The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). + type: "string" + x-go-name: "ID" + minLength: 64 + maxLength: 64 + pattern: "^[0-9a-fA-F]{64}$" + example: "aa86eacfb3b3ed4cd362c1e88fc89a53908ad05fb3a4103bca3f9b28292d14bf" + Names: + description: |- + The names associated with this container. Most containers have a single + name, but when using legacy "links", the container can have multiple + names. + + For historic reasons, names are prefixed with a forward-slash (`/`). + type: "array" + items: + type: "string" + example: + - "/funny_chatelet" + Image: + description: |- + The name or ID of the image used to create the container. + + This field shows the image reference as was specified when creating the container, + which can be in its canonical form (e.g., `docker.io/library/ubuntu:latest` + or `docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`), + short form (e.g., `ubuntu:latest`)), or the ID(-prefix) of the image (e.g., `72297848456d`). + + The content of this field can be updated at runtime if the image used to + create the container is untagged, in which case the field is updated to + contain the the image ID (digest) it was resolved to in its canonical, + non-truncated form (e.g., `sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`). + type: "string" + example: "docker.io/library/ubuntu:latest" + ImageID: + description: |- + The ID (digest) of the image that this container was created from. + type: "string" + example: "sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782" + ImageManifestDescriptor: + $ref: "#/definitions/OCIDescriptor" + x-nullable: true + description: | + OCI descriptor of the platform-specific manifest of the image + the container was created from. + + Note: Only available if the daemon provides a multi-platform + image store. + + This field is not populated in the `GET /system/df` endpoint. + Command: + description: "Command to run when starting the container" + type: "string" + example: "/bin/bash" + Created: + description: |- + Date and time at which the container was created as a Unix timestamp + (number of seconds since EPOCH). + type: "integer" + format: "int64" + example: "1739811096" + Ports: + description: |- + Port-mappings for the container. + type: "array" + items: + $ref: "#/definitions/PortSummary" + SizeRw: + description: |- + The size of files that have been created or changed by this container. + + This field is omitted by default, and only set when size is requested + in the API request. + type: "integer" + format: "int64" + x-nullable: true + example: "122880" + SizeRootFs: + description: |- + The total size of all files in the read-only layers from the image + that the container uses. These layers can be shared between containers. + + This field is omitted by default, and only set when size is requested + in the API request. + type: "integer" + format: "int64" + x-nullable: true + example: "1653948416" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.vendor: "Acme" + com.example.license: "GPL" + com.example.version: "1.0" + State: + description: | + The state of this container. + type: "string" + enum: + - "created" + - "running" + - "paused" + - "restarting" + - "exited" + - "removing" + - "dead" + example: "running" + Status: + description: |- + Additional human-readable status of this container (e.g. `Exit 0`) + type: "string" + example: "Up 4 days" + HostConfig: + type: "object" + description: |- + Summary of host-specific runtime information of the container. This + is a reduced set of information in the container's "HostConfig" as + available in the container "inspect" response. + properties: + NetworkMode: + description: |- + Networking mode (`host`, `none`, `container:`) or name of the + primary network the container is using. + + This field is primarily for backward compatibility. The container + can be connected to multiple networks for which information can be + found in the `NetworkSettings.Networks` field, which enumerates + settings per network. + type: "string" + example: "mynetwork" + Annotations: + description: |- + Arbitrary key-value metadata attached to the container. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + io.kubernetes.docker.type: "container" + io.kubernetes.sandbox.id: "3befe639bed0fd6afdd65fd1fa84506756f59360ec4adc270b0fdac9be22b4d3" + NetworkSettings: + description: |- + Summary of the container's network settings + type: "object" + properties: + Networks: + type: "object" + description: |- + Summary of network-settings for each network the container is + attached to. + additionalProperties: + $ref: "#/definitions/EndpointSettings" + Mounts: + type: "array" + description: |- + List of mounts used by the container. + items: + $ref: "#/definitions/MountPoint" + Health: + type: "object" + description: |- + Summary of health status + + Added in v1.52, before that version all container summary not include Health. + After this attribute introduced, it includes containers with no health checks configured, + or containers that are not running with none + properties: + Status: + type: "string" + description: |- + the health status of the container + enum: + - "none" + - "starting" + - "healthy" + - "unhealthy" + example: "healthy" + FailingStreak: + description: "FailingStreak is the number of consecutive failures" + type: "integer" + example: 0 + + ContainersDiskUsage: + type: "object" + x-go-name: "DiskUsage" + x-go-package: "github.com/moby/moby/api/types/container" + description: | + represents system data usage information for container resources. + properties: + ActiveCount: + description: | + Count of active containers. + type: "integer" + format: "int64" + example: 1 + TotalCount: + description: | + Count of all containers. + type: "integer" + format: "int64" + example: 4 + Reclaimable: + description: | + Disk space that can be reclaimed by removing inactive containers. + type: "integer" + format: "int64" + example: 12345678 + TotalSize: + description: | + Disk space in use by containers. + type: "integer" + format: "int64" + example: 98765432 + Items: + description: | + List of container summaries. + type: "array" + x-omitempty: true + items: + x-go-type: + type: Summary + + Driver: + description: "Driver represents a driver (network, logging, secrets)." + type: "object" + required: [Name] + properties: + Name: + description: "Name of the driver." + type: "string" + x-nullable: false + example: "some-driver" + Options: + description: "Key/value map of driver-specific options." + type: "object" + x-nullable: false + additionalProperties: + type: "string" + example: + OptionA: "value for driver-specific option A" + OptionB: "value for driver-specific option B" + + SecretSpec: + type: "object" + properties: + Name: + description: "User-defined name of the secret." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + Data: + description: | + Data is the data to store as a secret, formatted as a Base64-url-safe-encoded + ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. + It must be empty if the Driver field is set, in which case the data is + loaded from an external secret store. The maximum allowed size is 500KB, + as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). + + This field is only used to _create_ a secret, and is not returned by + other endpoints. + type: "string" + example: "" + Driver: + description: | + Name of the secrets driver used to fetch the secret's value from an + external secret store. + $ref: "#/definitions/Driver" + Templating: + description: | + Templating driver, if applicable + + Templating controls whether and how to evaluate the config payload as + a template. If no driver is set, no templating is used. + $ref: "#/definitions/Driver" + + Secret: + type: "object" + properties: + ID: + type: "string" + example: "blt1owaxmitz71s9v5zh81zun" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + example: "2017-07-20T13:55:28.678958722Z" + UpdatedAt: + type: "string" + format: "dateTime" + example: "2017-07-20T13:55:28.678958722Z" + Spec: + $ref: "#/definitions/SecretSpec" + + ConfigSpec: + type: "object" + properties: + Name: + description: "User-defined name of the config." + type: "string" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + Data: + description: | + Data is the data to store as a config, formatted as a Base64-url-safe-encoded + ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. + The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + type: "string" + Templating: + description: | + Templating driver, if applicable + + Templating controls whether and how to evaluate the config payload as + a template. If no driver is set, no templating is used. + $ref: "#/definitions/Driver" + + Config: + type: "object" + properties: + ID: + type: "string" + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Spec: + $ref: "#/definitions/ConfigSpec" + + ContainerState: + description: | + ContainerState stores container's running state. It's part of ContainerJSONBase + and will be returned by the "inspect" command. + type: "object" +# x-nullable: true + properties: + Status: + description: | + String representation of the container state. Can be one of "created", + "running", "paused", "restarting", "removing", "exited", or "dead". + type: "string" + enum: ["created", "running", "paused", "restarting", "removing", "exited", "dead"] + example: "running" + Running: + description: | + Whether this container is running. + + Note that a running container can be _paused_. The `Running` and `Paused` + booleans are not mutually exclusive: + + When pausing a container (on Linux), the freezer cgroup is used to suspend + all processes in the container. Freezing the process requires the process to + be running. As a result, paused containers are both `Running` _and_ `Paused`. + + Use the `Status` field instead to determine if a container's state is "running". + type: "boolean" + example: true + Paused: + description: "Whether this container is paused." + type: "boolean" + example: false + Restarting: + description: "Whether this container is restarting." + type: "boolean" + example: false + OOMKilled: + description: | + Whether a process within this container has been killed because it ran + out of memory since the container was last started. + type: "boolean" + example: false + Dead: + type: "boolean" + example: false + Pid: + description: "The process ID of this container" + type: "integer" + example: 1234 + ExitCode: + description: "The last exit code of this container" + type: "integer" + example: 0 + Error: + type: "string" + StartedAt: + description: "The time when this container was last started." + type: "string" + example: "2020-01-06T09:06:59.461876391Z" + FinishedAt: + description: "The time when this container last exited." + type: "string" + example: "2020-01-06T09:07:59.461876391Z" + Health: + x-nullable: true + $ref: "#/definitions/Health" + + ContainerCreateResponse: + description: "OK response to ContainerCreate operation" + type: "object" + title: "ContainerCreateResponse" + x-go-name: "CreateResponse" + required: [Id] +# required: [Id, Warnings] + properties: + Id: + description: "The ID of the created container" + type: "string" + x-nullable: false + example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743" + Warnings: + description: "Warnings encountered when creating the container" + type: "array" + x-nullable: false + items: + type: "string" + example: [] + + ContainerUpdateResponse: + type: "object" + title: "ContainerUpdateResponse" + x-go-name: "UpdateResponse" + description: |- + Response for a successful container-update. + properties: + Warnings: + type: "array" + description: |- + Warnings encountered when updating the container. + items: + type: "string" + example: ["Published ports are discarded when using host network mode"] + + ContainerStatsResponse: + description: | + Statistics sample for a container. + type: "object" + x-go-name: "StatsResponse" + title: "ContainerStatsResponse" + properties: + id: + description: | + ID of the container for which the stats were collected. + type: "string" + x-nullable: true + example: "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743" + name: + description: | + Name of the container for which the stats were collected. + type: "string" + x-nullable: true + example: "boring_wozniak" + os_type: + description: | + OSType is the OS of the container ("linux" or "windows") to allow + platform-specific handling of stats. + type: "string" + x-nullable: true + example: "linux" + read: + description: | + Date and time at which this sample was collected. + The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) + with nano-seconds. + type: "string" + format: "date-time" + example: "2025-01-16T13:55:22.165243637Z" + cpu_stats: + $ref: "#/definitions/ContainerCPUStats" + memory_stats: + $ref: "#/definitions/ContainerMemoryStats" + networks: + description: | + Network statistics for the container per interface. + + This field is omitted if the container has no networking enabled. + x-nullable: true + additionalProperties: + $ref: "#/definitions/ContainerNetworkStats" + example: + eth0: + rx_bytes: 5338 + rx_dropped: 0 + rx_errors: 0 + rx_packets: 36 + tx_bytes: 648 + tx_dropped: 0 + tx_errors: 0 + tx_packets: 8 + eth5: + rx_bytes: 4641 + rx_dropped: 0 + rx_errors: 0 + rx_packets: 26 + tx_bytes: 690 + tx_dropped: 0 + tx_errors: 0 + tx_packets: 9 + pids_stats: + $ref: "#/definitions/ContainerPidsStats" + blkio_stats: + $ref: "#/definitions/ContainerBlkioStats" + num_procs: + description: | + The number of processors on the system. + + This field is Windows-specific and always zero for Linux containers. + type: "integer" + format: "uint32" + example: 16 + storage_stats: + $ref: "#/definitions/ContainerStorageStats" + preread: + description: | + Date and time at which this first sample was collected. This field + is not propagated if the "one-shot" option is set. If the "one-shot" + option is set, this field may be omitted, empty, or set to a default + date (`0001-01-01T00:00:00Z`). + + The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) + with nano-seconds. + type: "string" + format: "date-time" + example: "2025-01-16T13:55:21.160452595Z" + precpu_stats: + $ref: "#/definitions/ContainerCPUStats" + + ContainerBlkioStats: + description: | + BlkioStats stores all IO service stats for data read and write. + + This type is Linux-specific and holds many fields that are specific to cgroups v1. + On a cgroup v2 host, all fields other than `io_service_bytes_recursive` + are omitted or `null`. + + This type is only populated on Linux and omitted for Windows containers. + type: "object" + x-go-name: "BlkioStats" + x-nullable: true + properties: + io_service_bytes_recursive: + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + io_serviced_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + io_queue_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + io_service_time_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + io_wait_time_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + io_merged_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + io_time_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + sectors_recursive: + description: | + This field is only available when using Linux containers with + cgroups v1. It is omitted or `null` when using cgroups v2. + x-nullable: true + type: "array" + items: + $ref: "#/definitions/ContainerBlkioStatEntry" + example: + io_service_bytes_recursive: [ + {"major": 254, "minor": 0, "op": "read", "value": 7593984}, + {"major": 254, "minor": 0, "op": "write", "value": 100} + ] + io_serviced_recursive: null + io_queue_recursive: null + io_service_time_recursive: null + io_wait_time_recursive: null + io_merged_recursive: null + io_time_recursive: null + sectors_recursive: null + + ContainerBlkioStatEntry: + description: | + Blkio stats entry. + + This type is Linux-specific and omitted for Windows containers. + type: "object" + x-go-name: "BlkioStatEntry" + x-nullable: true + properties: + major: + type: "integer" + format: "uint64" + example: 254 + minor: + type: "integer" + format: "uint64" + example: 0 + op: + type: "string" + example: "read" + value: + type: "integer" + format: "uint64" + example: 7593984 + + ContainerCPUStats: + description: | + CPU related info of the container + type: "object" + x-go-name: "CPUStats" + x-nullable: true + properties: + cpu_usage: + $ref: "#/definitions/ContainerCPUUsage" + system_cpu_usage: + description: | + System Usage. + + This field is Linux-specific and omitted for Windows containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 5 + online_cpus: + description: | + Number of online CPUs. + + This field is Linux-specific and omitted for Windows containers. + type: "integer" + format: "uint32" + x-nullable: true + example: 5 + throttling_data: + $ref: "#/definitions/ContainerThrottlingData" + + ContainerCPUUsage: + description: | + All CPU stats aggregated since container inception. + type: "object" + x-go-name: "CPUUsage" + x-nullable: true + properties: + total_usage: + description: | + Total CPU time consumed in nanoseconds (Linux) or 100's of nanoseconds (Windows). + type: "integer" + format: "uint64" + example: 29912000 + percpu_usage: + description: | + Total CPU time (in nanoseconds) consumed per core (Linux). + + This field is Linux-specific when using cgroups v1. It is omitted + when using cgroups v2 and Windows containers. + type: "array" + x-nullable: true + items: + type: "integer" + format: "uint64" + example: 29912000 + + usage_in_kernelmode: + description: | + Time (in nanoseconds) spent by tasks of the cgroup in kernel mode (Linux), + or time spent (in 100's of nanoseconds) by all container processes in + kernel mode (Windows). + + Not populated for Windows containers using Hyper-V isolation. + type: "integer" + format: "uint64" + example: 21994000 + usage_in_usermode: + description: | + Time (in nanoseconds) spent by tasks of the cgroup in user mode (Linux), + or time spent (in 100's of nanoseconds) by all container processes in + kernel mode (Windows). + + Not populated for Windows containers using Hyper-V isolation. + type: "integer" + format: "uint64" + example: 7918000 + + ContainerPidsStats: + description: | + PidsStats contains Linux-specific stats of a container's process-IDs (PIDs). + + This type is Linux-specific and omitted for Windows containers. + type: "object" + x-go-name: "PidsStats" + x-nullable: true + properties: + current: + description: | + Current is the number of PIDs in the cgroup. + type: "integer" + format: "uint64" + x-nullable: true + example: 5 + limit: + description: | + Limit is the hard limit on the number of pids in the cgroup. + A "Limit" of 0 means that there is no limit. + type: "integer" + format: "uint64" + x-nullable: true + example: "18446744073709551615" + + ContainerThrottlingData: + description: | + CPU throttling stats of the container. + + This type is Linux-specific and omitted for Windows containers. + type: "object" + x-go-name: "ThrottlingData" + x-nullable: true + properties: + periods: + description: | + Number of periods with throttling active. + type: "integer" + format: "uint64" + example: 0 + throttled_periods: + description: | + Number of periods when the container hit its throttling limit. + type: "integer" + format: "uint64" + example: 0 + throttled_time: + description: | + Aggregated time (in nanoseconds) the container was throttled for. + type: "integer" + format: "uint64" + example: 0 + + ContainerMemoryStats: + description: | + Aggregates all memory stats since container inception on Linux. + Windows returns stats for commit and private working set only. + type: "object" + x-go-name: "MemoryStats" + properties: + usage: + description: | + Current `res_counter` usage for memory. + + This field is Linux-specific and omitted for Windows containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 0 + max_usage: + description: | + Maximum usage ever recorded. + + This field is Linux-specific and only supported on cgroups v1. + It is omitted when using cgroups v2 and for Windows containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 0 + stats: + description: | + All the stats exported via memory.stat. when using cgroups v2. + + This field is Linux-specific and omitted for Windows containers. + type: "object" + additionalProperties: + type: "integer" + format: "uint64" + x-nullable: true + example: + { + "active_anon": 1572864, + "active_file": 5115904, + "anon": 1572864, + "anon_thp": 0, + "file": 7626752, + "file_dirty": 0, + "file_mapped": 2723840, + "file_writeback": 0, + "inactive_anon": 0, + "inactive_file": 2510848, + "kernel_stack": 16384, + "pgactivate": 0, + "pgdeactivate": 0, + "pgfault": 2042, + "pglazyfree": 0, + "pglazyfreed": 0, + "pgmajfault": 45, + "pgrefill": 0, + "pgscan": 0, + "pgsteal": 0, + "shmem": 0, + "slab": 1180928, + "slab_reclaimable": 725576, + "slab_unreclaimable": 455352, + "sock": 0, + "thp_collapse_alloc": 0, + "thp_fault_alloc": 1, + "unevictable": 0, + "workingset_activate": 0, + "workingset_nodereclaim": 0, + "workingset_refault": 0 + } + failcnt: + description: | + Number of times memory usage hits limits. + + This field is Linux-specific and only supported on cgroups v1. + It is omitted when using cgroups v2 and for Windows containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 0 + limit: + description: | + This field is Linux-specific and omitted for Windows containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 8217579520 + commitbytes: + description: | + Committed bytes. + + This field is Windows-specific and omitted for Linux containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 0 + commitpeakbytes: + description: | + Peak committed bytes. + + This field is Windows-specific and omitted for Linux containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 0 + privateworkingset: + description: | + Private working set. + + This field is Windows-specific and omitted for Linux containers. + type: "integer" + format: "uint64" + x-nullable: true + example: 0 + + ContainerNetworkStats: + description: | + Aggregates the network stats of one container + type: "object" + x-go-name: "NetworkStats" + x-nullable: true + properties: + rx_bytes: + description: | + Bytes received. Windows and Linux. + type: "integer" + format: "uint64" + example: 5338 + rx_packets: + description: | + Packets received. Windows and Linux. + type: "integer" + format: "uint64" + example: 36 + rx_errors: + description: | + Received errors. Not used on Windows. + + This field is Linux-specific and always zero for Windows containers. + type: "integer" + format: "uint64" + example: 0 + rx_dropped: + description: | + Incoming packets dropped. Windows and Linux. + type: "integer" + format: "uint64" + example: 0 + tx_bytes: + description: | + Bytes sent. Windows and Linux. + type: "integer" + format: "uint64" + example: 1200 + tx_packets: + description: | + Packets sent. Windows and Linux. + type: "integer" + format: "uint64" + example: 12 + tx_errors: + description: | + Sent errors. Not used on Windows. + + This field is Linux-specific and always zero for Windows containers. + type: "integer" + format: "uint64" + example: 0 + tx_dropped: + description: | + Outgoing packets dropped. Windows and Linux. + type: "integer" + format: "uint64" + example: 0 + endpoint_id: + description: | + Endpoint ID. Not used on Linux. + + This field is Windows-specific and omitted for Linux containers. + type: "string" + x-nullable: true + instance_id: + description: | + Instance ID. Not used on Linux. + + This field is Windows-specific and omitted for Linux containers. + type: "string" + x-nullable: true + + ContainerStorageStats: + description: | + StorageStats is the disk I/O stats for read/write on Windows. + + This type is Windows-specific and omitted for Linux containers. + type: "object" + x-go-name: "StorageStats" + x-nullable: true + properties: + read_count_normalized: + type: "integer" + format: "uint64" + x-nullable: true + example: 7593984 + read_size_bytes: + type: "integer" + format: "uint64" + x-nullable: true + example: 7593984 + write_count_normalized: + type: "integer" + format: "uint64" + x-nullable: true + example: 7593984 + write_size_bytes: + type: "integer" + format: "uint64" + x-nullable: true + example: 7593984 + + ContainerTopResponse: + type: "object" + x-go-name: "TopResponse" + title: "ContainerTopResponse" + description: |- + Container "top" response. + properties: + Titles: + description: "The ps column titles" + type: "array" + items: + type: "string" + example: + Titles: + - "UID" + - "PID" + - "PPID" + - "C" + - "STIME" + - "TTY" + - "TIME" + - "CMD" + Processes: + description: |- + Each process running in the container, where each process + is an array of values corresponding to the titles. + type: "array" + items: + type: "array" + items: + type: "string" + example: + Processes: + - + - "root" + - "13642" + - "882" + - "0" + - "17:03" + - "pts/0" + - "00:00:00" + - "/bin/bash" + - + - "root" + - "13735" + - "13642" + - "0" + - "17:06" + - "pts/0" + - "00:00:00" + - "sleep 10" + + ContainerWaitResponse: + description: "OK response to ContainerWait operation" + type: "object" + x-go-name: "WaitResponse" + title: "ContainerWaitResponse" + required: [StatusCode] +# required: [StatusCode, Error] + properties: + StatusCode: + description: "Exit code of the container" + type: "integer" + format: "int64" + x-nullable: false + Error: + $ref: "#/definitions/ContainerWaitExitError" + + ContainerWaitExitError: + description: "container waiting error, if any" + type: "object" + x-go-name: "WaitExitError" + properties: + Message: + description: "Details of an error" + type: "string" + + SystemVersion: + type: "object" + description: | + Response of Engine API: GET "/version" + properties: + Platform: + type: "object" + required: [Name] + properties: + Name: + type: "string" + Components: + type: "array" + description: | + Information about system components + items: + type: "object" + x-go-name: ComponentVersion + required: [Name, Version] + properties: + Name: + description: | + Name of the component + type: "string" + example: "Engine" + Version: + description: | + Version of the component + type: "string" + x-nullable: false + example: "27.0.1" + Details: + description: | + Key/value pairs of strings with additional information about the + component. These values are intended for informational purposes + only, and their content is not defined, and not part of the API + specification. + + These messages can be printed by the client as information to the user. + type: "object" + x-nullable: true + Version: + description: "The version of the daemon" + type: "string" + example: "27.0.1" + ApiVersion: + description: | + The default (and highest) API version that is supported by the daemon + type: "string" + example: "1.47" + MinAPIVersion: + description: | + The minimum API version that is supported by the daemon + type: "string" + example: "1.24" + GitCommit: + description: | + The Git commit of the source code that was used to build the daemon + type: "string" + example: "48a66213fe" + GoVersion: + description: | + The version Go used to compile the daemon, and the version of the Go + runtime in use. + type: "string" + example: "go1.22.7" + Os: + description: | + The operating system that the daemon is running on ("linux" or "windows") + type: "string" + example: "linux" + Arch: + description: | + The architecture that the daemon is running on + type: "string" + example: "amd64" + KernelVersion: + description: | + The kernel version (`uname -r`) that the daemon is running on. + + This field is omitted when empty. + type: "string" + example: "6.8.0-31-generic" + Experimental: + description: | + Indicates if the daemon is started with experimental features enabled. + + This field is omitted when empty / false. + type: "boolean" + example: true + BuildTime: + description: | + The date and time that the daemon was compiled. + type: "string" + example: "2020-06-22T15:49:27.000000000+00:00" + + SystemInfo: + type: "object" + properties: + ID: + description: | + Unique identifier of the daemon. + +


+ + > **Note**: The format of the ID itself is not part of the API, and + > should not be considered stable. + type: "string" + example: "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS" + Containers: + description: "Total number of containers on the host." + type: "integer" + example: 14 + ContainersRunning: + description: | + Number of containers with status `"running"`. + type: "integer" + example: 3 + ContainersPaused: + description: | + Number of containers with status `"paused"`. + type: "integer" + example: 1 + ContainersStopped: + description: | + Number of containers with status `"stopped"`. + type: "integer" + example: 10 + Images: + description: | + Total number of images on the host. + + Both _tagged_ and _untagged_ (dangling) images are counted. + type: "integer" + example: 508 + Driver: + description: "Name of the storage driver in use." + type: "string" + example: "overlay2" + DriverStatus: + description: | + Information specific to the storage driver, provided as + "label" / "value" pairs. + + This information is provided by the storage driver, and formatted + in a way consistent with the output of `docker info` on the command + line. + +


+ + > **Note**: The information returned in this field, including the + > formatting of values and labels, should not be considered stable, + > and may change without notice. + type: "array" + items: + type: "array" + items: + type: "string" + example: + - ["Backing Filesystem", "extfs"] + - ["Supports d_type", "true"] + - ["Native Overlay Diff", "true"] + DockerRootDir: + description: | + Root directory of persistent Docker state. + + Defaults to `/var/lib/docker` on Linux, and `C:\ProgramData\docker` + on Windows. + type: "string" + example: "/var/lib/docker" + Plugins: + $ref: "#/definitions/PluginsInfo" + MemoryLimit: + description: "Indicates if the host has memory limit support enabled." + type: "boolean" + example: true + SwapLimit: + description: "Indicates if the host has memory swap limit support enabled." + type: "boolean" + example: true + CpuCfsPeriod: + description: | + Indicates if CPU CFS(Completely Fair Scheduler) period is supported by + the host. + type: "boolean" + example: true + CpuCfsQuota: + description: | + Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by + the host. + type: "boolean" + example: true + CPUShares: + description: | + Indicates if CPU Shares limiting is supported by the host. + type: "boolean" + example: true + CPUSet: + description: | + Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. + + See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) + type: "boolean" + example: true + PidsLimit: + description: "Indicates if the host kernel has PID limit support enabled." + type: "boolean" + example: true + OomKillDisable: + description: "Indicates if OOM killer disable is supported on the host." + type: "boolean" + IPv4Forwarding: + description: "Indicates IPv4 forwarding is enabled." + type: "boolean" + example: true + Debug: + description: | + Indicates if the daemon is running in debug-mode / with debug-level + logging enabled. + type: "boolean" + example: true + NFd: + description: | + The total number of file Descriptors in use by the daemon process. + + This information is only returned if debug-mode is enabled. + type: "integer" + example: 64 + NGoroutines: + description: | + The number of goroutines that currently exist. + + This information is only returned if debug-mode is enabled. + type: "integer" + example: 174 + SystemTime: + description: | + Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) + format with nano-seconds. + type: "string" + example: "2017-08-08T20:28:29.06202363Z" + LoggingDriver: + description: | + The logging driver to use as a default for new containers. + type: "string" + CgroupDriver: + description: | + The driver to use for managing cgroups. + type: "string" + enum: ["cgroupfs", "systemd", "none"] + default: "cgroupfs" + example: "cgroupfs" + CgroupVersion: + description: | + The version of the cgroup. + type: "string" + enum: ["1", "2"] + x-enum-varnames: ["V1", "V2"] + default: "1" + example: "1" + NEventsListener: + description: "Number of event listeners subscribed." + type: "integer" + example: 30 + KernelVersion: + description: | + Kernel version of the host. + + On Linux, this information obtained from `uname`. On Windows this + information is queried from the HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ + registry value, for example _"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_. + type: "string" + example: "6.8.0-31-generic" + OperatingSystem: + description: | + Name of the host's operating system, for example: "Ubuntu 24.04 LTS" + or "Windows Server 2016 Datacenter" + type: "string" + example: "Ubuntu 24.04 LTS" + OSVersion: + description: | + Version of the host's operating system + +


+ + > **Note**: The information returned in this field, including its + > very existence, and the formatting of values, should not be considered + > stable, and may change without notice. + type: "string" + example: "24.04" + OSType: + description: | + Generic type of the operating system of the host, as returned by the + Go runtime (`GOOS`). + + Currently returned values are "linux" and "windows". A full list of + possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + type: "string" + example: "linux" + Architecture: + description: | + Hardware architecture of the host, as returned by the Go runtime + (`GOARCH`). + + A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + type: "string" + example: "x86_64" + NCPU: + description: | + The number of logical CPUs usable by the daemon. + + The number of available CPUs is checked by querying the operating + system when the daemon starts. Changes to operating system CPU + allocation after the daemon is started are not reflected. + type: "integer" + example: 4 + MemTotal: + description: | + Total amount of physical memory available on the host, in bytes. + type: "integer" + format: "int64" + example: 2095882240 + + IndexServerAddress: + description: | + Address / URL of the index server that is used for image search, + and as a default for user authentication for Docker Hub and Docker Cloud. + default: "https://index.docker.io/v1/" + type: "string" + example: "https://index.docker.io/v1/" + RegistryConfig: + $ref: "#/definitions/RegistryServiceConfig" + GenericResources: + $ref: "#/definitions/GenericResources" + HttpProxy: + description: | + HTTP-proxy configured for the daemon. This value is obtained from the + [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. + Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL + are masked in the API response. + + Containers do not automatically inherit this configuration. + type: "string" + example: "http://xxxxx:xxxxx@proxy.corp.example.com:8080" + HttpsProxy: + description: | + HTTPS-proxy configured for the daemon. This value is obtained from the + [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. + Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL + are masked in the API response. + + Containers do not automatically inherit this configuration. + type: "string" + example: "https://xxxxx:xxxxx@proxy.corp.example.com:4443" + NoProxy: + description: | + Comma-separated list of domain extensions for which no proxy should be + used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) + environment variable. + + Containers do not automatically inherit this configuration. + type: "string" + example: "*.local, 169.254/16" + Name: + description: "Hostname of the host." + type: "string" + example: "node5.corp.example.com" + Labels: + description: | + 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. + type: "array" + items: + type: "string" + example: ["storage=ssd", "production"] + ExperimentalBuild: + description: | + Indicates if experimental features are enabled on the daemon. + type: "boolean" + example: true + ServerVersion: + description: | + Version string of the daemon. + type: "string" + example: "27.0.1" + Runtimes: + description: | + 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. + type: "object" + additionalProperties: + $ref: "#/definitions/Runtime" + default: + runc: + path: "runc" + example: + runc: + path: "runc" + runc-master: + path: "/go/bin/runc" + custom: + path: "/usr/local/bin/my-oci-runtime" + runtimeArgs: ["--debug", "--systemd-cgroup=false"] + DefaultRuntime: + description: | + Name of the default OCI runtime that is used when starting containers. + + The default can be overridden per-container at create time. + type: "string" + default: "runc" + example: "runc" + Swarm: + $ref: "#/definitions/SwarmInfo" + LiveRestoreEnabled: + description: | + Indicates if live restore is enabled. + + If enabled, containers are kept running when the daemon is shutdown + or upon daemon start if running containers are detected. + type: "boolean" + default: false + example: false + Isolation: + description: | + Represents the isolation technology to use as a default for containers. + The supported values are platform-specific. + + If no isolation value is specified on daemon start, on Windows client, + the default is `hyperv`, and on Windows server, the default is `process`. + + This option is currently not used on other platforms. + default: "default" + type: "string" + enum: + - "default" + - "hyperv" + - "process" + - "" + InitBinary: + description: | + Name and, optional, path of the `docker-init` binary. + + If the path is omitted, the daemon searches the host's `$PATH` for the + binary and uses the first result. + type: "string" + example: "docker-init" + ContainerdCommit: + $ref: "#/definitions/Commit" + RuncCommit: + $ref: "#/definitions/Commit" + InitCommit: + $ref: "#/definitions/Commit" + SecurityOptions: + description: | + List of security features that are enabled on the daemon, such as + apparmor, seccomp, SELinux, user-namespaces (userns), rootless and + no-new-privileges. + + Additional configuration options for each security feature may + be present, and are included as a comma-separated list of key/value + pairs. + type: "array" + items: + type: "string" + example: + - "name=apparmor" + - "name=seccomp,profile=default" + - "name=selinux" + - "name=userns" + - "name=rootless" + ProductLicense: + description: | + Reports a summary of the product license on the daemon. + + If a commercial license has been applied to the daemon, information + such as number of nodes, and expiration are included. + type: "string" + example: "Community Engine" + DefaultAddressPools: + description: | + List of custom default address pools for local networks, which can be + specified in the daemon.json file or dockerd option. + + Example: a Base "10.10.0.0/16" with Size 24 will define the set of 256 + 10.10.[0-255].0/24 address pools. + type: "array" + items: + type: "object" + properties: + Base: + description: "The network address in CIDR format" + type: "string" + example: "10.10.0.0/16" + Size: + description: "The network pool size" + type: "integer" + example: "24" + FirewallBackend: + $ref: "#/definitions/FirewallInfo" + DiscoveredDevices: + description: | + List of devices discovered by device drivers. + + Each device includes information about its source driver, kind, name, + and additional driver-specific attributes. + type: "array" + items: + $ref: "#/definitions/DeviceInfo" + Warnings: + description: | + List of warnings / informational messages about missing features, or + issues related to the daemon configuration. + + These messages can be printed by the client as information to the user. + type: "array" + items: + type: "string" + example: + - "WARNING: No memory limit support" + CDISpecDirs: + description: | + List of directories where (Container Device Interface) CDI + specifications are located. + + These specifications define vendor-specific modifications to an OCI + runtime specification for a container being created. + + An empty list indicates that CDI device injection is disabled. + + Note that since using CDI device injection requires the daemon to have + experimental enabled. For non-experimental daemons an empty list will + always be returned. + type: "array" + items: + type: "string" + example: + - "/etc/cdi" + - "/var/run/cdi" + Containerd: + $ref: "#/definitions/ContainerdInfo" + + ContainerdInfo: + description: | + Information for connecting to the containerd instance that is used by the daemon. + This is included for debugging purposes only. + type: "object" + x-nullable: true + properties: + Address: + description: "The address of the containerd socket." + type: "string" + example: "/run/containerd/containerd.sock" + Namespaces: + description: | + The namespaces that the daemon uses for running containers and + plugins in containerd. These namespaces can be configured in the + daemon configuration, and are considered to be used exclusively + by the daemon, Tampering with the containerd instance may cause + unexpected behavior. + + As these namespaces are considered to be exclusively accessed + by the daemon, it is not recommended to change these values, + or to change them to a value that is used by other systems, + such as cri-containerd. + type: "object" + properties: + Containers: + description: | + The default containerd namespace used for containers managed + by the daemon. + + The default namespace for containers is "moby", but will be + suffixed with the `.` of the remapped `root` if + user-namespaces are enabled and the containerd image-store + is used. + type: "string" + default: "moby" + example: "moby" + Plugins: + description: | + The default containerd namespace used for plugins managed by + the daemon. + + The default namespace for plugins is "plugins.moby", but will be + suffixed with the `.` of the remapped `root` if + user-namespaces are enabled and the containerd image-store + is used. + type: "string" + default: "plugins.moby" + example: "plugins.moby" + + FirewallInfo: + description: | + Information about the daemon's firewalling configuration. + + This field is currently only used on Linux, and omitted on other platforms. + type: "object" + x-nullable: true + properties: + Driver: + description: | + The name of the firewall backend driver. + type: "string" + example: "nftables" + Info: + description: | + Information about the firewall backend, provided as + "label" / "value" pairs. + +


+ + > **Note**: The information returned in this field, including the + > formatting of values and labels, should not be considered stable, + > and may change without notice. + type: "array" + items: + type: "array" + items: + type: "string" + example: + - ["ReloadedAt", "2025-01-01T00:00:00Z"] + + # PluginsInfo is a temp struct holding Plugins name + # registered with docker daemon. It is used by Info struct + PluginsInfo: + description: | + Available plugins per type. + +


+ + > **Note**: Only unmanaged (V1) plugins are included in this list. + > V1 plugins are "lazily" loaded, and are not returned in this list + > if there is no resource using the plugin. + type: "object" + properties: + Volume: + description: "Names of available volume-drivers, and network-driver plugins." + type: "array" + items: + type: "string" + example: ["local"] + Network: + description: "Names of available network-drivers, and network-driver plugins." + type: "array" + items: + type: "string" + example: ["bridge", "host", "ipvlan", "macvlan", "null", "overlay"] + Authorization: + description: "Names of available authorization plugins." + type: "array" + items: + type: "string" + example: ["img-authz-plugin", "hbm"] + Log: + description: "Names of available logging-drivers, and logging-driver plugins." + type: "array" + items: + type: "string" + example: ["awslogs", "fluentd", "gcplogs", "gelf", "journald", "json-file", "splunk", "syslog"] + + + RegistryServiceConfig: + description: | + RegistryServiceConfig stores daemon registry services configuration. + type: "object" + x-nullable: true + properties: + InsecureRegistryCIDRs: + description: | + List of IP ranges of insecure registries, using the CIDR syntax + ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries + accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates + from unknown CAs) communication. + + By default, local registries (`::1/128` and `127.0.0.0/8`) are configured as + insecure. All other registries are secure. Communicating with an + insecure registry is not possible if the daemon assumes that registry + is secure. + + This configuration override this behavior, insecure communication with + registries whose resolved IP address is within the subnet described by + the CIDR syntax. + + Registries can also be marked insecure by hostname. Those registries + are listed under `IndexConfigs` and have their `Secure` field set to + `false`. + + > **Warning**: Using this option can be useful when running a local + > registry, but introduces security vulnerabilities. This option + > should therefore ONLY be used for testing purposes. For increased + > security, users should add their CA to their system's list of trusted + > CAs instead of enabling this option. + type: "array" + items: + type: "string" + example: ["::1/128", "127.0.0.0/8"] + IndexConfigs: + type: "object" + additionalProperties: + $ref: "#/definitions/IndexInfo" + example: + "127.0.0.1:5000": + "Name": "127.0.0.1:5000" + "Mirrors": [] + "Secure": false + "Official": false + "[2001:db8:a0b:12f0::1]:80": + "Name": "[2001:db8:a0b:12f0::1]:80" + "Mirrors": [] + "Secure": false + "Official": false + "docker.io": + Name: "docker.io" + Mirrors: ["https://hub-mirror.corp.example.com:5000/"] + Secure: true + Official: true + "registry.internal.corp.example.com:3000": + Name: "registry.internal.corp.example.com:3000" + Mirrors: [] + Secure: false + Official: false + Mirrors: + description: | + List of registry URLs that act as a mirror for the official + (`docker.io`) registry. + + type: "array" + items: + type: "string" + example: + - "https://hub-mirror.corp.example.com:5000/" + - "https://[2001:db8:a0b:12f0::1]/" + + IndexInfo: + description: + IndexInfo contains information about a registry. + type: "object" + x-nullable: true + properties: + Name: + description: | + Name of the registry, such as "docker.io". + type: "string" + example: "docker.io" + Mirrors: + description: | + List of mirrors, expressed as URIs. + type: "array" + items: + type: "string" + example: + - "https://hub-mirror.corp.example.com:5000/" + - "https://registry-2.docker.io/" + - "https://registry-3.docker.io/" + Secure: + description: | + Indicates if the registry is part of the list of insecure + registries. + + If `false`, the registry is insecure. Insecure registries accept + un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from + unknown CAs) communication. + + > **Warning**: Insecure registries can be useful when running a local + > registry. However, because its use creates security vulnerabilities + > it should ONLY be enabled for testing purposes. For increased + > security, users should add their CA to their system's list of + > trusted CAs instead of enabling this option. + type: "boolean" + example: true + Official: + description: | + Indicates whether this is an official registry (i.e., Docker Hub / docker.io) + type: "boolean" + example: true + + Runtime: + description: | + Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) + runtime. + + The runtime is invoked by the daemon via the `containerd` daemon. OCI + runtimes act as an interface to the Linux kernel namespaces, cgroups, + and SELinux. + type: "object" + properties: + path: + description: | + Name and, optional, path, of the OCI executable binary. + + If the path is omitted, the daemon searches the host's `$PATH` for the + binary and uses the first result. + type: "string" + example: "/usr/local/bin/my-oci-runtime" + runtimeArgs: + description: | + List of command-line arguments to pass to the runtime when invoked. + type: "array" + x-nullable: true + items: + type: "string" + example: ["--debug", "--systemd-cgroup=false"] + status: + description: | + Information specific to the runtime. + + While this API specification does not define data provided by runtimes, + the following well-known properties may be provided by runtimes: + + `org.opencontainers.runtime-spec.features`: features structure as defined + in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), + in a JSON string representation. + +


+ + > **Note**: The information returned in this field, including the + > formatting of values and labels, should not be considered stable, + > and may change without notice. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + "org.opencontainers.runtime-spec.features": "{\"ociVersionMin\":\"1.0.0\",\"ociVersionMax\":\"1.1.0\",\"...\":\"...\"}" + + Commit: + description: | + Commit holds the Git-commit (SHA1) that a binary was built from, as + reported in the version-string of external tools, such as `containerd`, + or `runC`. + type: "object" + properties: + ID: + description: "Actual commit ID of external tool." + type: "string" + example: "cfb82a876ecc11b5ca0977d1733adbe58599088a" + + SwarmInfo: + description: | + Represents generic information about swarm. + type: "object" + properties: + NodeID: + description: "Unique identifier of for this node in the swarm." + type: "string" + default: "" + example: "k67qz4598weg5unwwffg6z1m1" + NodeAddr: + description: | + IP address at which this node can be reached by other nodes in the + swarm. + type: "string" + default: "" + example: "10.0.0.46" + LocalNodeState: + $ref: "#/definitions/LocalNodeState" + ControlAvailable: + type: "boolean" + default: false + example: true + Error: + type: "string" + default: "" + RemoteManagers: + description: | + List of ID's and addresses of other managers in the swarm. + type: "array" + default: null + x-nullable: true + items: + $ref: "#/definitions/PeerNode" + example: + - NodeID: "71izy0goik036k48jg985xnds" + Addr: "10.0.0.158:2377" + - NodeID: "79y6h1o4gv8n120drcprv5nmc" + Addr: "10.0.0.159:2377" + - NodeID: "k67qz4598weg5unwwffg6z1m1" + Addr: "10.0.0.46:2377" + Nodes: + description: "Total number of nodes in the swarm." + type: "integer" + x-nullable: true + example: 4 + Managers: + description: "Total number of managers in the swarm." + type: "integer" + x-nullable: true + example: 3 + Cluster: + $ref: "#/definitions/ClusterInfo" + + LocalNodeState: + description: "Current local status of this node." + type: "string" + default: "" + enum: + - "" + - "inactive" + - "pending" + - "active" + - "error" + - "locked" + example: "active" + + PeerNode: + description: "Represents a peer-node in the swarm" + type: "object" + properties: + NodeID: + description: "Unique identifier of for this node in the swarm." + type: "string" + Addr: + description: | + IP address and ports at which this node can be reached. + type: "string" + + NetworkAttachmentConfig: + description: | + Specifies how a service should be attached to a particular network. + type: "object" + properties: + Target: + description: | + The target network for attachment. Must be a network name or ID. + type: "string" + Aliases: + description: | + Discoverable alternate names for the service on this network. + type: "array" + items: + type: "string" + DriverOpts: + description: | + Driver attachment options for the network target. + type: "object" + 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.oci.image.manifest.v1+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: 424 + urls: + description: |- + List of URLs from which this object MAY be downloaded. + type: "array" + items: + type: "string" + format: "uri" + x-nullable: true + annotations: + description: |- + Arbitrary metadata relating to the targeted content. + type: "object" + x-nullable: true + additionalProperties: + type: "string" + example: + "com.docker.official-images.bashbrew.arch": "amd64" + "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8" + "org.opencontainers.image.base.name": "scratch" + "org.opencontainers.image.created": "2025-01-27T00:00:00Z" + "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79" + "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base" + "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu" + "org.opencontainers.image.version": "24.04" + data: + type: string + x-nullable: true + description: |- + Data is an embedding of the targeted content. This is encoded as a base64 + string when marshalled to JSON (automatically, by encoding/json). If + present, Data can be used directly to avoid fetching the targeted content. + example: null + platform: + $ref: "#/definitions/OCIPlatform" + artifactType: + description: |- + ArtifactType is the IANA media type of this artifact. + type: "string" + x-nullable: true + example: null + + OCIPlatform: + type: "object" + x-go-name: Platform + x-nullable: true + 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" + + ClusterVolume: + type: "object" + description: | + Options and information specific to, and only present on, Swarm CSI + cluster volumes. + properties: + ID: + type: "string" + description: | + The Swarm ID of this volume. Because cluster volumes are Swarm + objects, they have an ID, unlike non-cluster volumes. This ID can + be used to refer to the Volume instead of the name. + Version: + $ref: "#/definitions/ObjectVersion" + CreatedAt: + type: "string" + format: "dateTime" + UpdatedAt: + type: "string" + format: "dateTime" + Spec: + $ref: "#/definitions/ClusterVolumeSpec" + Info: + type: "object" + description: | + Information about the global status of the volume. + properties: + CapacityBytes: + type: "integer" + format: "int64" + description: | + The capacity of the volume in bytes. A value of 0 indicates that + the capacity is unknown. + VolumeContext: + type: "object" + description: | + A map of strings to strings returned from the storage plugin when + the volume is created. + additionalProperties: + type: "string" + VolumeID: + type: "string" + description: | + The ID of the volume as returned by the CSI storage plugin. This + is distinct from the volume's ID as provided by Docker. This ID + is never used by the user when communicating with Docker to refer + to this volume. If the ID is blank, then the Volume has not been + successfully created in the plugin yet. + AccessibleTopology: + type: "array" + description: | + The topology this volume is actually accessible from. + items: + $ref: "#/definitions/Topology" + PublishStatus: + type: "array" + description: | + The status of the volume as it pertains to its publishing and use on + specific nodes + items: + type: "object" + properties: + NodeID: + type: "string" + description: | + The ID of the Swarm node the volume is published on. + State: + type: "string" + description: | + The published state of the volume. + * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. + * `published` The volume is published successfully to the node. + * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. + * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + enum: + - "pending-publish" + - "published" + - "pending-node-unpublish" + - "pending-controller-unpublish" + PublishContext: + type: "object" + description: | + A map of strings to strings returned by the CSI controller + plugin when a volume is published. + additionalProperties: + type: "string" + + ClusterVolumeSpec: + type: "object" + description: | + Cluster-specific options used to create the volume. + properties: + Group: + type: "string" + description: | + Group defines the volume group of this volume. Volumes belonging to + the same group can be referred to by group name when creating + Services. Referring to a volume by group instructs Swarm to treat + volumes in that group interchangeably for the purpose of scheduling. + Volumes with an empty string for a group technically all belong to + the same, emptystring group. + AccessMode: + type: "object" + description: | + Defines how the volume is used by tasks. + properties: + Scope: + type: "string" + description: | + The set of nodes this volume can be used on at one time. + - `single` The volume may only be scheduled to one node at a time. + - `multi` the volume may be scheduled to any supported number of nodes at a time. + default: "single" + enum: ["single", "multi"] + x-nullable: false + Sharing: + type: "string" + description: | + The number and way that different tasks can use this volume + at one time. + - `none` The volume may only be used by one task at a time. + - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly + - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. + - `all` The volume may have any number of readers and writers. + default: "none" + enum: ["none", "readonly", "onewriter", "all"] + x-nullable: false + MountVolume: + type: "object" + description: | + Options for using this volume as a Mount-type volume. + + Either MountVolume or BlockVolume, but not both, must be + present. + properties: + FsType: + type: "string" + description: | + Specifies the filesystem type for the mount volume. + Optional. + MountFlags: + type: "array" + description: | + Flags to pass when mounting the volume. Optional. + items: + type: "string" + BlockVolume: + type: "object" + description: | + Options for using this volume as a Block-type volume. + Intentionally empty. + Secrets: + type: "array" + description: | + Swarm Secrets that are passed to the CSI storage plugin when + operating on this volume. + items: + type: "object" + description: | + One cluster volume secret entry. Defines a key-value pair that + is passed to the plugin. + properties: + Key: + type: "string" + description: | + Key is the name of the key of the key-value pair passed to + the plugin. + Secret: + type: "string" + description: | + Secret is the swarm Secret object from which to read data. + This can be a Secret name or ID. The Secret data is + retrieved by swarm and used as the value of the key-value + pair passed to the plugin. + AccessibilityRequirements: + type: "object" + description: | + Requirements for the accessible topology of the volume. These + fields are optional. For an in-depth description of what these + fields mean, see the CSI specification. + properties: + Requisite: + type: "array" + description: | + A list of required topologies, at least one of which the + volume must be accessible from. + items: + $ref: "#/definitions/Topology" + Preferred: + type: "array" + description: | + A list of topologies that the volume should attempt to be + provisioned in. + items: + $ref: "#/definitions/Topology" + CapacityRange: + type: "object" + description: | + The desired capacity that the volume should be created with. If + empty, the plugin will decide the capacity. + properties: + RequiredBytes: + type: "integer" + format: "int64" + description: | + The volume must be at least this big. The value of 0 + indicates an unspecified minimum + LimitBytes: + type: "integer" + format: "int64" + description: | + The volume must not be bigger than this. The value of 0 + indicates an unspecified maximum. + Availability: + type: "string" + description: | + The availability of the volume for use in tasks. + - `active` The volume is fully available for scheduling on the cluster + - `pause` No new workloads should use the volume, but existing workloads are not stopped. + - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + default: "active" + x-nullable: false + enum: + - "active" + - "pause" + - "drain" + + Topology: + description: | + A map of topological domains to topological segments. For in depth + details, see documentation for the Topology object in the CSI + specification. + type: "object" + additionalProperties: + type: "string" + + ImageManifestSummary: + x-go-name: "ManifestSummary" + description: | + ImageManifestSummary represents a summary of an image manifest. + type: "object" + required: ["ID", "Descriptor", "Available", "Size", "Kind"] + properties: + ID: + description: | + ID is the content-addressable ID of an image and is the same as the + digest of the image manifest. + type: "string" + example: "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f" + Descriptor: + $ref: "#/definitions/OCIDescriptor" + Available: + description: Indicates whether all the child content (image config, layers) is fully available locally. + type: "boolean" + example: true + Size: + type: "object" + x-nullable: false + required: ["Content", "Total"] + properties: + Total: + type: "integer" + format: "int64" + example: 8213251 + description: | + Total is the total size (in bytes) of all the locally present + data (both distributable and non-distributable) that's related to + this manifest and its children. + This equal to the sum of [Content] size AND all the sizes in the + [Size] struct present in the Kind-specific data struct. + For example, for an image kind (Kind == "image") + this would include the size of the image content and unpacked + image snapshots ([Size.Content] + [ImageData.Size.Unpacked]). + Content: + description: | + Content is the size (in bytes) of all the locally present + content in the content store (e.g. image config, layers) + referenced by this manifest and its children. + This only includes blobs in the content store. + type: "integer" + format: "int64" + example: 3987495 + Kind: + type: "string" + example: "image" + enum: + - "image" + - "attestation" + - "unknown" + description: | + The kind of the manifest. + + kind | description + -------------|----------------------------------------------------------- + image | Image manifest that can be used to start a container. + attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. + ImageData: + description: | + The image data for the image manifest. + This field is only populated when Kind is "image". + type: "object" + x-nullable: true + x-omitempty: true + required: ["Platform", "Containers", "Size", "UnpackedSize"] + properties: + Platform: + $ref: "#/definitions/OCIPlatform" + description: | + OCI platform of the image. This will be the platform specified in the + manifest descriptor from the index/manifest list. + If it's not available, it will be obtained from the image config. + Containers: + description: | + The IDs of the containers that are using this image. + type: "array" + items: + type: "string" + example: ["ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430", "abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e"] + Size: + type: "object" + x-nullable: false + required: ["Unpacked"] + properties: + Unpacked: + type: "integer" + format: "int64" + example: 3987495 + description: | + Unpacked is the size (in bytes) of the locally unpacked + (uncompressed) image content that's directly usable by the containers + running this image. + It's independent of the distributable content - e.g. + the image might still have an unpacked data that's still used by + some container even when the distributable/compressed content is + already gone. + AttestationData: + description: | + The image data for the attestation manifest. + This field is only populated when Kind is "attestation". + type: "object" + x-nullable: true + x-omitempty: true + required: ["For"] + properties: + For: + description: | + The digest of the image manifest that this attestation is for. + type: "string" + example: "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f" + +paths: + /containers/json: + get: + summary: "List containers" + description: | + Returns a list of containers. For details on the format, see the + [inspect endpoint](#operation/ContainerInspect). + + Note that it uses a different, smaller representation of a container + than inspecting a single container. For example, the list of linked + containers is not propagated . + operationId: "ContainerList" + produces: + - "application/json" + parameters: + - name: "all" + in: "query" + description: | + Return all containers. By default, only running containers are shown. + type: "boolean" + default: false + - name: "limit" + in: "query" + description: | + Return this number of most recently created containers, including + non-running ones. + type: "integer" + - name: "size" + in: "query" + description: | + Return the size of container as fields `SizeRw` and `SizeRootFs`. + type: "boolean" + default: false + - name: "filters" + in: "query" + description: | + 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 ``) + type: "string" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/ContainerSummary" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Container"] + /containers/create: + post: + summary: "Create a container" + operationId: "ContainerCreate" + consumes: + - "application/json" + - "application/octet-stream" + produces: + - "application/json" + parameters: + - name: "name" + in: "query" + description: | + Assign the specified name to the container. Must match + `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`. + type: "string" + pattern: "^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$" + - name: "platform" + in: "query" + description: | + Platform in the format `os[/arch[/variant]]` used for image lookup. + + When specified, the daemon checks if the requested image is present + in the local image cache with the given OS and Architecture, and + otherwise returns a `404` status. + + If the option is not set, the host's native OS and Architecture are + used to look up the image in the image cache. However, if no platform + is passed and the given image does exist in the local image cache, + but its OS or architecture does not match, the container is created + with the available image, and a warning is added to the `Warnings` + field in the response, for example; + + WARNING: The requested image's platform (linux/arm64/v8) does not + match the detected host platform (linux/amd64) and no + specific platform was requested + + type: "string" + default: "" + - name: "body" + in: "body" + description: "Container to create" + schema: + allOf: + - $ref: "#/definitions/ContainerConfig" + - type: "object" + properties: + HostConfig: + $ref: "#/definitions/HostConfig" + NetworkingConfig: + $ref: "#/definitions/NetworkingConfig" + example: + Hostname: "" + Domainname: "" + User: "" + AttachStdin: false + AttachStdout: true + AttachStderr: true + Tty: false + OpenStdin: false + StdinOnce: false + Env: + - "FOO=bar" + - "BAZ=quux" + Cmd: + - "date" + Entrypoint: "" + Image: "ubuntu" + Labels: + com.example.vendor: "Acme" + com.example.license: "GPL" + com.example.version: "1.0" + Volumes: + /volumes/data: {} + WorkingDir: "" + NetworkDisabled: false + ExposedPorts: + 22/tcp: {} + StopSignal: "SIGTERM" + StopTimeout: 10 + HostConfig: + Binds: + - "/tmp:/tmp" + Links: + - "redis3:redis" + Memory: 0 + MemorySwap: 0 + MemoryReservation: 0 + NanoCpus: 500000 + CpuPercent: 80 + CpuShares: 512 + CpuPeriod: 100000 + CpuRealtimePeriod: 1000000 + CpuRealtimeRuntime: 10000 + CpuQuota: 50000 + CpusetCpus: "0,1" + CpusetMems: "0,1" + MaximumIOps: 0 + MaximumIOBps: 0 + BlkioWeight: 300 + BlkioWeightDevice: + - {} + BlkioDeviceReadBps: + - {} + BlkioDeviceReadIOps: + - {} + BlkioDeviceWriteBps: + - {} + BlkioDeviceWriteIOps: + - {} + DeviceRequests: + - Driver: "nvidia" + Count: -1 + DeviceIDs": ["0", "1", "GPU-fef8089b-4820-abfc-e83e-94318197576e"] + Capabilities: [["gpu", "nvidia", "compute"]] + Options: + property1: "string" + property2: "string" + MemorySwappiness: 60 + OomKillDisable: false + OomScoreAdj: 500 + PidMode: "" + PidsLimit: 0 + PortBindings: + 22/tcp: + - HostPort: "11022" + PublishAllPorts: false + Privileged: false + ReadonlyRootfs: false + Dns: + - "8.8.8.8" + DnsOptions: + - "" + DnsSearch: + - "" + VolumesFrom: + - "parent" + - "other:ro" + CapAdd: + - "NET_ADMIN" + CapDrop: + - "MKNOD" + GroupAdd: + - "newgroup" + RestartPolicy: + Name: "" + MaximumRetryCount: 0 + AutoRemove: true + NetworkMode: "bridge" + Devices: [] + Ulimits: + - {} + LogConfig: + Type: "json-file" + Config: {} + SecurityOpt: [] + StorageOpt: {} + CgroupParent: "" + VolumeDriver: "" + ShmSize: 67108864 + NetworkingConfig: + EndpointsConfig: + isolated_nw: + IPAMConfig: + IPv4Address: "172.20.30.33" + IPv6Address: "2001:db8:abcd::3033" + LinkLocalIPs: + - "169.254.34.68" + - "fe80::3468" + Links: + - "container_1" + - "container_2" + Aliases: + - "server_x" + - "server_y" + database_nw: {} + + required: true + responses: + 201: + description: "Container created successfully" + schema: + $ref: "#/definitions/ContainerCreateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such image" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such image: c2ada9df5af8" + 409: + description: "conflict" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Container"] + /containers/{id}/json: + get: + summary: "Inspect a container" + description: "Return low-level information about a container." + operationId: "ContainerInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/ContainerInspectResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "size" + in: "query" + type: "boolean" + default: false + description: "Return the size of container as fields `SizeRw` and `SizeRootFs`" + tags: ["Container"] + /containers/{id}/top: + get: + summary: "List processes running inside a container" + description: | + On Unix systems, this is done by running the `ps` command. This endpoint + is not supported on Windows. + operationId: "ContainerTop" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/ContainerTopResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "ps_args" + in: "query" + description: "The arguments to pass to `ps`. For example, `aux`" + type: "string" + default: "-ef" + tags: ["Container"] + /containers/{id}/logs: + get: + summary: "Get container logs" + description: | + Get `stdout` and `stderr` logs from a container. + + Note: This endpoint works only for containers with the `json-file` or + `journald` logging driver. + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + operationId: "ContainerLogs" + responses: + 200: + description: | + logs returned as a stream in response body. + For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach). + Note that unlike the attach endpoint, the logs endpoint does not + upgrade the connection and does not set Content-Type. + schema: + type: "string" + format: "binary" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "follow" + in: "query" + description: "Keep connection after returning logs." + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Return logs from `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Return logs from `stderr`" + type: "boolean" + default: false + - name: "since" + in: "query" + description: "Only return logs since this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "until" + in: "query" + description: "Only return logs before this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "timestamps" + in: "query" + description: "Add timestamps to every log line" + type: "boolean" + default: false + - name: "tail" + in: "query" + description: | + Only return this number of log lines from the end of the logs. + Specify as an integer or `all` to output all log lines. + type: "string" + default: "all" + tags: ["Container"] + /containers/{id}/changes: + get: + summary: "Get changes on a container’s filesystem" + description: | + Returns which files in a container's filesystem have been added, deleted, + or modified. The `Kind` of modification can be one of: + + - `0`: Modified ("C") + - `1`: Added ("A") + - `2`: Deleted ("D") + operationId: "ContainerChanges" + produces: ["application/json"] + responses: + 200: + description: "The list of changes" + schema: + type: "array" + items: + $ref: "#/definitions/FilesystemChange" + examples: + application/json: + - Path: "/dev" + Kind: 0 + - Path: "/dev/kmsg" + Kind: 1 + - Path: "/test" + Kind: 1 + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/export: + get: + summary: "Export a container" + description: "Export the contents of a container as a tarball." + operationId: "ContainerExport" + produces: + - "application/octet-stream" + responses: + 200: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/stats: + get: + summary: "Get container stats based on resource usage" + description: | + This endpoint returns a live stream of a container’s resource usage + statistics. + + The `precpu_stats` is the CPU statistic of the *previous* read, and is + used to calculate the CPU usage percentage. It is not an exact copy + of the `cpu_stats` field. + + If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is + nil then for compatibility with older daemons the length of the + corresponding `cpu_usage.percpu_usage` array should be used. + + On a cgroup v2 host, the following fields are not set + * `blkio_stats`: all fields other than `io_service_bytes_recursive` + * `cpu_stats`: `cpu_usage.percpu_usage` + * `memory_stats`: `max_usage` and `failcnt` + Also, `memory_stats.stats` fields are incompatible with cgroup v1. + + To calculate the values shown by the `stats` command of the docker cli tool + the following formulas can be used: + * used_memory = `memory_stats.usage - memory_stats.stats.cache` + * available_memory = `memory_stats.limit` + * Memory usage % = `(used_memory / available_memory) * 100.0` + * cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage` + * system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage` + * number_cpus = `length(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus` + * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0` + operationId: "ContainerStats" + produces: ["application/json"] + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/ContainerStatsResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "stream" + in: "query" + description: | + Stream the output. If false, the stats will be output once and then + it will disconnect. + type: "boolean" + default: true + - name: "one-shot" + in: "query" + description: | + Only get a single stat instead of waiting for 2 cycles. Must be used + with `stream=false`. + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/resize: + post: + summary: "Resize a container TTY" + description: "Resize the TTY for a container." + operationId: "ContainerResize" + consumes: + - "application/octet-stream" + produces: + - "text/plain" + responses: + 200: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "cannot resize container" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "h" + in: "query" + required: true + description: "Height of the TTY session in characters" + type: "integer" + - name: "w" + in: "query" + required: true + description: "Width of the TTY session in characters" + type: "integer" + tags: ["Container"] + /containers/{id}/start: + post: + summary: "Start a container" + operationId: "ContainerStart" + responses: + 204: + description: "no error" + 304: + description: "container already started" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "detachKeys" + in: "query" + description: | + Override the key sequence for detaching a container. Format is a + single character `[a-Z]` or `ctrl-` where `` is one + of: `a-z`, `@`, `^`, `[`, `,` or `_`. + type: "string" + tags: ["Container"] + /containers/{id}/stop: + post: + summary: "Stop a container" + operationId: "ContainerStop" + responses: + 204: + description: "no error" + 304: + description: "container already stopped" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "signal" + in: "query" + description: | + Signal to send to the container as an integer or string (e.g. `SIGINT`). + type: "string" + - name: "t" + in: "query" + description: "Number of seconds to wait before killing the container" + type: "integer" + tags: ["Container"] + /containers/{id}/restart: + post: + summary: "Restart a container" + operationId: "ContainerRestart" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "signal" + in: "query" + description: | + Signal to send to the container as an integer or string (e.g. `SIGINT`). + type: "string" + - name: "t" + in: "query" + description: "Number of seconds to wait before killing the container" + type: "integer" + tags: ["Container"] + /containers/{id}/kill: + post: + summary: "Kill a container" + description: | + Send a POSIX signal to a container, defaulting to killing to the + container. + operationId: "ContainerKill" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "container is not running" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "signal" + in: "query" + description: | + Signal to send to the container as an integer or string (e.g. `SIGINT`). + type: "string" + default: "SIGKILL" + tags: ["Container"] + /containers/{id}/update: + post: + summary: "Update a container" + description: | + Change various configuration options of a container without having to + recreate it. + operationId: "ContainerUpdate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "The container has been updated." + schema: + $ref: "#/definitions/ContainerUpdateResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "update" + in: "body" + required: true + schema: + allOf: + - $ref: "#/definitions/Resources" + - type: "object" + properties: + RestartPolicy: + $ref: "#/definitions/RestartPolicy" + example: + BlkioWeight: 300 + CpuShares: 512 + CpuPeriod: 100000 + CpuQuota: 50000 + CpuRealtimePeriod: 1000000 + CpuRealtimeRuntime: 10000 + CpusetCpus: "0,1" + CpusetMems: "0" + Memory: 314572800 + MemorySwap: 514288000 + MemoryReservation: 209715200 + RestartPolicy: + MaximumRetryCount: 4 + Name: "on-failure" + tags: ["Container"] + /containers/{id}/rename: + post: + summary: "Rename a container" + operationId: "ContainerRename" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "name already in use" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "name" + in: "query" + required: true + description: "New name for the container" + type: "string" + tags: ["Container"] + /containers/{id}/pause: + post: + summary: "Pause a container" + description: | + Use the freezer cgroup to suspend all processes in a container. + + Traditionally, when suspending a process the `SIGSTOP` signal is used, + which is observable by the process being suspended. With the freezer + cgroup the process is unaware, and unable to capture, that it is being + suspended, and subsequently resumed. + operationId: "ContainerPause" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/unpause: + post: + summary: "Unpause a container" + description: "Resume a container which has been paused." + operationId: "ContainerUnpause" + responses: + 204: + description: "no error" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + tags: ["Container"] + /containers/{id}/attach: + post: + summary: "Attach to a container" + description: | + 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 HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream + and 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`. + + operationId: "ContainerAttach" + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + responses: + 101: + description: "no error, hints proxy about hijacking" + 200: + description: "no error, no upgrade header found" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "detachKeys" + in: "query" + description: | + Override the key sequence for detaching a container.Format is a single + character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, + `@`, `^`, `[`, `,` or `_`. + type: "string" + - name: "logs" + in: "query" + description: | + Replay previous logs from the container. + + This is useful for attaching to a container that has started and you + want to output everything since the container started. + + If `stream` is also enabled, once all the previous output has been + returned, it will seamlessly transition into streaming current + output. + type: "boolean" + default: false + - name: "stream" + in: "query" + description: | + Stream attached streams from the time the request was made onwards. + type: "boolean" + default: false + - name: "stdin" + in: "query" + description: "Attach to `stdin`" + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Attach to `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Attach to `stderr`" + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/attach/ws: + get: + summary: "Attach to a container via a websocket" + operationId: "ContainerAttachWebsocket" + responses: + 101: + description: "no error, hints proxy about hijacking" + 200: + description: "no error, no upgrade header found" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "detachKeys" + in: "query" + description: | + Override the key sequence for detaching a container.Format is a single + character `[a-Z]` or `ctrl-` where `` is one of: `a-z`, + `@`, `^`, `[`, `,`, or `_`. + type: "string" + - name: "logs" + in: "query" + description: "Return logs" + type: "boolean" + default: false + - name: "stream" + in: "query" + description: "Return stream" + type: "boolean" + default: false + - name: "stdin" + in: "query" + description: "Attach to `stdin`" + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Attach to `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Attach to `stderr`" + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/wait: + post: + summary: "Wait for a container" + description: "Block until a container stops, then returns the exit code." + operationId: "ContainerWait" + produces: ["application/json"] + responses: + 200: + description: "The container has exit." + schema: + $ref: "#/definitions/ContainerWaitResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "condition" + in: "query" + description: | + Wait until a container state reaches the given condition. + + Defaults to `not-running` if omitted or empty. + type: "string" + enum: + - "not-running" + - "next-exit" + - "removed" + default: "not-running" + tags: ["Container"] + /containers/{id}: + delete: + summary: "Remove a container" + operationId: "ContainerDelete" + responses: + 204: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "conflict" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: | + You cannot remove a running container: c2ada9df5af8. Stop the + container before attempting removal or force remove + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "v" + in: "query" + description: "Remove anonymous volumes associated with the container." + type: "boolean" + default: false + - name: "force" + in: "query" + description: "If the container is running, kill it before removing it." + type: "boolean" + default: false + - name: "link" + in: "query" + description: "Remove the specified link associated with the container." + type: "boolean" + default: false + tags: ["Container"] + /containers/{id}/archive: + head: + summary: "Get information about files in a container" + description: | + A response header `X-Docker-Container-Path-Stat` is returned, containing + a base64 - encoded JSON object with some filesystem header information + about the path. + operationId: "ContainerArchiveInfo" + responses: + 200: + description: "no error" + headers: + X-Docker-Container-Path-Stat: + type: "string" + description: | + A base64 - encoded JSON object with some filesystem header + information about the path + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Container or path does not exist" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "path" + in: "query" + required: true + description: "Resource in the container’s filesystem to archive." + type: "string" + tags: ["Container"] + get: + summary: "Get an archive of a filesystem resource in a container" + description: "Get a tar archive of a resource in the filesystem of container id." + operationId: "ContainerArchive" + produces: ["application/x-tar"] + responses: + 200: + description: "no error" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Container or path does not exist" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "path" + in: "query" + required: true + description: "Resource in the container’s filesystem to archive." + type: "string" + tags: ["Container"] + put: + summary: "Extract an archive of files or folders to a directory in a container" + description: | + Upload a tar archive to be extracted to a path in the filesystem of container id. + `path` parameter is asserted to be a directory. If it exists as a file, 400 error + will be returned with message "not a directory". + operationId: "PutContainerArchive" + consumes: ["application/x-tar", "application/octet-stream"] + responses: + 200: + description: "The content was extracted successfully" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "not a directory" + 403: + description: "Permission denied, the volume or container rootfs is marked as read-only." + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "No such container or path does not exist inside the container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the container" + type: "string" + - name: "path" + in: "query" + required: true + description: "Path to a directory in the container to extract the archive’s contents into. " + type: "string" + - name: "noOverwriteDirNonDir" + in: "query" + description: | + If `1`, `true`, or `True` then it will be an error if unpacking the + given content would cause an existing directory to be replaced with + a non-directory and vice versa. + type: "string" + - name: "copyUIDGID" + in: "query" + description: | + If `1`, `true`, then it will copy UID/GID maps to the dest file or + dir + type: "string" + - name: "inputStream" + in: "body" + required: true + description: | + The input stream must be a tar archive compressed with one of the + following algorithms: `identity` (no compression), `gzip`, `bzip2`, + or `xz`. + schema: + type: "string" + format: "binary" + tags: ["Container"] + /containers/prune: + post: + summary: "Delete stopped containers" + produces: + - "application/json" + operationId: "ContainerPrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `until=` Prune containers created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune containers with (or without, in case `label!=...` is used) the specified labels. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "ContainerPruneResponse" + properties: + ContainersDeleted: + description: "Container IDs that were deleted" + type: "array" + items: + type: "string" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Container"] + /images/json: + get: + summary: "List Images" + description: "Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image." + operationId: "ImageList" + produces: + - "application/json" + responses: + 200: + description: "Summary image data for the images matching the query" + schema: + type: "array" + items: + $ref: "#/definitions/ImageSummary" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "all" + in: "query" + description: "Show all images. Only images from a final layer (no children) are shown by default." + type: "boolean" + default: false + - name: "filters" + in: "query" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the images list. + + Available filters: + + - `before`=(`[:]`, `` or ``) + - `dangling=true` + - `label=key` or `label="key=value"` of an image label + - `reference`=(`[:]`) + - `since`=(`[:]`, `` or ``) + - `until=` + type: "string" + - name: "shared-size" + in: "query" + description: "Compute and show shared size as a `SharedSize` field on each image." + type: "boolean" + default: false + - name: "digests" + in: "query" + description: "Show digest information as a `RepoDigests` field on each image." + type: "boolean" + default: false + - name: "manifests" + in: "query" + description: "Include `Manifests` in the image summary." + type: "boolean" + default: false + tags: ["Image"] + /build: + post: + summary: "Build an image" + 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](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. + operationId: "ImageBuild" + consumes: + - "application/octet-stream" + produces: + - "application/json" + parameters: + - name: "inputStream" + in: "body" + description: "A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz." + schema: + type: "string" + format: "binary" + - name: "dockerfile" + in: "query" + description: "Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`." + type: "string" + default: "Dockerfile" + - name: "t" + in: "query" + description: "A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters." + type: "string" + - name: "extrahosts" + in: "query" + description: "Extra hosts to add to /etc/hosts" + type: "string" + - name: "remote" + in: "query" + description: "A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball." + type: "string" + - name: "q" + in: "query" + description: "Suppress verbose build output." + type: "boolean" + default: false + - name: "nocache" + in: "query" + description: "Do not use the cache when building the image." + type: "boolean" + default: false + - name: "cachefrom" + in: "query" + description: "JSON array of images used for build cache resolution." + type: "string" + - name: "pull" + in: "query" + description: "Attempt to pull the image even if an older image exists locally." + type: "string" + - name: "rm" + in: "query" + description: "Remove intermediate containers after a successful build." + type: "boolean" + default: true + - name: "forcerm" + in: "query" + description: "Always remove intermediate containers, even upon failure." + type: "boolean" + default: false + - name: "memory" + in: "query" + description: "Set memory limit for build." + type: "integer" + - name: "memswap" + in: "query" + description: "Total memory (memory + swap). Set as `-1` to disable swap." + type: "integer" + - name: "cpushares" + in: "query" + description: "CPU shares (relative weight)." + type: "integer" + - name: "cpusetcpus" + in: "query" + description: "CPUs in which to allow execution (e.g., `0-3`, `0,1`)." + type: "string" + - name: "cpuperiod" + in: "query" + description: "The length of a CPU period in microseconds." + type: "integer" + - name: "cpuquota" + in: "query" + description: "Microseconds of CPU time that the container can get in a CPU period." + type: "integer" + - name: "buildargs" + in: "query" + description: > + 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) + type: "string" + - name: "shmsize" + in: "query" + description: "Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB." + type: "integer" + - name: "squash" + in: "query" + description: "Squash the resulting images layers into a single layer. *(Experimental release only.)*" + type: "boolean" + - name: "labels" + in: "query" + description: "Arbitrary key/value labels to set on the image, as a JSON map of string pairs." + type: "string" + - name: "networkmode" + in: "query" + description: | + Sets the networking mode for the run commands during build. Supported + standard values are: `bridge`, `host`, `none`, and `container:`. + Any other value is taken as a custom network's name or ID to which this + container should connect to. + type: "string" + - name: "Content-type" + in: "header" + type: "string" + enum: + - "application/x-tar" + default: "application/x-tar" + - name: "X-Registry-Config" + in: "header" + description: | + This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to. + + The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example: + + ``` + { + "docker.example.com": { + "username": "janedoe", + "password": "hunter2" + }, + "https://index.docker.io/v1/": { + "username": "mobydock", + "password": "conta1n3rize14" + } + } + ``` + + Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API. + type: "string" + - name: "platform" + in: "query" + description: "Platform in the format os[/arch[/variant]]" + type: "string" + default: "" + - name: "target" + in: "query" + description: "Target build stage" + type: "string" + default: "" + - name: "outputs" + in: "query" + description: | + BuildKit output configuration in the format of a stringified JSON array of objects. + Each object must have two top-level properties: `Type` and `Attrs`. + The `Type` property must be set to 'moby'. + The `Attrs` property is a map of attributes for the BuildKit output configuration. + See https://docs.docker.com/build/exporters/oci-docker/ for more information. + + Example: + + ``` + [{"Type":"moby","Attrs":{"type":"image","force-compression":"true","compression":"zstd"}}] + ``` + type: "string" + default: "" + - name: "version" + in: "query" + type: "string" + default: "1" + enum: ["1", "2"] + description: | + Version of the builder backend to use. + + - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) + - `2` is [BuildKit](https://github.com/moby/buildkit) + responses: + 200: + description: "no error" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Image"] + /build/prune: + post: + summary: "Delete builder cache" + produces: + - "application/json" + operationId: "BuildPrune" + parameters: + - name: "reserved-space" + in: "query" + description: "Amount of disk space in bytes to keep for cache" + type: "integer" + format: "int64" + - name: "max-used-space" + in: "query" + description: "Maximum amount of disk space allowed to keep for cache" + type: "integer" + format: "int64" + - name: "min-free-space" + in: "query" + description: "Target amount of free disk space after pruning" + type: "integer" + format: "int64" + - name: "all" + in: "query" + type: "boolean" + description: "Remove all types of build cache" + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the list of build cache objects. + + Available filters: + + - `until=` remove cache older than ``. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time. + - `id=` + - `parent=` + - `type=` + - `description=` + - `inuse` + - `shared` + - `private` + responses: + 200: + description: "No error" + schema: + type: "object" + title: "BuildPruneResponse" + properties: + CachesDeleted: + type: "array" + items: + description: "ID of build cache object" + type: "string" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Image"] + /images/create: + post: + summary: "Create an image" + description: "Pull or import an image." + operationId: "ImageCreate" + consumes: + - "text/plain" + - "application/octet-stream" + produces: + - "application/json" + responses: + 200: + description: "no error" + 404: + description: "repository does not exist or no read access" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "fromImage" + in: "query" + description: | + Name of the image to pull. If the name includes a tag or digest, specific behavior applies: + + - If only `fromImage` includes a tag, that tag is used. + - If both `fromImage` and `tag` are provided, `tag` takes precedence. + - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is ignored. + - If neither a tag nor digest is specified, all tags are pulled. + type: "string" + - name: "fromSrc" + in: "query" + description: "Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image." + type: "string" + - name: "repo" + in: "query" + description: "Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image." + type: "string" + - name: "tag" + in: "query" + description: "Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled." + type: "string" + - name: "message" + in: "query" + description: "Set commit message for imported image." + type: "string" + - name: "inputImage" + in: "body" + description: "Image content if the value `-` has been specified in fromSrc query parameter" + schema: + type: "string" + required: false + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration. + + 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]]. + + When used in combination with the `fromImage` option, the daemon checks + if the given image is present in the local image cache with the given + OS and Architecture, and otherwise attempts to pull the image. If the + option is not set, the host's native OS and Architecture are used. + If the given image does not exist in the local image cache, the daemon + attempts to pull the image with the host's native OS and Architecture. + If the given image does exists in the local image cache, but its OS or + architecture does not match, a warning is produced. + + When used with the `fromSrc` option to import an image from an archive, + this option sets the platform information for the imported image. If + the option is not set, the host's native OS and Architecture are used + for the imported image. + type: "string" + default: "" + tags: ["Image"] + /images/{name}/json: + get: + summary: "Inspect an image" + description: "Return low-level information about an image." + operationId: "ImageInspect" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/ImageInspect" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such image: someimage (tag: latest)" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or id" + type: "string" + required: true + - name: "manifests" + in: "query" + description: "Include Manifests in the image summary." + type: "boolean" + default: false + required: false + tags: ["Image"] + /images/{name}/history: + get: + summary: "Get the history of an image" + description: "Return parent layers of an image." + operationId: "ImageHistory" + produces: ["application/json"] + responses: + 200: + description: "List of image layers" + schema: + type: "array" + items: + type: "object" + x-go-name: HistoryResponseItem + title: "HistoryResponseItem" + description: "individual image layer information in response to ImageHistory operation" + required: [Id, Created, CreatedBy, Tags, Size, Comment] + properties: + Id: + type: "string" + x-nullable: false + Created: + type: "integer" + format: "int64" + x-nullable: false + CreatedBy: + type: "string" + x-nullable: false + Tags: + type: "array" + items: + type: "string" + x-nullable: true + Size: + type: "integer" + format: "int64" + x-nullable: false + Comment: + type: "string" + x-nullable: false + examples: + application/json: + - Id: "3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710" + Created: 1398108230 + CreatedBy: "/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /" + Tags: + - "ubuntu:lucid" + - "ubuntu:10.04" + Size: 182964289 + Comment: "" + - Id: "6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8" + Created: 1398108222 + CreatedBy: "/bin/sh -c #(nop) MAINTAINER Tianon Gravi - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/" + Tags: [] + Size: 0 + Comment: "" + - Id: "511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158" + Created: 1371157430 + CreatedBy: "" + Tags: + - "scratch12:latest" + - "scratch:latest" + Size: 0 + Comment: "Imported from -" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID" + type: "string" + required: true + - name: "platform" + type: "string" + in: "query" + description: | + JSON-encoded OCI platform to select the platform-variant. + If omitted, it defaults to any locally available platform, + prioritizing the daemon's host platform. + + If the daemon provides a multi-platform image store, this selects + the platform-variant to show the history for. If the image is + a single-platform image, or if the multi-platform image does not + provide a variant matching the given platform, an error is returned. + + Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}` + tags: ["Image"] + /images/{name}/push: + post: + summary: "Push an image" + description: | + Push an image to a registry. + + If you wish to push an image on to a private registry, that image must + already have a tag which references the registry. For example, + `registry.example.com/myimage:latest`. + + The push is cancelled if the HTTP connection is closed. + operationId: "ImagePush" + consumes: + - "application/octet-stream" + responses: + 200: + description: "No error" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + Name of the image to push. For example, `registry.example.com/myimage`. + The image must be present in the local image store with the same name. + + The name should be provided without tag; if a tag is provided, it + is ignored. For example, `registry.example.com/myimage:latest` is + considered equivalent to `registry.example.com/myimage`. + + Use the `tag` parameter to specify the tag to push. + type: "string" + required: true + - name: "tag" + in: "query" + description: | + Tag of the image to push. For example, `latest`. If no tag is provided, + all tags of the given image that are present in the local image store + are pushed. + type: "string" + - name: "platform" + type: "string" + in: "query" + description: | + JSON-encoded OCI platform to select the platform-variant to push. + If not provided, all available variants will attempt to be pushed. + + If the daemon provides a multi-platform image store, this selects + the platform-variant to push to the registry. If the image is + a single-platform image, or if the multi-platform image does not + provide a variant matching the given platform, an error is returned. + + Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}` + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + required: true + tags: ["Image"] + /images/{name}/tag: + post: + summary: "Tag an image" + description: "Tag an image so that it becomes part of a repository." + operationId: "ImageTag" + responses: + 201: + description: "No error" + 400: + description: "Bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Conflict" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID to tag." + type: "string" + required: true + - name: "repo" + in: "query" + description: "The repository to tag in. For example, `someuser/someimage`." + type: "string" + - name: "tag" + in: "query" + description: "The name of the new tag." + type: "string" + tags: ["Image"] + /images/{name}: + delete: + summary: "Remove an image" + description: | + Remove an image, along with any untagged parent images that were + referenced by that image. + + Images can't be removed if they have descendant images, are being + used by a running container or are being used by a build. + operationId: "ImageDelete" + produces: ["application/json"] + responses: + 200: + description: "The image was deleted successfully" + schema: + type: "array" + items: + $ref: "#/definitions/ImageDeleteResponseItem" + examples: + application/json: + - Untagged: "3e2f21a89f" + - Deleted: "3e2f21a89f" + - Deleted: "53b4f83ac9" + 404: + description: "No such image" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Conflict" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID" + type: "string" + required: true + - name: "force" + in: "query" + description: "Remove the image even if it is being used by stopped containers or has other tags" + type: "boolean" + default: false + - name: "noprune" + in: "query" + description: "Do not delete untagged parent images" + type: "boolean" + default: false + - name: "platforms" + in: "query" + description: | + Select platform-specific content to delete. + Multiple values are accepted. + Each platform is a OCI platform encoded as a JSON string. + type: "array" + items: + # This should be OCIPlatform + # but $ref is not supported for array in query in Swagger 2.0 + # $ref: "#/definitions/OCIPlatform" + type: "string" + tags: ["Image"] + /images/search: + get: + summary: "Search images" + description: "Search for an image on Docker Hub." + operationId: "ImageSearch" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + type: "array" + items: + type: "object" + title: "ImageSearchResponseItem" + properties: + description: + type: "string" + is_official: + type: "boolean" + is_automated: + description: | + Whether this repository has automated builds enabled. + +


+ + > **Deprecated**: This field is deprecated and will always be "false". + type: "boolean" + example: false + name: + type: "string" + star_count: + type: "integer" + examples: + application/json: + - description: "A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!" + is_official: true + is_automated: false + name: "alpine" + star_count: 10093 + - description: "Busybox base image." + is_official: true + is_automated: false + name: "Busybox base image." + star_count: 3037 + - description: "The PostgreSQL object-relational database system provides reliability and data integrity." + is_official: true + is_automated: false + name: "postgres" + star_count: 12408 + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "term" + in: "query" + description: "Term to search" + type: "string" + required: true + - name: "limit" + in: "query" + description: "Maximum number of results to return" + type: "integer" + - name: "filters" + in: "query" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: + + - `is-official=(true|false)` + - `stars=` Matches images that has at least 'number' stars. + type: "string" + tags: ["Image"] + /images/prune: + post: + summary: "Delete unused images" + produces: + - "application/json" + operationId: "ImagePrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: + + - `dangling=` When set to `true` (or `1`), prune only + unused *and* untagged images. When set to `false` + (or `0`), all unused images are pruned. + - `until=` Prune images created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune images with (or without, in case `label!=...` is used) the specified labels. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "ImagePruneResponse" + properties: + ImagesDeleted: + description: "Images that were deleted" + type: "array" + items: + $ref: "#/definitions/ImageDeleteResponseItem" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Image"] + /auth: + post: + summary: "Check auth configuration" + description: | + Validate credentials for a registry and, if available, get an identity + token for accessing the registry without password. + operationId: "SystemAuth" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "An identity token was generated successfully." + schema: + $ref: "#/definitions/AuthResponse" + 204: + description: "No error" + 401: + description: "Auth error" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "authConfig" + in: "body" + description: "Authentication to check" + schema: + $ref: "#/definitions/AuthConfig" + tags: ["System"] + /info: + get: + summary: "Get system information" + operationId: "SystemInfo" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/SystemInfo" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["System"] + /version: + get: + summary: "Get version" + description: "Returns the version of Docker that is running and various information about the system that Docker is running on." + operationId: "SystemVersion" + produces: ["application/json"] + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/SystemVersion" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["System"] + /_ping: + get: + summary: "Ping" + description: "This is a dummy endpoint you can use to test if the server is accessible." + operationId: "SystemPing" + produces: ["text/plain"] + responses: + 200: + description: "no error" + schema: + type: "string" + example: "OK" + headers: + Api-Version: + type: "string" + description: "Max API Version the server supports" + Builder-Version: + type: "string" + description: | + Default version of docker image builder + + The default on Linux is version "2" (BuildKit), but the daemon + can be configured to recommend version "1" (classic Builder). + Windows does not yet support BuildKit for native Windows images, + and uses "1" (classic builder) as a default. + + This value is a recommendation as advertised by the daemon, and + it is up to the client to choose which builder to use. + default: "2" + Docker-Experimental: + type: "boolean" + description: "If the server is running with experimental mode enabled" + Swarm: + type: "string" + enum: ["inactive", "pending", "error", "locked", "active/worker", "active/manager"] + description: | + Contains information about Swarm status of the daemon, + and if the daemon is acting as a manager or worker node. + default: "inactive" + Cache-Control: + type: "string" + default: "no-cache, no-store, must-revalidate" + Pragma: + type: "string" + default: "no-cache" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + headers: + Cache-Control: + type: "string" + default: "no-cache, no-store, must-revalidate" + Pragma: + type: "string" + default: "no-cache" + tags: ["System"] + head: + summary: "Ping" + description: "This is a dummy endpoint you can use to test if the server is accessible." + operationId: "SystemPingHead" + produces: ["text/plain"] + responses: + 200: + description: "no error" + schema: + type: "string" + example: "(empty)" + headers: + Api-Version: + type: "string" + description: "Max API Version the server supports" + Builder-Version: + type: "string" + description: "Default version of docker image builder" + Docker-Experimental: + type: "boolean" + description: "If the server is running with experimental mode enabled" + Swarm: + type: "string" + enum: ["inactive", "pending", "error", "locked", "active/worker", "active/manager"] + description: | + Contains information about Swarm status of the daemon, + and if the daemon is acting as a manager or worker node. + default: "inactive" + Cache-Control: + type: "string" + default: "no-cache, no-store, must-revalidate" + Pragma: + type: "string" + default: "no-cache" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["System"] + /commit: + post: + summary: "Create a new image from a container" + operationId: "ImageCommit" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IDResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "containerConfig" + in: "body" + description: "The container configuration" + schema: + $ref: "#/definitions/ContainerConfig" + - name: "container" + in: "query" + description: "The ID or name of the container to commit" + type: "string" + - name: "repo" + in: "query" + description: "Repository name for the created image" + type: "string" + - name: "tag" + in: "query" + description: "Tag name for the create image" + type: "string" + - name: "comment" + in: "query" + description: "Commit message" + type: "string" + - name: "author" + in: "query" + description: "Author of the image (e.g., `John Hannibal Smith `)" + type: "string" + - name: "pause" + in: "query" + description: "Whether to pause the container before committing" + type: "boolean" + default: true + - name: "changes" + in: "query" + description: "`Dockerfile` instructions to apply while committing" + type: "string" + tags: ["Image"] + /events: + get: + summary: "Monitor events" + description: | + Stream real-time events from the server. + + Various objects within Docker report events when something happens to them. + + Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune` + + Images report these events: `create`, `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune` + + Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune` + + Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune` + + The Docker daemon reports these events: `reload` + + Services report these events: `create`, `update`, and `remove` + + Nodes report these events: `create`, `update`, and `remove` + + Secrets report these events: `create`, `update`, and `remove` + + Configs report these events: `create`, `update`, and `remove` + + The Builder reports `prune` events + + operationId: "SystemEvents" + produces: + - "application/x-ndjson" + - "application/json-seq" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/EventMessage" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "since" + in: "query" + description: "Show events created since this timestamp then stream new events." + type: "string" + - name: "until" + in: "query" + description: "Show events created until this timestamp then stop streaming." + type: "string" + - name: "filters" + in: "query" + description: | + 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 + type: "string" + tags: ["System"] + /system/df: + get: + summary: "Get data usage information" + operationId: "SystemDataUsage" + responses: + 200: + description: "no error" + schema: + type: "object" + title: "SystemDataUsageResponse" + properties: + ImagesDiskUsage: + $ref: "#/definitions/ImagesDiskUsage" + ContainersDiskUsage: + $ref: "#/definitions/ContainersDiskUsage" + VolumesDiskUsage: + $ref: "#/definitions/VolumesDiskUsage" + BuildCacheDiskUsage: + $ref: "#/definitions/BuildCacheDiskUsage" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "type" + in: "query" + description: | + Object types, for which to compute and return data. + type: "array" + collectionFormat: multi + items: + type: "string" + enum: ["container", "image", "volume", "build-cache"] + - name: "verbose" + in: "query" + description: | + Show detailed information on space usage. + type: "boolean" + default: false + tags: ["System"] + /images/{name}/get: + get: + summary: "Export an image" + description: | + Get a tarball containing all images and metadata for a repository. + + If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced. + + ### Image tarball format + + An image tarball contains [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content). + + Additionally, includes the manifest.json file associated with a backwards compatible docker save format. + + If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs. + + ```json + { + "hello-world": { + "latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1" + } + } + ``` + operationId: "ImageGet" + produces: + - "application/x-tar" + responses: + 200: + description: "no error" + schema: + type: "string" + format: "binary" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or ID" + type: "string" + required: true + - name: "platform" + type: "array" + items: + type: "string" + collectionFormat: "multi" + in: "query" + description: | + JSON encoded OCI platform describing a platform which will be used + to select a platform-specific image to be saved if the image is + multi-platform. + If not provided, the full multi-platform image will be saved. + + Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}` + tags: ["Image"] + /images/get: + get: + summary: "Export several images" + description: | + Get a tarball containing all images and metadata for several image + repositories. + + For each value of the `names` parameter: if it is a specific name and + tag (e.g. `ubuntu:latest`), then only that image (and its parents) are + returned; if it is an image ID, similarly only that image (and its parents) + are returned and there would be no names referenced in the 'repositories' + file for this image ID. + + For details on the format, see the [export image endpoint](#operation/ImageGet). + operationId: "ImageGetAll" + produces: + - "application/x-tar" + responses: + 200: + description: "no error" + schema: + type: "string" + format: "binary" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "names" + in: "query" + description: "Image names to filter by" + type: "array" + items: + type: "string" + - name: "platform" + type: "array" + items: + type: "string" + collectionFormat: "multi" + in: "query" + description: | + JSON encoded OCI platform(s) which will be used to select the + platform-specific image(s) to be saved if the image is + multi-platform. If not provided, the full multi-platform image + will be saved. + + Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}` + tags: ["Image"] + /images/load: + post: + summary: "Import images" + description: | + Load a set of images and tags into a repository. + + For details on the format, see the [export image endpoint](#operation/ImageGet). + operationId: "ImageLoad" + consumes: + - "application/x-tar" + produces: + - "application/json" + responses: + 200: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "imagesTarball" + in: "body" + description: "Tar archive containing images" + schema: + type: "string" + format: "binary" + - name: "quiet" + in: "query" + description: "Suppress progress details during load." + type: "boolean" + default: false + - name: "platform" + type: "array" + items: + type: "string" + collectionFormat: "multi" + in: "query" + description: | + JSON encoded OCI platform(s) which will be used to select the + platform-specific image(s) to load if the image is + multi-platform. If not provided, the full multi-platform image + will be loaded. + + Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}` + tags: ["Image"] + /containers/{id}/exec: + post: + summary: "Create an exec instance" + description: "Run a command inside a running container." + operationId: "ContainerExec" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IDResponse" + 404: + description: "no such container" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such container: c2ada9df5af8" + 409: + description: "container is paused" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "execConfig" + in: "body" + description: "Exec configuration" + schema: + type: "object" + title: "ExecConfig" + properties: + AttachStdin: + type: "boolean" + description: "Attach to `stdin` of the exec command." + AttachStdout: + type: "boolean" + description: "Attach to `stdout` of the exec command." + AttachStderr: + type: "boolean" + description: "Attach to `stderr` of the exec command." + ConsoleSize: + type: "array" + description: "Initial console size, as an `[height, width]` array." + x-nullable: true + minItems: 2 + maxItems: 2 + items: + type: "integer" + minimum: 0 + example: [80, 64] + DetachKeys: + type: "string" + description: | + Override the key sequence for detaching a container. Format is + a single character `[a-Z]` or `ctrl-` where `` + is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. + Tty: + type: "boolean" + description: "Allocate a pseudo-TTY." + Env: + description: | + A list of environment variables in the form `["VAR=value", ...]`. + type: "array" + items: + type: "string" + Cmd: + type: "array" + description: "Command to run, as a string or array of strings." + items: + type: "string" + Privileged: + type: "boolean" + description: "Runs the exec process with extended privileges." + default: false + User: + type: "string" + description: | + The user, and optionally, group to run the exec process inside + the container. Format is one of: `user`, `user:group`, `uid`, + or `uid:gid`. + WorkingDir: + type: "string" + description: | + The working directory for the exec process inside the container. + example: + AttachStdin: false + AttachStdout: true + AttachStderr: true + DetachKeys: "ctrl-p,ctrl-q" + Tty: false + Cmd: + - "date" + Env: + - "FOO=bar" + - "BAZ=quux" + required: true + - name: "id" + in: "path" + description: "ID or name of container" + type: "string" + required: true + tags: ["Exec"] + /exec/{id}/start: + post: + summary: "Start an exec instance" + description: | + Starts a previously set up exec instance. If detach is true, this endpoint + returns immediately after starting the command. Otherwise, it sets up an + interactive session with the command. + operationId: "ExecStart" + consumes: + - "application/json" + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + responses: + 200: + description: "No error" + 404: + description: "No such exec instance" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Container is stopped or paused" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "execStartConfig" + in: "body" + schema: + type: "object" + title: "ExecStartConfig" + properties: + Detach: + type: "boolean" + description: "Detach from the command." + example: false + Tty: + type: "boolean" + description: "Allocate a pseudo-TTY." + example: true + ConsoleSize: + type: "array" + description: "Initial console size, as an `[height, width]` array." + x-nullable: true + minItems: 2 + maxItems: 2 + items: + type: "integer" + minimum: 0 + example: [80, 64] + - name: "id" + in: "path" + description: "Exec instance ID" + required: true + type: "string" + tags: ["Exec"] + /exec/{id}/resize: + post: + summary: "Resize an exec instance" + description: | + Resize the TTY session used by an exec instance. This endpoint only works + if `tty` was specified as part of creating and starting the exec instance. + operationId: "ExecResize" + responses: + 200: + description: "No error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "No such exec instance" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Exec instance ID" + required: true + type: "string" + - name: "h" + in: "query" + required: true + description: "Height of the TTY session in characters" + type: "integer" + - name: "w" + in: "query" + required: true + description: "Width of the TTY session in characters" + type: "integer" + tags: ["Exec"] + /exec/{id}/json: + get: + summary: "Inspect an exec instance" + description: "Return low-level information about an exec instance." + operationId: "ExecInspect" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "ExecInspectResponse" + properties: + CanRemove: + type: "boolean" + DetachKeys: + type: "string" + ID: + type: "string" + Running: + type: "boolean" + ExitCode: + type: "integer" + ProcessConfig: + $ref: "#/definitions/ProcessConfig" + OpenStdin: + type: "boolean" + OpenStderr: + type: "boolean" + OpenStdout: + type: "boolean" + ContainerID: + type: "string" + Pid: + type: "integer" + description: "The system process ID for the exec process." + examples: + application/json: + CanRemove: false + ContainerID: "b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126" + DetachKeys: "" + ExitCode: 2 + ID: "f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b" + OpenStderr: true + OpenStdin: true + OpenStdout: true + ProcessConfig: + arguments: + - "-c" + - "exit 2" + entrypoint: "sh" + privileged: false + tty: true + user: "1000" + Running: false + Pid: 42000 + 404: + description: "No such exec instance" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Exec instance ID" + required: true + type: "string" + tags: ["Exec"] + + /volumes: + get: + summary: "List volumes" + operationId: "VolumeList" + produces: ["application/json"] + responses: + 200: + description: "Summary volume data that matches the query" + schema: + $ref: "#/definitions/VolumeListResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + description: | + JSON encoded value of the filters (a `map[string][]string`) to + process on the volumes list. Available filters: + + - `dangling=` When set to `true` (or `1`), returns all + volumes that are not in use by a container. When set to `false` + (or `0`), only volumes that are in use by one or more + containers are returned. + - `driver=` Matches volumes based on their driver. + - `label=` or `label=:` Matches volumes based on + the presence of a `label` alone or a `label` and a value. + - `name=` Matches all or part of a volume name. + type: "string" + format: "json" + tags: ["Volume"] + + /volumes/create: + post: + summary: "Create a volume" + operationId: "VolumeCreate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 201: + description: "The volume was created successfully" + schema: + $ref: "#/definitions/Volume" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "volumeConfig" + in: "body" + required: true + description: "Volume configuration" + schema: + $ref: "#/definitions/VolumeCreateRequest" + tags: ["Volume"] + + /volumes/{name}: + get: + summary: "Inspect a volume" + operationId: "VolumeInspect" + produces: ["application/json"] + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/Volume" + 404: + description: "No such volume" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + required: true + description: "Volume name or ID" + type: "string" + tags: ["Volume"] + + put: + summary: | + "Update a volume. Valid only for Swarm cluster volumes" + operationId: "VolumeUpdate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such volume" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "The name or ID of the volume" + type: "string" + required: true + - name: "body" + in: "body" + schema: + # though the schema for is an object that contains only a + # ClusterVolumeSpec, wrapping the ClusterVolumeSpec in this object + # means that if, later on, we support things like changing the + # labels, we can do so without duplicating that information to the + # ClusterVolumeSpec. + type: "object" + description: "Volume configuration" + properties: + Spec: + $ref: "#/definitions/ClusterVolumeSpec" + description: | + The spec of the volume to update. Currently, only Availability may + change. All other fields must remain unchanged. + - name: "version" + in: "query" + description: | + The version number of the volume being updated. This is required to + avoid conflicting writes. Found in the volume's `ClusterVolume` + field. + type: "integer" + format: "int64" + required: true + tags: ["Volume"] + + delete: + summary: "Remove a volume" + description: "Instruct the driver to remove the volume." + operationId: "VolumeDelete" + responses: + 204: + description: "The volume was removed" + 404: + description: "No such volume or volume driver" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "Volume is in use and cannot be removed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + required: true + description: "Volume name or ID" + type: "string" + - name: "force" + in: "query" + description: "Force the removal of the volume" + type: "boolean" + default: false + tags: ["Volume"] + + /volumes/prune: + post: + summary: "Delete unused volumes" + produces: + - "application/json" + operationId: "VolumePrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune volumes with (or without, in case `label!=...` is used) the specified labels. + - `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "VolumePruneResponse" + properties: + VolumesDeleted: + description: "Volumes that were deleted" + type: "array" + items: + type: "string" + SpaceReclaimed: + description: "Disk space reclaimed in bytes" + type: "integer" + format: "int64" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Volume"] + /networks: + get: + summary: "List networks" + description: | + Returns a list of networks. For details on the format, see the + [network inspect endpoint](#operation/NetworkInspect). + + Note that it uses a different, smaller representation of a network than + inspecting a single network. For example, the list of containers attached + to the network is not propagated in API versions 1.28 and up. + operationId: "NetworkList" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + type: "array" + items: + $ref: "#/definitions/NetworkSummary" + examples: + application/json: + - Name: "bridge" + Id: "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566" + Created: "2016-10-19T06:21:00.416543526Z" + Scope: "local" + Driver: "bridge" + EnableIPv4: true + EnableIPv6: false + Internal: false + Attachable: false + Ingress: false + IPAM: + Driver: "default" + Config: + - + Subnet: "172.17.0.0/16" + Options: + com.docker.network.bridge.default_bridge: "true" + com.docker.network.bridge.enable_icc: "true" + com.docker.network.bridge.enable_ip_masquerade: "true" + com.docker.network.bridge.host_binding_ipv4: "0.0.0.0" + com.docker.network.bridge.name: "docker0" + com.docker.network.driver.mtu: "1500" + - Name: "none" + Id: "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794" + Created: "0001-01-01T00:00:00Z" + Scope: "local" + Driver: "null" + EnableIPv4: false + EnableIPv6: false + Internal: false + Attachable: false + Ingress: false + IPAM: + Driver: "default" + Config: [] + Containers: {} + Options: {} + - Name: "host" + Id: "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e" + Created: "0001-01-01T00:00:00Z" + Scope: "local" + Driver: "host" + EnableIPv4: false + EnableIPv6: false + Internal: false + Attachable: false + Ingress: false + IPAM: + Driver: "default" + Config: [] + Containers: {} + Options: {} + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + description: | + JSON encoded value of the filters (a `map[string][]string`) to process + on the networks list. + + Available filters: + + - `dangling=` When set to `true` (or `1`), returns all + networks that are not in use by a container. When set to `false` + (or `0`), only networks that are in use by one or more + containers are returned. + - `driver=` Matches a network's driver. + - `id=` Matches all or part of a network ID. + - `label=` or `label==` of a network label. + - `name=` Matches all or part of a network name. + - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`, `global`, or `local`). + - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks. + type: "string" + tags: ["Network"] + + /networks/{id}: + get: + summary: "Inspect a network" + operationId: "NetworkInspect" + produces: + - "application/json" + responses: + 200: + description: "No error" + schema: + $ref: "#/definitions/NetworkInspect" + 404: + description: "Network not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + - name: "verbose" + in: "query" + description: "Detailed inspect output for troubleshooting" + type: "boolean" + default: false + - name: "scope" + in: "query" + description: "Filter the network by scope (swarm, global, or local)" + type: "string" + tags: ["Network"] + + delete: + summary: "Remove a network" + operationId: "NetworkDelete" + responses: + 204: + description: "No error" + 403: + description: "operation not supported for pre-defined networks" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such network" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + tags: ["Network"] + + /networks/create: + post: + summary: "Create a network" + operationId: "NetworkCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "Network created successfully" + schema: + $ref: "#/definitions/NetworkCreateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 403: + description: | + Forbidden operation. This happens when trying to create a network named after a pre-defined network, + or when trying to create an overlay network on a daemon which is not part of a Swarm cluster. + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "plugin not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "networkConfig" + in: "body" + description: "Network configuration" + required: true + schema: + type: "object" + title: "NetworkCreateRequest" + required: ["Name"] + properties: + Name: + description: "The network's name." + type: "string" + example: "my_network" + Driver: + description: "Name of the network driver plugin to use." + type: "string" + default: "bridge" + example: "bridge" + Scope: + description: | + The level at which the network exists (e.g. `swarm` for cluster-wide + or `local` for machine level). + type: "string" + Internal: + description: "Restrict external access to the network." + type: "boolean" + Attachable: + description: | + Globally scoped network is manually attachable by regular + containers from workers in swarm mode. + type: "boolean" + example: true + Ingress: + description: | + Ingress network is the network which provides the routing-mesh + in swarm mode. + type: "boolean" + example: false + ConfigOnly: + description: | + Creates a config-only network. Config-only networks are placeholder + networks for network configurations to be used by other networks. + Config-only networks cannot be used directly to run containers + or services. + type: "boolean" + default: false + example: false + ConfigFrom: + description: | + Specifies the source which will provide the configuration for + this network. The specified network must be an existing + config-only network; see ConfigOnly. + $ref: "#/definitions/ConfigReference" + IPAM: + description: "Optional custom IP scheme for the network." + $ref: "#/definitions/IPAM" + EnableIPv4: + description: "Enable IPv4 on the network." + type: "boolean" + example: true + EnableIPv6: + description: "Enable IPv6 on the network." + type: "boolean" + example: true + Options: + description: "Network specific options to be used by the drivers." + type: "object" + additionalProperties: + type: "string" + example: + com.docker.network.bridge.default_bridge: "true" + com.docker.network.bridge.enable_icc: "true" + com.docker.network.bridge.enable_ip_masquerade: "true" + com.docker.network.bridge.host_binding_ipv4: "0.0.0.0" + com.docker.network.bridge.name: "docker0" + com.docker.network.driver.mtu: "1500" + Labels: + description: "User-defined key/value metadata." + type: "object" + additionalProperties: + type: "string" + example: + com.example.some-label: "some-value" + com.example.some-other-label: "some-other-value" + tags: ["Network"] + + /networks/{id}/connect: + post: + summary: "Connect a container to a network" + description: "The network must be either a local-scoped network or a swarm-scoped network with the `attachable` option set. A network cannot be re-attached to a running container" + operationId: "NetworkConnect" + consumes: + - "application/json" + responses: + 200: + description: "No error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 403: + description: "Operation forbidden" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Network or container not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + - name: "container" + in: "body" + required: true + schema: + $ref: "#/definitions/NetworkConnectRequest" + tags: ["Network"] + + /networks/{id}/disconnect: + post: + summary: "Disconnect a container from a network" + operationId: "NetworkDisconnect" + consumes: + - "application/json" + responses: + 200: + description: "No error" + 403: + description: "Operation not supported for swarm scoped networks" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "Network or container not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "Network ID or name" + required: true + type: "string" + - name: "container" + in: "body" + required: true + schema: + $ref: "#/definitions/NetworkDisconnectRequest" + tags: ["Network"] + /networks/prune: + post: + summary: "Delete unused networks" + produces: + - "application/json" + operationId: "NetworkPrune" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the prune list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `until=` Prune networks created before this timestamp. The `` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. + - `label` (`label=`, `label==`, `label!=`, or `label!==`) Prune networks with (or without, in case `label!=...` is used) the specified labels. + type: "string" + responses: + 200: + description: "No error" + schema: + type: "object" + title: "NetworkPruneResponse" + properties: + NetworksDeleted: + description: "Networks that were deleted" + type: "array" + items: + type: "string" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Network"] + /plugins: + get: + summary: "List plugins" + operationId: "PluginList" + description: "Returns information about installed plugins." + produces: ["application/json"] + responses: + 200: + description: "No error" + schema: + type: "array" + items: + $ref: "#/definitions/Plugin" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the plugin list. + + Available filters: + + - `capability=` + - `enable=|` + tags: ["Plugin"] + + /plugins/privileges: + get: + summary: "Get plugin privileges" + operationId: "GetPluginPrivileges" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + example: + - Name: "network" + Description: "" + Value: + - "host" + - Name: "mount" + Description: "" + Value: + - "/data" + - Name: "device" + Description: "" + Value: + - "/dev/cpu_dma_latency" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "remote" + in: "query" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + tags: + - "Plugin" + + /plugins/pull: + post: + summary: "Install a plugin" + operationId: "PluginPull" + description: | + Pulls and installs a plugin. After the plugin is installed, it can be + enabled using the [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable). + produces: + - "application/json" + responses: + 204: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "remote" + in: "query" + description: | + Remote reference for plugin to install. + + The `:latest` tag is optional, and is used as the default if omitted. + required: true + type: "string" + - name: "name" + in: "query" + description: | + Local name for the pulled plugin. + + The `:latest` tag is optional, and is used as the default if omitted. + required: false + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration to use when pulling a plugin + from a registry. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + - name: "body" + in: "body" + schema: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + example: + - Name: "network" + Description: "" + Value: + - "host" + - Name: "mount" + Description: "" + Value: + - "/data" + - Name: "device" + Description: "" + Value: + - "/dev/cpu_dma_latency" + tags: ["Plugin"] + /plugins/{name}/json: + get: + summary: "Inspect a plugin" + operationId: "PluginInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Plugin" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + tags: ["Plugin"] + /plugins/{name}: + delete: + summary: "Remove a plugin" + operationId: "PluginDelete" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Plugin" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "force" + in: "query" + description: | + Disable the plugin before removing. This may result in issues if the + plugin is in use by a container. + type: "boolean" + default: false + tags: ["Plugin"] + /plugins/{name}/enable: + post: + summary: "Enable a plugin" + operationId: "PluginEnable" + responses: + 200: + description: "no error" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "timeout" + in: "query" + description: "Set the HTTP client timeout (in seconds)" + type: "integer" + default: 0 + tags: ["Plugin"] + /plugins/{name}/disable: + post: + summary: "Disable a plugin" + operationId: "PluginDisable" + responses: + 200: + description: "no error" + 404: + description: "plugin is not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" + tags: ["Plugin"] + /plugins/{name}/upgrade: + post: + summary: "Upgrade a plugin" + operationId: "PluginUpgrade" + responses: + 204: + description: "no error" + 404: + description: "plugin not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "remote" + in: "query" + description: | + Remote reference to upgrade to. + + The `:latest` tag is optional, and is used as the default if omitted. + required: true + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration to use when pulling a plugin + from a registry. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + - name: "body" + in: "body" + schema: + type: "array" + items: + $ref: "#/definitions/PluginPrivilege" + example: + - Name: "network" + Description: "" + Value: + - "host" + - Name: "mount" + Description: "" + Value: + - "/data" + - Name: "device" + Description: "" + Value: + - "/dev/cpu_dma_latency" + tags: ["Plugin"] + /plugins/create: + post: + summary: "Create a plugin" + operationId: "PluginCreate" + consumes: + - "application/x-tar" + responses: + 204: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "query" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "tarContext" + in: "body" + description: "Path to tar containing plugin rootfs and manifest" + schema: + type: "string" + format: "binary" + tags: ["Plugin"] + /plugins/{name}/push: + post: + summary: "Push a plugin" + operationId: "PluginPush" + description: | + Push a plugin to the registry. + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + responses: + 200: + description: "no error" + 404: + description: "plugin not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Plugin"] + /plugins/{name}/set: + post: + summary: "Configure a plugin" + operationId: "PluginSet" + consumes: + - "application/json" + parameters: + - name: "name" + in: "path" + description: | + The name of the plugin. The `:latest` tag is optional, and is the + default if omitted. + required: true + type: "string" + - name: "body" + in: "body" + schema: + type: "array" + items: + type: "string" + example: ["DEBUG=1"] + responses: + 204: + description: "No error" + 404: + description: "Plugin not installed" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Plugin"] + /nodes: + get: + summary: "List nodes" + operationId: "NodeList" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Node" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + description: | + Filters to process on the nodes list, encoded as JSON (a `map[string][]string`). + + Available filters: + - `id=` + - `label=` + - `membership=`(`accepted`|`pending`)` + - `name=` + - `node.label=` + - `role=`(`manager`|`worker`)` + type: "string" + tags: ["Node"] + /nodes/{id}: + get: + summary: "Inspect a node" + operationId: "NodeInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Node" + 404: + description: "no such node" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the node" + type: "string" + required: true + tags: ["Node"] + delete: + summary: "Delete a node" + operationId: "NodeDelete" + responses: + 200: + description: "no error" + 404: + description: "no such node" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the node" + type: "string" + required: true + - name: "force" + in: "query" + description: "Force remove a node from the swarm" + default: false + type: "boolean" + tags: ["Node"] + /nodes/{id}/update: + post: + summary: "Update a node" + operationId: "NodeUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such node" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID of the node" + type: "string" + required: true + - name: "body" + in: "body" + schema: + $ref: "#/definitions/NodeSpec" + - name: "version" + in: "query" + description: | + The version number of the node object being updated. This is required + to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + tags: ["Node"] + /swarm: + get: + summary: "Inspect swarm" + operationId: "SwarmInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Swarm" + 404: + description: "no such swarm" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Swarm"] + /swarm/init: + post: + summary: "Initialize a new swarm" + operationId: "SwarmInit" + produces: + - "application/json" + - "text/plain" + responses: + 200: + description: "no error" + schema: + description: "The node ID" + type: "string" + example: "7v2t30z9blmxuhnyo6s4cpenp" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is already part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + type: "object" + title: "SwarmInitRequest" + properties: + ListenAddr: + description: | + 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. + type: "string" + AdvertiseAddr: + description: | + 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. + type: "string" + DataPathAddr: + 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 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. + type: "string" + DataPathPort: + description: | + 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. + type: "integer" + format: "uint32" + DefaultAddrPool: + description: | + Default Address Pool specifies default subnet pools for global + scope networks. + type: "array" + items: + type: "string" + example: ["10.10.0.0/16", "20.20.0.0/16"] + ForceNewCluster: + description: "Force creation of a new swarm." + type: "boolean" + SubnetSize: + description: | + SubnetSize specifies the subnet size of the networks created + from the default subnet pool. + type: "integer" + format: "uint32" + Spec: + $ref: "#/definitions/SwarmSpec" + example: + ListenAddr: "0.0.0.0:2377" + AdvertiseAddr: "192.168.1.1:2377" + DataPathPort: 4789 + DefaultAddrPool: ["10.10.0.0/8", "20.20.0.0/8"] + SubnetSize: 24 + ForceNewCluster: false + Spec: + Orchestration: {} + Raft: {} + Dispatcher: {} + CAConfig: {} + EncryptionConfig: + AutoLockManagers: false + tags: ["Swarm"] + /swarm/join: + post: + summary: "Join an existing swarm" + operationId: "SwarmJoin" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is already part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + type: "object" + title: "SwarmJoinRequest" + properties: + ListenAddr: + description: | + 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). + type: "string" + AdvertiseAddr: + description: | + 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. + type: "string" + DataPathAddr: + 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 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. + + type: "string" + RemoteAddrs: + description: | + Addresses of manager nodes already participating in the swarm. + type: "array" + items: + type: "string" + JoinToken: + description: "Secret token for joining this swarm." + type: "string" + example: + ListenAddr: "0.0.0.0:2377" + AdvertiseAddr: "192.168.1.1:2377" + DataPathAddr: "192.168.1.1" + RemoteAddrs: + - "node1:2377" + JoinToken: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2" + tags: ["Swarm"] + /swarm/leave: + post: + summary: "Leave a swarm" + operationId: "SwarmLeave" + responses: + 200: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "force" + description: | + Force leave swarm, even if this is the last manager or that it will + break the cluster. + in: "query" + type: "boolean" + default: false + tags: ["Swarm"] + /swarm/update: + post: + summary: "Update a swarm" + operationId: "SwarmUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + $ref: "#/definitions/SwarmSpec" + - name: "version" + in: "query" + description: | + The version number of the swarm object being updated. This is + required to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + - name: "rotateWorkerToken" + in: "query" + description: "Rotate the worker join token." + type: "boolean" + default: false + - name: "rotateManagerToken" + in: "query" + description: "Rotate the manager join token." + type: "boolean" + default: false + - name: "rotateManagerUnlockKey" + in: "query" + description: "Rotate the manager unlock key." + type: "boolean" + default: false + tags: ["Swarm"] + /swarm/unlockkey: + get: + summary: "Get the unlock key" + operationId: "SwarmUnlockkey" + consumes: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "object" + title: "UnlockKeyResponse" + properties: + UnlockKey: + description: "The swarm's unlock key." + type: "string" + example: + UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Swarm"] + /swarm/unlock: + post: + summary: "Unlock a locked manager" + operationId: "SwarmUnlock" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "body" + in: "body" + required: true + schema: + type: "object" + title: "SwarmUnlockRequest" + properties: + UnlockKey: + description: "The swarm's unlock key." + type: "string" + example: + UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8" + responses: + 200: + description: "no error" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Swarm"] + /services: + get: + summary: "List services" + operationId: "ServiceList" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Service" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the services list. + + Available filters: + + - `id=` + - `label=` + - `mode=["replicated"|"global"]` + - `name=` + - name: "status" + in: "query" + type: "boolean" + description: | + Include service status, with count of running and desired tasks. + tags: ["Service"] + /services/create: + post: + summary: "Create a service" + operationId: "ServiceCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/ServiceCreateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 403: + description: "network is not eligible for services" + schema: + $ref: "#/definitions/ErrorResponse" + 409: + description: "name conflicts with an existing service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + required: true + schema: + allOf: + - $ref: "#/definitions/ServiceSpec" + - type: "object" + example: + Name: "web" + TaskTemplate: + ContainerSpec: + Image: "nginx:alpine" + Mounts: + - + ReadOnly: true + Source: "web-data" + Target: "/usr/share/nginx/html" + Type: "volume" + VolumeOptions: + DriverConfig: {} + Labels: + com.example.something: "something-value" + Hosts: ["10.10.10.10 host1", "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 host2"] + User: "33" + DNSConfig: + Nameservers: ["8.8.8.8"] + Search: ["example.org"] + Options: ["timeout:3"] + Secrets: + - + File: + Name: "www.example.org.key" + UID: "33" + GID: "33" + Mode: 384 + SecretID: "fpjqlhnwb19zds35k8wn80lq9" + SecretName: "example_org_domain_key" + OomScoreAdj: 0 + LogDriver: + Name: "json-file" + Options: + max-file: "3" + max-size: "10M" + Placement: {} + Resources: + Limits: + MemoryBytes: 104857600 + Reservations: {} + RestartPolicy: + Condition: "on-failure" + Delay: 10000000000 + MaxAttempts: 10 + Mode: + Replicated: + Replicas: 4 + UpdateConfig: + Parallelism: 2 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + RollbackConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + EndpointSpec: + Ports: + - + Protocol: "tcp" + PublishedPort: 8080 + TargetPort: 80 + Labels: + foo: "bar" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration for pulling from private + registries. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + tags: ["Service"] + /services/{id}: + get: + summary: "Inspect a service" + operationId: "ServiceInspect" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Service" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID or name of service." + required: true + type: "string" + - name: "insertDefaults" + in: "query" + description: "Fill empty fields with default values." + type: "boolean" + default: false + tags: ["Service"] + delete: + summary: "Delete a service" + operationId: "ServiceDelete" + responses: + 200: + description: "no error" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID or name of service." + required: true + type: "string" + tags: ["Service"] + /services/{id}/update: + post: + summary: "Update a service" + operationId: "ServiceUpdate" + consumes: ["application/json"] + produces: ["application/json"] + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/ServiceUpdateResponse" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID or name of service." + required: true + type: "string" + - name: "body" + in: "body" + required: true + schema: + allOf: + - $ref: "#/definitions/ServiceSpec" + - type: "object" + example: + Name: "top" + TaskTemplate: + ContainerSpec: + Image: "busybox" + Args: + - "top" + OomScoreAdj: 0 + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ForceUpdate: 0 + Mode: + Replicated: + Replicas: 1 + UpdateConfig: + Parallelism: 2 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + RollbackConfig: + Parallelism: 1 + Delay: 1000000000 + FailureAction: "pause" + Monitor: 15000000000 + MaxFailureRatio: 0.15 + EndpointSpec: + Mode: "vip" + + - name: "version" + in: "query" + description: | + The version number of the service object being updated. This is + required to avoid conflicting writes. + This version number should be the value as currently set on the + service *before* the update. You can find the current version by + calling `GET /services/{id}` + required: true + type: "integer" + - name: "registryAuthFrom" + in: "query" + description: | + If the `X-Registry-Auth` header is not specified, this parameter + indicates where to find registry authorization credentials. + type: "string" + enum: ["spec", "previous-spec"] + default: "spec" + - name: "rollback" + in: "query" + description: | + Set to this parameter to `previous` to cause a server-side rollback + to the previous service spec. The supplied spec will be ignored in + this case. + type: "string" + - name: "X-Registry-Auth" + in: "header" + description: | + A base64url-encoded auth configuration for pulling from private + registries. + + Refer to the [authentication section](#section/Authentication) for + details. + type: "string" + + tags: ["Service"] + /services/{id}/logs: + get: + summary: "Get service logs" + description: | + Get `stdout` and `stderr` logs from a service. See also + [`/containers/{id}/logs`](#operation/ContainerLogs). + + **Note**: This endpoint works only for services with the `local`, + `json-file` or `journald` logging drivers. + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + operationId: "ServiceLogs" + responses: + 200: + description: "logs returned as a stream in response body" + schema: + type: "string" + format: "binary" + 404: + description: "no such service" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such service: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID or name of the service" + type: "string" + - name: "details" + in: "query" + description: "Show service context and extra details provided to logs." + type: "boolean" + default: false + - name: "follow" + in: "query" + description: "Keep connection after returning logs." + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Return logs from `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Return logs from `stderr`" + type: "boolean" + default: false + - name: "since" + in: "query" + description: "Only return logs since this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "timestamps" + in: "query" + description: "Add timestamps to every log line" + type: "boolean" + default: false + - name: "tail" + in: "query" + description: | + Only return this number of log lines from the end of the logs. + Specify as an integer or `all` to output all log lines. + type: "string" + default: "all" + tags: ["Service"] + /tasks: + get: + summary: "List tasks" + operationId: "TaskList" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Task" + example: + - ID: "0kzzo1i0y4jz6027t0k7aezc7" + Version: + Index: 71 + CreatedAt: "2016-06-07T21:07:31.171892745Z" + UpdatedAt: "2016-06-07T21:07:31.376370513Z" + Spec: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Slot: 1 + NodeID: "60gvrl6tm78dmak4yl7srz94v" + Status: + Timestamp: "2016-06-07T21:07:31.290032978Z" + State: "running" + Message: "started" + ContainerStatus: + ContainerID: "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035" + PID: 677 + DesiredState: "running" + NetworksAttachments: + - Network: + ID: "4qvuz4ko70xaltuqbt8956gd1" + Version: + Index: 18 + CreatedAt: "2016-06-07T20:31:11.912919752Z" + UpdatedAt: "2016-06-07T21:07:29.955277358Z" + Spec: + Name: "ingress" + Labels: + com.docker.swarm.internal: "true" + DriverConfiguration: {} + IPAMOptions: + Driver: {} + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + DriverState: + Name: "overlay" + Options: + com.docker.network.driver.overlay.vxlanid_list: "256" + IPAMOptions: + Driver: + Name: "default" + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + Addresses: + - "10.255.0.10/16" + - ID: "1yljwbmlr8er2waf8orvqpwms" + Version: + Index: 30 + CreatedAt: "2016-06-07T21:07:30.019104782Z" + UpdatedAt: "2016-06-07T21:07:30.231958098Z" + Name: "hopeful_cori" + Spec: + ContainerSpec: + Image: "redis" + Resources: + Limits: {} + Reservations: {} + RestartPolicy: + Condition: "any" + MaxAttempts: 0 + Placement: {} + ServiceID: "9mnpnzenvg8p8tdbtq4wvbkcz" + Slot: 1 + NodeID: "60gvrl6tm78dmak4yl7srz94v" + Status: + Timestamp: "2016-06-07T21:07:30.202183143Z" + State: "shutdown" + Message: "shutdown" + ContainerStatus: + ContainerID: "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213" + DesiredState: "shutdown" + NetworksAttachments: + - Network: + ID: "4qvuz4ko70xaltuqbt8956gd1" + Version: + Index: 18 + CreatedAt: "2016-06-07T20:31:11.912919752Z" + UpdatedAt: "2016-06-07T21:07:29.955277358Z" + Spec: + Name: "ingress" + Labels: + com.docker.swarm.internal: "true" + DriverConfiguration: {} + IPAMOptions: + Driver: {} + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + DriverState: + Name: "overlay" + Options: + com.docker.network.driver.overlay.vxlanid_list: "256" + IPAMOptions: + Driver: + Name: "default" + Configs: + - Subnet: "10.255.0.0/16" + Gateway: "10.255.0.1" + Addresses: + - "10.255.0.5/16" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the tasks list. + + Available filters: + + - `desired-state=(running | shutdown | accepted)` + - `id=` + - `label=key` or `label="key=value"` + - `name=` + - `node=` + - `service=` + tags: ["Task"] + /tasks/{id}: + get: + summary: "Inspect a task" + operationId: "TaskInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Task" + 404: + description: "no such task" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "ID of the task" + required: true + type: "string" + tags: ["Task"] + /tasks/{id}/logs: + get: + summary: "Get task logs" + description: | + Get `stdout` and `stderr` logs from a task. + See also [`/containers/{id}/logs`](#operation/ContainerLogs). + + **Note**: This endpoint works only for services with the `local`, + `json-file` or `journald` logging drivers. + operationId: "TaskLogs" + produces: + - "application/vnd.docker.raw-stream" + - "application/vnd.docker.multiplexed-stream" + responses: + 200: + description: "logs returned as a stream in response body" + schema: + type: "string" + format: "binary" + 404: + description: "no such task" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such task: c2ada9df5af8" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + description: "ID of the task" + type: "string" + - name: "details" + in: "query" + description: "Show task context and extra details provided to logs." + type: "boolean" + default: false + - name: "follow" + in: "query" + description: "Keep connection after returning logs." + type: "boolean" + default: false + - name: "stdout" + in: "query" + description: "Return logs from `stdout`" + type: "boolean" + default: false + - name: "stderr" + in: "query" + description: "Return logs from `stderr`" + type: "boolean" + default: false + - name: "since" + in: "query" + description: "Only return logs since this time, as a UNIX timestamp" + type: "integer" + default: 0 + - name: "timestamps" + in: "query" + description: "Add timestamps to every log line" + type: "boolean" + default: false + - name: "tail" + in: "query" + description: | + Only return this number of log lines from the end of the logs. + Specify as an integer or `all` to output all log lines. + type: "string" + default: "all" + tags: ["Task"] + /secrets: + get: + summary: "List secrets" + operationId: "SecretList" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Secret" + example: + - ID: "blt1owaxmitz71s9v5zh81zun" + Version: + Index: 85 + CreatedAt: "2017-07-20T13:55:28.678958722Z" + UpdatedAt: "2017-07-20T13:55:28.678958722Z" + Spec: + Name: "mysql-passwd" + Labels: + some.label: "some.value" + Driver: + Name: "secret-bucket" + Options: + OptionA: "value for driver option A" + OptionB: "value for driver option B" + - ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "app-dev.crt" + Labels: + foo: "bar" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the secrets list. + + Available filters: + + - `id=` + - `label= or label==value` + - `name=` + - `names=` + tags: ["Secret"] + /secrets/create: + post: + summary: "Create a secret" + operationId: "SecretCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IDResponse" + 409: + description: "name conflicts with an existing object" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + schema: + allOf: + - $ref: "#/definitions/SecretSpec" + - type: "object" + example: + Name: "app-key.crt" + Labels: + foo: "bar" + Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" + Driver: + Name: "secret-bucket" + Options: + OptionA: "value for driver option A" + OptionB: "value for driver option B" + tags: ["Secret"] + /secrets/{id}: + get: + summary: "Inspect a secret" + operationId: "SecretInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Secret" + examples: + application/json: + ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "app-dev.crt" + Labels: + foo: "bar" + Driver: + Name: "secret-bucket" + Options: + OptionA: "value for driver option A" + OptionB: "value for driver option B" + + 404: + description: "secret not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the secret" + tags: ["Secret"] + delete: + summary: "Delete a secret" + operationId: "SecretDelete" + produces: + - "application/json" + responses: + 204: + description: "no error" + 404: + description: "secret not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the secret" + tags: ["Secret"] + /secrets/{id}/update: + post: + summary: "Update a Secret" + operationId: "SecretUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such secret" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the secret" + type: "string" + required: true + - name: "body" + in: "body" + schema: + $ref: "#/definitions/SecretSpec" + description: | + The spec of the secret to update. Currently, only the Labels field + can be updated. All other fields must remain unchanged from the + [SecretInspect endpoint](#operation/SecretInspect) response values. + - name: "version" + in: "query" + description: | + The version number of the secret object being updated. This is + required to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + tags: ["Secret"] + /configs: + get: + summary: "List configs" + operationId: "ConfigList" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + type: "array" + items: + $ref: "#/definitions/Config" + example: + - ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "server.conf" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "filters" + in: "query" + type: "string" + description: | + A JSON encoded value of the filters (a `map[string][]string`) to + process on the configs list. + + Available filters: + + - `id=` + - `label= or label==value` + - `name=` + - `names=` + tags: ["Config"] + /configs/create: + post: + summary: "Create a config" + operationId: "ConfigCreate" + consumes: + - "application/json" + produces: + - "application/json" + responses: + 201: + description: "no error" + schema: + $ref: "#/definitions/IDResponse" + 409: + description: "name conflicts with an existing object" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "body" + in: "body" + schema: + allOf: + - $ref: "#/definitions/ConfigSpec" + - type: "object" + example: + Name: "server.conf" + Labels: + foo: "bar" + Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==" + tags: ["Config"] + /configs/{id}: + get: + summary: "Inspect a config" + operationId: "ConfigInspect" + produces: + - "application/json" + responses: + 200: + description: "no error" + schema: + $ref: "#/definitions/Config" + examples: + application/json: + ID: "ktnbjxoalbkvbvedmg1urrz8h" + Version: + Index: 11 + CreatedAt: "2016-11-05T01:20:17.327670065Z" + UpdatedAt: "2016-11-05T01:20:17.327670065Z" + Spec: + Name: "app-dev.crt" + 404: + description: "config not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the config" + tags: ["Config"] + delete: + summary: "Delete a config" + operationId: "ConfigDelete" + produces: + - "application/json" + responses: + 204: + description: "no error" + 404: + description: "config not found" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "ID of the config" + tags: ["Config"] + /configs/{id}/update: + post: + summary: "Update a Config" + operationId: "ConfigUpdate" + responses: + 200: + description: "no error" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 404: + description: "no such config" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + 503: + description: "node is not part of a swarm" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "id" + in: "path" + description: "The ID or name of the config" + type: "string" + required: true + - name: "body" + in: "body" + schema: + $ref: "#/definitions/ConfigSpec" + description: | + The spec of the config to update. Currently, only the Labels field + can be updated. All other fields must remain unchanged from the + [ConfigInspect endpoint](#operation/ConfigInspect) response values. + - name: "version" + in: "query" + description: | + The version number of the config object being updated. This is + required to avoid conflicting writes. + type: "integer" + format: "int64" + required: true + tags: ["Config"] + /distribution/{name}/json: + get: + summary: "Get image information from the registry" + description: | + Return image digest and platform information by contacting the registry. + operationId: "DistributionInspect" + produces: + - "application/json" + responses: + 200: + description: "descriptor and platform information" + schema: + $ref: "#/definitions/DistributionInspect" + 401: + description: "Failed authentication or no image found" + schema: + $ref: "#/definitions/ErrorResponse" + examples: + application/json: + message: "No such image: someimage (tag: latest)" + 500: + description: "Server error" + schema: + $ref: "#/definitions/ErrorResponse" + parameters: + - name: "name" + in: "path" + description: "Image name or id" + type: "string" + required: true + tags: ["Distribution"] + /session: + post: + summary: "Initialize interactive session" + description: | + Start a new interactive session with a server. Session allows server to + call back to the client for advanced capabilities. + + ### Hijacking + + This endpoint hijacks the HTTP connection to HTTP2 transport that allows + the client to expose gPRC services on that connection. + + For example, the client sends this request to upgrade the connection: + + ``` + POST /session HTTP/1.1 + Upgrade: h2c + Connection: Upgrade + ``` + + The Docker daemon responds with a `101 UPGRADED` response follow with + the raw stream: + + ``` + HTTP/1.1 101 UPGRADED + Connection: Upgrade + Upgrade: h2c + ``` + operationId: "Session" + produces: + - "application/vnd.docker.raw-stream" + responses: + 101: + description: "no error, hijacking successful" + 400: + description: "bad parameter" + schema: + $ref: "#/definitions/ErrorResponse" + 500: + description: "server error" + schema: + $ref: "#/definitions/ErrorResponse" + tags: ["Session"] diff --git a/api-model-v1-52/docs/Address.md b/api-model-v1-52/docs/Address.md new file mode 100644 index 00000000..0b2b6f74 --- /dev/null +++ b/api-model-v1-52/docs/Address.md @@ -0,0 +1,11 @@ + +# Address + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **addr** | **kotlin.String** | IP address. | [optional] | +| **prefixLen** | **kotlin.Int** | Mask length of the IP address. | [optional] | + + + diff --git a/api-model-v1-52/docs/AuthConfig.md b/api-model-v1-52/docs/AuthConfig.md new file mode 100644 index 00000000..5e6e3cf8 --- /dev/null +++ b/api-model-v1-52/docs/AuthConfig.md @@ -0,0 +1,12 @@ + +# AuthConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **username** | **kotlin.String** | | [optional] | +| **password** | **kotlin.String** | | [optional] | +| **serveraddress** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/AuthResponse.md b/api-model-v1-52/docs/AuthResponse.md new file mode 100644 index 00000000..f69137d2 --- /dev/null +++ b/api-model-v1-52/docs/AuthResponse.md @@ -0,0 +1,11 @@ + +# AuthResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | **kotlin.String** | The status of the authentication | | +| **identityToken** | **kotlin.String** | An opaque token used to authenticate a user after a successful login | [optional] | + + + diff --git a/api-model-v1-52/docs/BuildCache.md b/api-model-v1-52/docs/BuildCache.md new file mode 100644 index 00000000..ac8f462a --- /dev/null +++ b/api-model-v1-52/docs/BuildCache.md @@ -0,0 +1,26 @@ + +# BuildCache + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique ID of the build cache record. | [optional] | +| **parents** | **kotlin.collections.MutableList<kotlin.String>** | List of parent build cache record IDs. | [optional] | +| **type** | [**inline**](#Type) | Cache record type. | [optional] | +| **description** | **kotlin.String** | Description of the build-step that produced the build cache. | [optional] | +| **inUse** | **kotlin.Boolean** | Indicates if the build cache is in use. | [optional] | +| **shared** | **kotlin.Boolean** | Indicates if the build cache is shared. | [optional] | +| **propertySize** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **lastUsedAt** | **kotlin.String** | Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **usageCount** | **kotlin.Int** | | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | internal, frontend, source.local, source.git.checkout, exec.cachemount, regular | + + + diff --git a/api-model-v1-52/docs/BuildCacheDiskUsage.md b/api-model-v1-52/docs/BuildCacheDiskUsage.md new file mode 100644 index 00000000..6b6988ea --- /dev/null +++ b/api-model-v1-52/docs/BuildCacheDiskUsage.md @@ -0,0 +1,14 @@ + +# BuildCacheDiskUsage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **activeCount** | **kotlin.Long** | Count of active build cache records. | [optional] | +| **totalCount** | **kotlin.Long** | Count of all build cache records. | [optional] | +| **reclaimable** | **kotlin.Long** | Disk space that can be reclaimed by removing inactive build cache records. | [optional] | +| **totalSize** | **kotlin.Long** | Disk space in use by build cache records. | [optional] | +| **items** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.md) | List of build cache records. | [optional] | + + + diff --git a/api-model-v1-52/docs/BuildInfo.md b/api-model-v1-52/docs/BuildInfo.md new file mode 100644 index 00000000..1fb9ef06 --- /dev/null +++ b/api-model-v1-52/docs/BuildInfo.md @@ -0,0 +1,15 @@ + +# BuildInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **stream** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | +| **aux** | [**ImageID**](ImageID.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/BuildPruneResponse.md b/api-model-v1-52/docs/BuildPruneResponse.md new file mode 100644 index 00000000..99595843 --- /dev/null +++ b/api-model-v1-52/docs/BuildPruneResponse.md @@ -0,0 +1,11 @@ + +# BuildPruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-52/docs/ChangeType.md b/api-model-v1-52/docs/ChangeType.md new file mode 100644 index 00000000..25c1d3e1 --- /dev/null +++ b/api-model-v1-52/docs/ChangeType.md @@ -0,0 +1,14 @@ + +# ChangeType + +## Enum + + + * `T0` (value: `0`) + + * `T1` (value: `1`) + + * `T2` (value: `2`) + + + diff --git a/api-model-v1-52/docs/ClusterInfo.md b/api-model-v1-52/docs/ClusterInfo.md new file mode 100644 index 00000000..c7f6c112 --- /dev/null +++ b/api-model-v1-52/docs/ClusterInfo.md @@ -0,0 +1,19 @@ + +# ClusterInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [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, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | + + + diff --git a/api-model-v1-52/docs/ClusterVolume.md b/api-model-v1-52/docs/ClusterVolume.md new file mode 100644 index 00000000..da0a33cf --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolume.md @@ -0,0 +1,16 @@ + +# ClusterVolume + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | +| **info** | [**ClusterVolumeInfo**](ClusterVolumeInfo.md) | | [optional] | +| **publishStatus** | [**kotlin.collections.MutableList<ClusterVolumePublishStatusInner>**](ClusterVolumePublishStatusInner.md) | The status of the volume as it pertains to its publishing and use on specific nodes | [optional] | + + + diff --git a/api-model-v1-52/docs/ClusterVolumeInfo.md b/api-model-v1-52/docs/ClusterVolumeInfo.md new file mode 100644 index 00000000..55fef034 --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumeInfo.md @@ -0,0 +1,13 @@ + +# ClusterVolumeInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capacityBytes** | **kotlin.Long** | The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. | [optional] | +| **volumeContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned from the storage plugin when the volume is created. | [optional] | +| **volumeID** | **kotlin.String** | The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. | [optional] | +| **accessibleTopology** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | The topology this volume is actually accessible from. | [optional] | + + + diff --git a/api-model-v1-52/docs/ClusterVolumePublishStatusInner.md b/api-model-v1-52/docs/ClusterVolumePublishStatusInner.md new file mode 100644 index 00000000..96142792 --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumePublishStatusInner.md @@ -0,0 +1,19 @@ + +# ClusterVolumePublishStatusInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | The ID of the Swarm node the volume is published on. | [optional] | +| **state** | [**inline**](#State) | The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. | [optional] | +| **publishContext** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of strings to strings returned by the CSI controller plugin when a volume is published. | [optional] | + + + +## Enum: State +| Name | Value | +| ---- | ----- | +| state | pending-publish, published, pending-node-unpublish, pending-controller-unpublish | + + + diff --git a/api-model-v1-52/docs/ClusterVolumeSpec.md b/api-model-v1-52/docs/ClusterVolumeSpec.md new file mode 100644 index 00000000..670b70e0 --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumeSpec.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **group** | **kotlin.String** | Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. | [optional] | +| **accessMode** | [**ClusterVolumeSpecAccessMode**](ClusterVolumeSpecAccessMode.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ClusterVolumeSpecAccessMode.md b/api-model-v1-52/docs/ClusterVolumeSpecAccessMode.md new file mode 100644 index 00000000..37eb7734 --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumeSpecAccessMode.md @@ -0,0 +1,37 @@ + +# ClusterVolumeSpecAccessMode + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **scope** | [**inline**](#Scope) | The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. | [optional] | +| **sharing** | [**inline**](#Sharing) | The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. | [optional] | +| **mountVolume** | [**kotlin.Any**](.md) | Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. | [optional] | +| **secrets** | [**kotlin.collections.MutableList<ClusterVolumeSpecAccessModeSecretsInner>**](ClusterVolumeSpecAccessModeSecretsInner.md) | Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. | [optional] | +| **accessibilityRequirements** | [**ClusterVolumeSpecAccessModeAccessibilityRequirements**](ClusterVolumeSpecAccessModeAccessibilityRequirements.md) | | [optional] | +| **capacityRange** | [**ClusterVolumeSpecAccessModeCapacityRange**](ClusterVolumeSpecAccessModeCapacityRange.md) | | [optional] | +| **availability** | [**inline**](#Availability) | The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. | [optional] | + + + +## Enum: Scope +| Name | Value | +| ---- | ----- | +| scope | single, multi | + + + +## Enum: Sharing +| Name | Value | +| ---- | ----- | +| sharing | none, readonly, onewriter, all | + + + +## Enum: Availability +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | + + + diff --git a/api-model-v1-52/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md b/api-model-v1-52/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md new file mode 100644 index 00000000..fe071a5d --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumeSpecAccessModeAccessibilityRequirements.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpecAccessModeAccessibilityRequirements + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requisite** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of required topologies, at least one of which the volume must be accessible from. | [optional] | +| **preferred** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | A list of topologies that the volume should attempt to be provisioned in. | [optional] | + + + diff --git a/api-model-v1-52/docs/ClusterVolumeSpecAccessModeCapacityRange.md b/api-model-v1-52/docs/ClusterVolumeSpecAccessModeCapacityRange.md new file mode 100644 index 00000000..6ed01224 --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumeSpecAccessModeCapacityRange.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpecAccessModeCapacityRange + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **requiredBytes** | **kotlin.Long** | The volume must be at least this big. The value of 0 indicates an unspecified minimum | [optional] | +| **limitBytes** | **kotlin.Long** | The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. | [optional] | + + + diff --git a/api-model-v1-52/docs/ClusterVolumeSpecAccessModeSecretsInner.md b/api-model-v1-52/docs/ClusterVolumeSpecAccessModeSecretsInner.md new file mode 100644 index 00000000..608a6876 --- /dev/null +++ b/api-model-v1-52/docs/ClusterVolumeSpecAccessModeSecretsInner.md @@ -0,0 +1,11 @@ + +# ClusterVolumeSpecAccessModeSecretsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **key** | **kotlin.String** | Key is the name of the key of the key-value pair passed to the plugin. | [optional] | +| **secret** | **kotlin.String** | Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. | [optional] | + + + diff --git a/api-model-v1-52/docs/Commit.md b/api-model-v1-52/docs/Commit.md new file mode 100644 index 00000000..168c7019 --- /dev/null +++ b/api-model-v1-52/docs/Commit.md @@ -0,0 +1,10 @@ + +# Commit + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Actual commit ID of external tool. | [optional] | + + + diff --git a/api-model-v1-52/docs/Config.md b/api-model-v1-52/docs/Config.md new file mode 100644 index 00000000..5174c406 --- /dev/null +++ b/api-model-v1-52/docs/Config.md @@ -0,0 +1,14 @@ + +# Config + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ConfigSpec**](ConfigSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ConfigCreateRequest.md b/api-model-v1-52/docs/ConfigCreateRequest.md new file mode 100644 index 00000000..ced7b32d --- /dev/null +++ b/api-model-v1-52/docs/ConfigCreateRequest.md @@ -0,0 +1,13 @@ + +# ConfigCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ConfigReference.md b/api-model-v1-52/docs/ConfigReference.md new file mode 100644 index 00000000..02d63956 --- /dev/null +++ b/api-model-v1-52/docs/ConfigReference.md @@ -0,0 +1,10 @@ + +# ConfigReference + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **network** | **kotlin.String** | The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. | [optional] | + + + diff --git a/api-model-v1-52/docs/ConfigSpec.md b/api-model-v1-52/docs/ConfigSpec.md new file mode 100644 index 00000000..2a16d7a9 --- /dev/null +++ b/api-model-v1-52/docs/ConfigSpec.md @@ -0,0 +1,13 @@ + +# ConfigSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the config. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerBlkioStatEntry.md b/api-model-v1-52/docs/ContainerBlkioStatEntry.md new file mode 100644 index 00000000..d9feb97a --- /dev/null +++ b/api-model-v1-52/docs/ContainerBlkioStatEntry.md @@ -0,0 +1,13 @@ + +# ContainerBlkioStatEntry + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **major** | **kotlin.Int** | | [optional] | +| **minor** | **kotlin.Int** | | [optional] | +| **op** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerBlkioStats.md b/api-model-v1-52/docs/ContainerBlkioStats.md new file mode 100644 index 00000000..435ef661 --- /dev/null +++ b/api-model-v1-52/docs/ContainerBlkioStats.md @@ -0,0 +1,17 @@ + +# ContainerBlkioStats + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ioServiceBytesRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | | [optional] | +| **ioServicedRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | +| **ioQueueRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | +| **ioServiceTimeRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | +| **ioWaitTimeRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | +| **ioMergedRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | +| **ioTimeRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | +| **sectorsRecursive** | [**kotlin.collections.MutableList<ContainerBlkioStatEntry>**](ContainerBlkioStatEntry.md) | This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerCPUStats.md b/api-model-v1-52/docs/ContainerCPUStats.md new file mode 100644 index 00000000..3c575794 --- /dev/null +++ b/api-model-v1-52/docs/ContainerCPUStats.md @@ -0,0 +1,13 @@ + +# ContainerCPUStats + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuUsage** | [**ContainerCPUUsage**](ContainerCPUUsage.md) | | [optional] | +| **systemCpuUsage** | **kotlin.Int** | System Usage. This field is Linux-specific and omitted for Windows containers. | [optional] | +| **onlineCpus** | **kotlin.Int** | Number of online CPUs. This field is Linux-specific and omitted for Windows containers. | [optional] | +| **throttlingData** | [**ContainerThrottlingData**](ContainerThrottlingData.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerCPUUsage.md b/api-model-v1-52/docs/ContainerCPUUsage.md new file mode 100644 index 00000000..0b5a1ec2 --- /dev/null +++ b/api-model-v1-52/docs/ContainerCPUUsage.md @@ -0,0 +1,13 @@ + +# ContainerCPUUsage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **totalUsage** | **kotlin.Int** | Total CPU time consumed in nanoseconds (Linux) or 100's of nanoseconds (Windows). | [optional] | +| **percpuUsage** | **kotlin.collections.MutableList<kotlin.Int>** | Total CPU time (in nanoseconds) consumed per core (Linux). This field is Linux-specific when using cgroups v1. It is omitted when using cgroups v2 and Windows containers. | [optional] | +| **usageInKernelmode** | **kotlin.Int** | Time (in nanoseconds) spent by tasks of the cgroup in kernel mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. | [optional] | +| **usageInUsermode** | **kotlin.Int** | Time (in nanoseconds) spent by tasks of the cgroup in user mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerConfig.md b/api-model-v1-52/docs/ContainerConfig.md new file mode 100644 index 00000000..f466ae16 --- /dev/null +++ b/api-model-v1-52/docs/ContainerConfig.md @@ -0,0 +1,33 @@ + +# ContainerConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`<user-name|UID>[<:group-name|GID>]`). | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerCreateRequest.md b/api-model-v1-52/docs/ContainerCreateRequest.md new file mode 100644 index 00000000..ea9c4229 --- /dev/null +++ b/api-model-v1-52/docs/ContainerCreateRequest.md @@ -0,0 +1,35 @@ + +# ContainerCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid RFC 1123 hostname. | [optional] | +| **domainname** | **kotlin.String** | The domain name to use for the container. | [optional] | +| **user** | **kotlin.String** | Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`<user-name|UID>[<:group-name|GID>]`). | [optional] | +| **attachStdin** | **kotlin.Boolean** | Whether to attach to `stdin`. | [optional] | +| **attachStdout** | **kotlin.Boolean** | Whether to attach to `stdout`. | [optional] | +| **attachStderr** | **kotlin.Boolean** | Whether to attach to `stderr`. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **tty** | **kotlin.Boolean** | Attach standard streams to a TTY, including `stdin` if it is not closed. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **stdinOnce** | **kotlin.Boolean** | Close `stdin` after one attached client disconnects | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **image** | **kotlin.String** | The name (or reference) of the image to use when creating the container, or which was used when the container was created. | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **stopTimeout** | **kotlin.Int** | Timeout to stop a container in seconds. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **networkingConfig** | [**NetworkingConfig**](NetworkingConfig.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerCreateResponse.md b/api-model-v1-52/docs/ContainerCreateResponse.md new file mode 100644 index 00000000..2470f713 --- /dev/null +++ b/api-model-v1-52/docs/ContainerCreateResponse.md @@ -0,0 +1,11 @@ + +# ContainerCreateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created container | | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerInspectResponse.md b/api-model-v1-52/docs/ContainerInspectResponse.md new file mode 100644 index 00000000..3d28cce0 --- /dev/null +++ b/api-model-v1-52/docs/ContainerInspectResponse.md @@ -0,0 +1,36 @@ + +# ContainerInspectResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). | [optional] | +| **created** | **kotlin.String** | Date and time at which the container was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **path** | **kotlin.String** | The path to the command being run | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | The arguments to the command being run | [optional] | +| **state** | [**ContainerState**](ContainerState.md) | | [optional] | +| **image** | **kotlin.String** | The ID (digest) of the image that this container was created from. | [optional] | +| **resolvConfPath** | **kotlin.String** | Location of the `/etc/resolv.conf` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional] | +| **hostnamePath** | **kotlin.String** | Location of the `/etc/hostname` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional] | +| **hostsPath** | **kotlin.String** | Location of the `/etc/hosts` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional] | +| **logPath** | **kotlin.String** | Location of the file used to buffer the container's logs. Depending on the logging-driver used for the container, this field may be omitted. This file is managed through the docker daemon, and should not be accessed or modified by other tools. | [optional] | +| **name** | **kotlin.String** | The name associated with this container. For historic reasons, the name may be prefixed with a forward-slash (`/`). | [optional] | +| **restartCount** | **kotlin.Int** | Number of times the container was restarted since it was created, or since daemon was started. | [optional] | +| **driver** | **kotlin.String** | The storage-driver used for the container's filesystem (graph-driver or snapshotter). | [optional] | +| **platform** | **kotlin.String** | The platform (operating system) for which the container was created. This field was introduced for the experimental \"LCOW\" (Linux Containers On Windows) features, which has been removed. In most cases, this field is equal to the host's operating system (`linux` or `windows`). | [optional] | +| **imageManifestDescriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | [optional] | +| **mountLabel** | **kotlin.String** | SELinux mount label set for the container. | [optional] | +| **processLabel** | **kotlin.String** | SELinux process label set for the container. | [optional] | +| **appArmorProfile** | **kotlin.String** | The AppArmor profile set for the container. | [optional] | +| **execIDs** | **kotlin.collections.MutableList<kotlin.String>** | IDs of exec instances that are running in the container. | [optional] | +| **hostConfig** | [**HostConfig**](HostConfig.md) | | [optional] | +| **graphDriver** | [**DriverData**](DriverData.md) | | [optional] | +| **storage** | [**Storage**](Storage.md) | | [optional] | +| **sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. | [optional] | +| **sizeRootFs** | **kotlin.Long** | The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<MountPoint>**](MountPoint.md) | List of mounts used by the container. | [optional] | +| **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] | +| **networkSettings** | [**NetworkSettings**](NetworkSettings.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerMemoryStats.md b/api-model-v1-52/docs/ContainerMemoryStats.md new file mode 100644 index 00000000..6edd8281 --- /dev/null +++ b/api-model-v1-52/docs/ContainerMemoryStats.md @@ -0,0 +1,17 @@ + +# ContainerMemoryStats + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **usage** | **kotlin.Int** | Current `res_counter` usage for memory. This field is Linux-specific and omitted for Windows containers. | [optional] | +| **maxUsage** | **kotlin.Int** | Maximum usage ever recorded. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. | [optional] | +| **stats** | **kotlin.collections.MutableMap<kotlin.String, kotlin.Int>** | All the stats exported via memory.stat. when using cgroups v2. This field is Linux-specific and omitted for Windows containers. | [optional] | +| **failcnt** | **kotlin.Int** | Number of times memory usage hits limits. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. | [optional] | +| **limit** | **kotlin.Int** | This field is Linux-specific and omitted for Windows containers. | [optional] | +| **commitbytes** | **kotlin.Int** | Committed bytes. This field is Windows-specific and omitted for Linux containers. | [optional] | +| **commitpeakbytes** | **kotlin.Int** | Peak committed bytes. This field is Windows-specific and omitted for Linux containers. | [optional] | +| **privateworkingset** | **kotlin.Int** | Private working set. This field is Windows-specific and omitted for Linux containers. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerNetworkStats.md b/api-model-v1-52/docs/ContainerNetworkStats.md new file mode 100644 index 00000000..4e387997 --- /dev/null +++ b/api-model-v1-52/docs/ContainerNetworkStats.md @@ -0,0 +1,19 @@ + +# ContainerNetworkStats + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **rxBytes** | **kotlin.Int** | Bytes received. Windows and Linux. | [optional] | +| **rxPackets** | **kotlin.Int** | Packets received. Windows and Linux. | [optional] | +| **rxErrors** | **kotlin.Int** | Received errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. | [optional] | +| **rxDropped** | **kotlin.Int** | Incoming packets dropped. Windows and Linux. | [optional] | +| **txBytes** | **kotlin.Int** | Bytes sent. Windows and Linux. | [optional] | +| **txPackets** | **kotlin.Int** | Packets sent. Windows and Linux. | [optional] | +| **txErrors** | **kotlin.Int** | Sent errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. | [optional] | +| **txDropped** | **kotlin.Int** | Outgoing packets dropped. Windows and Linux. | [optional] | +| **endpointId** | **kotlin.String** | Endpoint ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. | [optional] | +| **instanceId** | **kotlin.String** | Instance ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerPidsStats.md b/api-model-v1-52/docs/ContainerPidsStats.md new file mode 100644 index 00000000..c6428b90 --- /dev/null +++ b/api-model-v1-52/docs/ContainerPidsStats.md @@ -0,0 +1,11 @@ + +# ContainerPidsStats + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **current** | **kotlin.Int** | Current is the number of PIDs in the cgroup. | [optional] | +| **limit** | **kotlin.Int** | Limit is the hard limit on the number of pids in the cgroup. A \"Limit\" of 0 means that there is no limit. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerPruneResponse.md b/api-model-v1-52/docs/ContainerPruneResponse.md new file mode 100644 index 00000000..d498e282 --- /dev/null +++ b/api-model-v1-52/docs/ContainerPruneResponse.md @@ -0,0 +1,11 @@ + +# ContainerPruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containersDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Container IDs that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerState.md b/api-model-v1-52/docs/ContainerState.md new file mode 100644 index 00000000..85d232e5 --- /dev/null +++ b/api-model-v1-52/docs/ContainerState.md @@ -0,0 +1,28 @@ + +# ContainerState + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] | +| **running** | **kotlin.Boolean** | Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". | [optional] | +| **paused** | **kotlin.Boolean** | Whether this container is paused. | [optional] | +| **restarting** | **kotlin.Boolean** | Whether this container is restarting. | [optional] | +| **ooMKilled** | **kotlin.Boolean** | Whether a process within this container has been killed because it ran out of memory since the container was last started. | [optional] | +| **dead** | **kotlin.Boolean** | | [optional] | +| **pid** | **kotlin.Int** | The process ID of this container | [optional] | +| **exitCode** | **kotlin.Int** | The last exit code of this container | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **startedAt** | **kotlin.String** | The time when this container was last started. | [optional] | +| **finishedAt** | **kotlin.String** | The time when this container last exited. | [optional] | +| **health** | [**Health**](Health.md) | | [optional] | + + + +## Enum: Status +| Name | Value | +| ---- | ----- | +| status | created, running, paused, restarting, removing, exited, dead | + + + diff --git a/api-model-v1-52/docs/ContainerStatsResponse.md b/api-model-v1-52/docs/ContainerStatsResponse.md new file mode 100644 index 00000000..cfaa574c --- /dev/null +++ b/api-model-v1-52/docs/ContainerStatsResponse.md @@ -0,0 +1,22 @@ + +# ContainerStatsResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID of the container for which the stats were collected. | [optional] | +| **name** | **kotlin.String** | Name of the container for which the stats were collected. | [optional] | +| **osType** | **kotlin.String** | OSType is the OS of the container (\"linux\" or \"windows\") to allow platform-specific handling of stats. | [optional] | +| **read** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this sample was collected. The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. | [optional] | +| **cpuStats** | [**ContainerCPUStats**](ContainerCPUStats.md) | | [optional] | +| **memoryStats** | [**ContainerMemoryStats**](ContainerMemoryStats.md) | | [optional] | +| **networks** | [**kotlin.Any**](.md) | Network statistics for the container per interface. This field is omitted if the container has no networking enabled. | [optional] | +| **pidsStats** | [**ContainerPidsStats**](ContainerPidsStats.md) | | [optional] | +| **blkioStats** | [**ContainerBlkioStats**](ContainerBlkioStats.md) | | [optional] | +| **numProcs** | **kotlin.Int** | The number of processors on the system. This field is Windows-specific and always zero for Linux containers. | [optional] | +| **storageStats** | [**ContainerStorageStats**](ContainerStorageStats.md) | | [optional] | +| **preread** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this first sample was collected. This field is not propagated if the \"one-shot\" option is set. If the \"one-shot\" option is set, this field may be omitted, empty, or set to a default date (`0001-01-01T00:00:00Z`). The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. | [optional] | +| **precpuStats** | [**ContainerCPUStats**](ContainerCPUStats.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerStatus.md b/api-model-v1-52/docs/ContainerStatus.md new file mode 100644 index 00000000..b58e6e86 --- /dev/null +++ b/api-model-v1-52/docs/ContainerStatus.md @@ -0,0 +1,12 @@ + +# ContainerStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | | [optional] | +| **PID** | **kotlin.Int** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerStorageStats.md b/api-model-v1-52/docs/ContainerStorageStats.md new file mode 100644 index 00000000..5600e9e1 --- /dev/null +++ b/api-model-v1-52/docs/ContainerStorageStats.md @@ -0,0 +1,13 @@ + +# ContainerStorageStats + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **readCountNormalized** | **kotlin.Int** | | [optional] | +| **readSizeBytes** | **kotlin.Int** | | [optional] | +| **writeCountNormalized** | **kotlin.Int** | | [optional] | +| **writeSizeBytes** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerSummary.md b/api-model-v1-52/docs/ContainerSummary.md new file mode 100644 index 00000000..608788d6 --- /dev/null +++ b/api-model-v1-52/docs/ContainerSummary.md @@ -0,0 +1,33 @@ + +# ContainerSummary + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). | [optional] | +| **names** | **kotlin.collections.MutableList<kotlin.String>** | The names associated with this container. Most containers have a single name, but when using legacy \"links\", the container can have multiple names. For historic reasons, names are prefixed with a forward-slash (`/`). | [optional] | +| **image** | **kotlin.String** | The name or ID of the image used to create the container. This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., `docker.io/library/ubuntu:latest` or `docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`), short form (e.g., `ubuntu:latest`)), or the ID(-prefix) of the image (e.g., `72297848456d`). The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., `sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`). | [optional] | +| **imageID** | **kotlin.String** | The ID (digest) of the image that this container was created from. | [optional] | +| **imageManifestDescriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | [optional] | +| **command** | **kotlin.String** | Command to run when starting the container | [optional] | +| **created** | **kotlin.Long** | Date and time at which the container was created as a Unix timestamp (number of seconds since EPOCH). | [optional] | +| **ports** | [**kotlin.collections.MutableList<PortSummary>**](PortSummary.md) | Port-mappings for the container. | [optional] | +| **sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. | [optional] | +| **sizeRootFs** | **kotlin.Long** | The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **state** | [**inline**](#State) | The state of this container. | [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.MutableList<MountPoint>**](MountPoint.md) | List of mounts used by the container. | [optional] | +| **health** | [**ContainerSummaryHealth**](ContainerSummaryHealth.md) | | [optional] | + + + +## Enum: State +| Name | Value | +| ---- | ----- | +| state | created, running, paused, restarting, exited, removing, dead | + + + diff --git a/api-model-v1-52/docs/ContainerSummaryHealth.md b/api-model-v1-52/docs/ContainerSummaryHealth.md new file mode 100644 index 00000000..6b442edf --- /dev/null +++ b/api-model-v1-52/docs/ContainerSummaryHealth.md @@ -0,0 +1,18 @@ + +# ContainerSummaryHealth + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | the health status of the container | [optional] | +| **failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] | + + + +## Enum: Status +| Name | Value | +| ---- | ----- | +| status | none, starting, healthy, unhealthy | + + + diff --git a/api-model-v1-52/docs/ContainerSummaryHostConfig.md b/api-model-v1-52/docs/ContainerSummaryHostConfig.md new file mode 100644 index 00000000..2e1d0780 --- /dev/null +++ b/api-model-v1-52/docs/ContainerSummaryHostConfig.md @@ -0,0 +1,11 @@ + +# ContainerSummaryHostConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkMode** | **kotlin.String** | Networking mode (`host`, `none`, `container:<id>`) or name of the primary network the container is using. This field is primarily for backward compatibility. The container can be connected to multiple networks for which information can be found in the `NetworkSettings.Networks` field, which enumerates settings per network. | [optional] | +| **annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary key-value metadata attached to the container. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerSummaryNetworkSettings.md b/api-model-v1-52/docs/ContainerSummaryNetworkSettings.md new file mode 100644 index 00000000..b2c57235 --- /dev/null +++ b/api-model-v1-52/docs/ContainerSummaryNetworkSettings.md @@ -0,0 +1,10 @@ + +# ContainerSummaryNetworkSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Summary of network-settings for each network the container is attached to. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerThrottlingData.md b/api-model-v1-52/docs/ContainerThrottlingData.md new file mode 100644 index 00000000..8874c062 --- /dev/null +++ b/api-model-v1-52/docs/ContainerThrottlingData.md @@ -0,0 +1,12 @@ + +# ContainerThrottlingData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **periods** | **kotlin.Int** | Number of periods with throttling active. | [optional] | +| **throttledPeriods** | **kotlin.Int** | Number of periods when the container hit its throttling limit. | [optional] | +| **throttledTime** | **kotlin.Int** | Aggregated time (in nanoseconds) the container was throttled for. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerTopResponse.md b/api-model-v1-52/docs/ContainerTopResponse.md new file mode 100644 index 00000000..1a655cd6 --- /dev/null +++ b/api-model-v1-52/docs/ContainerTopResponse.md @@ -0,0 +1,11 @@ + +# ContainerTopResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **titles** | **kotlin.collections.MutableList<kotlin.String>** | The ps column titles | [optional] | +| **processes** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Each process running in the container, where each process is an array of values corresponding to the titles. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerUpdateRequest.md b/api-model-v1-52/docs/ContainerUpdateRequest.md new file mode 100644 index 00000000..719552a1 --- /dev/null +++ b/api-model-v1-52/docs/ContainerUpdateRequest.md @@ -0,0 +1,40 @@ + +# ContainerUpdateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerUpdateResponse.md b/api-model-v1-52/docs/ContainerUpdateResponse.md new file mode 100644 index 00000000..bb66e0d0 --- /dev/null +++ b/api-model-v1-52/docs/ContainerUpdateResponse.md @@ -0,0 +1,10 @@ + +# ContainerUpdateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when updating the container. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerWaitExitError.md b/api-model-v1-52/docs/ContainerWaitExitError.md new file mode 100644 index 00000000..42bceba4 --- /dev/null +++ b/api-model-v1-52/docs/ContainerWaitExitError.md @@ -0,0 +1,10 @@ + +# ContainerWaitExitError + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | Details of an error | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerWaitResponse.md b/api-model-v1-52/docs/ContainerWaitResponse.md new file mode 100644 index 00000000..8e2eea9b --- /dev/null +++ b/api-model-v1-52/docs/ContainerWaitResponse.md @@ -0,0 +1,11 @@ + +# ContainerWaitResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **statusCode** | **kotlin.Long** | Exit code of the container | | +| **error** | [**ContainerWaitExitError**](ContainerWaitExitError.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerdInfo.md b/api-model-v1-52/docs/ContainerdInfo.md new file mode 100644 index 00000000..06548206 --- /dev/null +++ b/api-model-v1-52/docs/ContainerdInfo.md @@ -0,0 +1,11 @@ + +# ContainerdInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **address** | **kotlin.String** | The address of the containerd socket. | [optional] | +| **namespaces** | [**ContainerdInfoNamespaces**](ContainerdInfoNamespaces.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainerdInfoNamespaces.md b/api-model-v1-52/docs/ContainerdInfoNamespaces.md new file mode 100644 index 00000000..64689feb --- /dev/null +++ b/api-model-v1-52/docs/ContainerdInfoNamespaces.md @@ -0,0 +1,11 @@ + +# ContainerdInfoNamespaces + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containers** | **kotlin.String** | The default containerd namespace used for containers managed by the daemon. The default namespace for containers is \"moby\", but will be suffixed with the `<uid>.<gid>` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. | [optional] | +| **plugins** | **kotlin.String** | The default containerd namespace used for plugins managed by the daemon. The default namespace for plugins is \"plugins.moby\", but will be suffixed with the `<uid>.<gid>` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. | [optional] | + + + diff --git a/api-model-v1-52/docs/ContainersDiskUsage.md b/api-model-v1-52/docs/ContainersDiskUsage.md new file mode 100644 index 00000000..15a9c019 --- /dev/null +++ b/api-model-v1-52/docs/ContainersDiskUsage.md @@ -0,0 +1,14 @@ + +# ContainersDiskUsage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **activeCount** | **kotlin.Long** | Count of active containers. | [optional] | +| **totalCount** | **kotlin.Long** | Count of all containers. | [optional] | +| **reclaimable** | **kotlin.Long** | Disk space that can be reclaimed by removing inactive containers. | [optional] | +| **totalSize** | **kotlin.Long** | Disk space in use by containers. | [optional] | +| **items** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.md) | List of container summaries. | [optional] | + + + diff --git a/api-model-v1-52/docs/CreateImageInfo.md b/api-model-v1-52/docs/CreateImageInfo.md new file mode 100644 index 00000000..269e0c6e --- /dev/null +++ b/api-model-v1-52/docs/CreateImageInfo.md @@ -0,0 +1,13 @@ + +# CreateImageInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | [optional] | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/DeviceInfo.md b/api-model-v1-52/docs/DeviceInfo.md new file mode 100644 index 00000000..917d073c --- /dev/null +++ b/api-model-v1-52/docs/DeviceInfo.md @@ -0,0 +1,11 @@ + +# DeviceInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **source** | **kotlin.String** | The origin device driver. | [optional] | +| **ID** | **kotlin.String** | The unique identifier for the device within its source driver. For CDI devices, this would be an FQDN like \"vendor.com/gpu=0\". | [optional] | + + + diff --git a/api-model-v1-52/docs/DeviceMapping.md b/api-model-v1-52/docs/DeviceMapping.md new file mode 100644 index 00000000..d90a503a --- /dev/null +++ b/api-model-v1-52/docs/DeviceMapping.md @@ -0,0 +1,12 @@ + +# DeviceMapping + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pathOnHost** | **kotlin.String** | | [optional] | +| **pathInContainer** | **kotlin.String** | | [optional] | +| **cgroupPermissions** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/DeviceRequest.md b/api-model-v1-52/docs/DeviceRequest.md new file mode 100644 index 00000000..66c8a7bd --- /dev/null +++ b/api-model-v1-52/docs/DeviceRequest.md @@ -0,0 +1,14 @@ + +# DeviceRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | The name of the device driver to use for this request. Note that if this is specified the capabilities are ignored when selecting a device driver. | [optional] | +| **count** | **kotlin.Int** | | [optional] | +| **deviceIDs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **capabilities** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. Note that if a driver is specified the capabilities have no effect on selecting a driver as the driver name is used directly. Note that if no driver is specified the capabilities are used to select a driver with the required capabilities. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [optional] | + + + diff --git a/api-model-v1-52/docs/DistributionInspect.md b/api-model-v1-52/docs/DistributionInspect.md new file mode 100644 index 00000000..fef111c5 --- /dev/null +++ b/api-model-v1-52/docs/DistributionInspect.md @@ -0,0 +1,11 @@ + +# DistributionInspect + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | | +| **platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | | + + + diff --git a/api-model-v1-52/docs/Driver.md b/api-model-v1-52/docs/Driver.md new file mode 100644 index 00000000..1d98106e --- /dev/null +++ b/api-model-v1-52/docs/Driver.md @@ -0,0 +1,11 @@ + +# Driver + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] | + + + diff --git a/api-model-v1-52/docs/DriverData.md b/api-model-v1-52/docs/DriverData.md new file mode 100644 index 00000000..90b4c998 --- /dev/null +++ b/api-model-v1-52/docs/DriverData.md @@ -0,0 +1,11 @@ + +# DriverData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the storage driver. | | +| **`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | [optional] | + + + diff --git a/api-model-v1-52/docs/EndpointIPAMConfig.md b/api-model-v1-52/docs/EndpointIPAMConfig.md new file mode 100644 index 00000000..f12793e4 --- /dev/null +++ b/api-model-v1-52/docs/EndpointIPAMConfig.md @@ -0,0 +1,12 @@ + +# EndpointIPAMConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | +| **linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/EndpointPortConfig.md b/api-model-v1-52/docs/EndpointPortConfig.md new file mode 100644 index 00000000..6dc393a5 --- /dev/null +++ b/api-model-v1-52/docs/EndpointPortConfig.md @@ -0,0 +1,28 @@ + +# EndpointPortConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **protocol** | [**inline**](#Protocol) | | [optional] | +| **targetPort** | **kotlin.Int** | The port inside the container. | [optional] | +| **publishedPort** | **kotlin.Int** | The port on the swarm hosts. | [optional] | +| **publishMode** | [**inline**](#PublishMode) | The mode in which port is published. <p><br /></p> - \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. | [optional] | + + + +## Enum: Protocol +| Name | Value | +| ---- | ----- | +| protocol | tcp, udp, sctp | + + + +## Enum: PublishMode +| Name | Value | +| ---- | ----- | +| publishMode | ingress, host | + + + diff --git a/api-model-v1-52/docs/EndpointResource.md b/api-model-v1-52/docs/EndpointResource.md new file mode 100644 index 00000000..f5a23cf2 --- /dev/null +++ b/api-model-v1-52/docs/EndpointResource.md @@ -0,0 +1,14 @@ + +# EndpointResource + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **endpointID** | **kotlin.String** | | [optional] | +| **macAddress** | **kotlin.String** | | [optional] | +| **ipv4Address** | **kotlin.String** | | [optional] | +| **ipv6Address** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/EndpointSettings.md b/api-model-v1-52/docs/EndpointSettings.md new file mode 100644 index 00000000..718ad05a --- /dev/null +++ b/api-model-v1-52/docs/EndpointSettings.md @@ -0,0 +1,24 @@ + +# EndpointSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **macAddress** | **kotlin.String** | MAC address for the endpoint on this network. The network driver might ignore this parameter. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **gwPriority** | **kotlin.Long** | This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked. | [optional] | +| **networkID** | **kotlin.String** | Unique ID of the network. | [optional] | +| **endpointID** | **kotlin.String** | Unique ID for the service endpoint in a Sandbox. | [optional] | +| **gateway** | **kotlin.String** | Gateway address for this network. | [optional] | +| **ipAddress** | **kotlin.String** | IPv4 address. | [optional] | +| **ipPrefixLen** | **kotlin.Int** | Mask length of the IPv4 address. | [optional] | +| **ipv6Gateway** | **kotlin.String** | IPv6 gateway address. | [optional] | +| **globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] | +| **globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] | +| **dnSNames** | **kotlin.collections.MutableList<kotlin.String>** | List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.<network-name>`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. | [optional] | + + + diff --git a/api-model-v1-52/docs/EndpointSpec.md b/api-model-v1-52/docs/EndpointSpec.md new file mode 100644 index 00000000..9b02a1e3 --- /dev/null +++ b/api-model-v1-52/docs/EndpointSpec.md @@ -0,0 +1,18 @@ + +# EndpointSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | The mode of resolution to use for internal load balancing between tasks. | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. | [optional] | + + + +## Enum: Mode +| Name | Value | +| ---- | ----- | +| mode | vip, dnsrr | + + + diff --git a/api-model-v1-52/docs/EngineDescription.md b/api-model-v1-52/docs/EngineDescription.md new file mode 100644 index 00000000..c9abe8ae --- /dev/null +++ b/api-model-v1-52/docs/EngineDescription.md @@ -0,0 +1,12 @@ + +# EngineDescription + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **engineVersion** | **kotlin.String** | | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | +| **plugins** | [**kotlin.collections.MutableList<EngineDescriptionPluginsInner>**](EngineDescriptionPluginsInner.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/EngineDescriptionPluginsInner.md b/api-model-v1-52/docs/EngineDescriptionPluginsInner.md new file mode 100644 index 00000000..53229a1d --- /dev/null +++ b/api-model-v1-52/docs/EngineDescriptionPluginsInner.md @@ -0,0 +1,11 @@ + +# EngineDescriptionPluginsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ErrorDetail.md b/api-model-v1-52/docs/ErrorDetail.md new file mode 100644 index 00000000..d909c08f --- /dev/null +++ b/api-model-v1-52/docs/ErrorDetail.md @@ -0,0 +1,11 @@ + +# ErrorDetail + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **code** | **kotlin.Int** | | [optional] | +| **message** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ErrorResponse.md b/api-model-v1-52/docs/ErrorResponse.md new file mode 100644 index 00000000..24722b5a --- /dev/null +++ b/api-model-v1-52/docs/ErrorResponse.md @@ -0,0 +1,10 @@ + +# ErrorResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **message** | **kotlin.String** | The error message. | | + + + diff --git a/api-model-v1-52/docs/EventActor.md b/api-model-v1-52/docs/EventActor.md new file mode 100644 index 00000000..62eadd88 --- /dev/null +++ b/api-model-v1-52/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.MutableMap<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] | + + + diff --git a/api-model-v1-52/docs/EventMessage.md b/api-model-v1-52/docs/EventMessage.md new file mode 100644 index 00000000..30e7daf3 --- /dev/null +++ b/api-model-v1-52/docs/EventMessage.md @@ -0,0 +1,29 @@ + +# EventMessage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The type of object emitting the event | [optional] | +| **action** | **kotlin.String** | The type of event | [optional] | +| **actor** | [**EventActor**](EventActor.md) | | [optional] | +| **scope** | [**inline**](#Scope) | 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-v1-52/docs/ExecConfig.md b/api-model-v1-52/docs/ExecConfig.md new file mode 100644 index 00000000..29f9dea7 --- /dev/null +++ b/api-model-v1-52/docs/ExecConfig.md @@ -0,0 +1,20 @@ + +# 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] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [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.MutableList<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] | +| **cmd** | **kotlin.collections.MutableList<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-v1-52/docs/ExecInspectResponse.md b/api-model-v1-52/docs/ExecInspectResponse.md new file mode 100644 index 00000000..17dac875 --- /dev/null +++ b/api-model-v1-52/docs/ExecInspectResponse.md @@ -0,0 +1,20 @@ + +# ExecInspectResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **canRemove** | **kotlin.Boolean** | | [optional] | +| **detachKeys** | **kotlin.String** | | [optional] | +| **ID** | **kotlin.String** | | [optional] | +| **running** | **kotlin.Boolean** | | [optional] | +| **exitCode** | **kotlin.Int** | | [optional] | +| **processConfig** | [**ProcessConfig**](ProcessConfig.md) | | [optional] | +| **openStdin** | **kotlin.Boolean** | | [optional] | +| **openStderr** | **kotlin.Boolean** | | [optional] | +| **openStdout** | **kotlin.Boolean** | | [optional] | +| **containerID** | **kotlin.String** | | [optional] | +| **pid** | **kotlin.Int** | The system process ID for the exec process. | [optional] | + + + diff --git a/api-model-v1-52/docs/ExecStartConfig.md b/api-model-v1-52/docs/ExecStartConfig.md new file mode 100644 index 00000000..8553f097 --- /dev/null +++ b/api-model-v1-52/docs/ExecStartConfig.md @@ -0,0 +1,12 @@ + +# ExecStartConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **detach** | **kotlin.Boolean** | Detach from the command. | [optional] | +| **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | + + + diff --git a/api-model-v1-52/docs/FilesystemChange.md b/api-model-v1-52/docs/FilesystemChange.md new file mode 100644 index 00000000..8354bea7 --- /dev/null +++ b/api-model-v1-52/docs/FilesystemChange.md @@ -0,0 +1,11 @@ + +# FilesystemChange + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Path to file or directory that has changed. | | +| **kind** | [**ChangeType**](ChangeType.md) | | | + + + diff --git a/api-model-v1-52/docs/FirewallInfo.md b/api-model-v1-52/docs/FirewallInfo.md new file mode 100644 index 00000000..e2beb91b --- /dev/null +++ b/api-model-v1-52/docs/FirewallInfo.md @@ -0,0 +1,11 @@ + +# FirewallInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | The name of the firewall backend driver. | [optional] | +| **info** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information about the firewall backend, provided as \"label\" / \"value\" pairs. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | + + + diff --git a/api-model-v1-52/docs/GenericResourcesInner.md b/api-model-v1-52/docs/GenericResourcesInner.md new file mode 100644 index 00000000..0019d861 --- /dev/null +++ b/api-model-v1-52/docs/GenericResourcesInner.md @@ -0,0 +1,11 @@ + +# GenericResourcesInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **namedResourceSpec** | [**GenericResourcesInnerNamedResourceSpec**](GenericResourcesInnerNamedResourceSpec.md) | | [optional] | +| **discreteResourceSpec** | [**GenericResourcesInnerDiscreteResourceSpec**](GenericResourcesInnerDiscreteResourceSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/GenericResourcesInnerDiscreteResourceSpec.md b/api-model-v1-52/docs/GenericResourcesInnerDiscreteResourceSpec.md new file mode 100644 index 00000000..0b8faebe --- /dev/null +++ b/api-model-v1-52/docs/GenericResourcesInnerDiscreteResourceSpec.md @@ -0,0 +1,11 @@ + +# GenericResourcesInnerDiscreteResourceSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.Long** | | [optional] | + + + diff --git a/api-model-v1-52/docs/GenericResourcesInnerNamedResourceSpec.md b/api-model-v1-52/docs/GenericResourcesInnerNamedResourceSpec.md new file mode 100644 index 00000000..0f5ec50d --- /dev/null +++ b/api-model-v1-52/docs/GenericResourcesInnerNamedResourceSpec.md @@ -0,0 +1,11 @@ + +# GenericResourcesInnerNamedResourceSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **kind** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/Health.md b/api-model-v1-52/docs/Health.md new file mode 100644 index 00000000..e888268e --- /dev/null +++ b/api-model-v1-52/docs/Health.md @@ -0,0 +1,19 @@ + +# Health + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **status** | [**inline**](#Status) | Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem | [optional] | +| **failingStreak** | **kotlin.Int** | FailingStreak is the number of consecutive failures | [optional] | +| **log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] | + + + +## Enum: Status +| Name | Value | +| ---- | ----- | +| status | none, starting, healthy, unhealthy | + + + diff --git a/api-model-v1-52/docs/HealthConfig.md b/api-model-v1-52/docs/HealthConfig.md new file mode 100644 index 00000000..a6d4e19c --- /dev/null +++ b/api-model-v1-52/docs/HealthConfig.md @@ -0,0 +1,15 @@ + +# HealthConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **test** | **kotlin.collections.MutableList<kotlin.String>** | The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell | [optional] | +| **interval** | **kotlin.Long** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **timeout** | **kotlin.Long** | The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **retries** | **kotlin.Int** | The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. | [optional] | +| **startPeriod** | **kotlin.Long** | Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | +| **startInterval** | **kotlin.Long** | The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] | + + + diff --git a/api-model-v1-52/docs/HealthcheckResult.md b/api-model-v1-52/docs/HealthcheckResult.md new file mode 100644 index 00000000..1f0ab025 --- /dev/null +++ b/api-model-v1-52/docs/HealthcheckResult.md @@ -0,0 +1,13 @@ + +# HealthcheckResult + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **start** | [**java.time.OffsetDateTime**](java.time.OffsetDateTime.md) | Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **end** | **kotlin.String** | Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **exitCode** | **kotlin.Int** | ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe | [optional] | +| **output** | **kotlin.String** | Output from last check | [optional] | + + + diff --git a/api-model-v1-52/docs/HistoryResponseItem.md b/api-model-v1-52/docs/HistoryResponseItem.md new file mode 100644 index 00000000..dbbce217 --- /dev/null +++ b/api-model-v1-52/docs/HistoryResponseItem.md @@ -0,0 +1,15 @@ + +# HistoryResponseItem + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | | | +| **created** | **kotlin.Long** | | | +| **createdBy** | **kotlin.String** | | | +| **tags** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **propertySize** | **kotlin.Long** | | | +| **comment** | **kotlin.String** | | | + + + diff --git a/api-model-v1-52/docs/HostConfig.md b/api-model-v1-52/docs/HostConfig.md new file mode 100644 index 00000000..27b14b63 --- /dev/null +++ b/api-model-v1-52/docs/HostConfig.md @@ -0,0 +1,92 @@ + +# HostConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | +| **binds** | **kotlin.collections.MutableList<kotlin.String>** | A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. | [optional] | +| **containerIDFile** | **kotlin.String** | Path to a file where the container ID is written | [optional] | +| **logConfig** | [**HostConfigAllOfLogConfig**](HostConfigAllOfLogConfig.md) | | [optional] | +| **networkMode** | **kotlin.String** | Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to. | [optional] | +| **portBindings** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **restartPolicy** | [**RestartPolicy**](RestartPolicy.md) | | [optional] | +| **autoRemove** | **kotlin.Boolean** | Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. | [optional] | +| **volumeDriver** | **kotlin.String** | Driver that this container uses to mount volumes. | [optional] | +| **volumesFrom** | **kotlin.collections.MutableList<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] | +| **consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. | [optional] | +| **annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | [optional] | +| **capAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] | +| **capDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] | +| **cgroupnsMode** | [**inline**](#CgroupnsMode) | cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. | [optional] | +| **dns** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS servers for the container to use. | [optional] | +| **dnsOptions** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS options. | [optional] | +| **dnsSearch** | **kotlin.collections.MutableList<kotlin.String>** | A list of DNS search domains. | [optional] | +| **extraHosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. | [optional] | +| **groupAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **ipcMode** | **kotlin.String** | IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:<name|id>\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. | [optional] | +| **cgroup** | **kotlin.String** | Cgroup to use for the container. | [optional] | +| **links** | **kotlin.collections.MutableList<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [optional] | +| **oomScoreAdj** | **kotlin.Int** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] | +| **pidMode** | **kotlin.String** | Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:<name|id>\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container | [optional] | +| **privileged** | **kotlin.Boolean** | Gives the container full access to the host. | [optional] | +| **publishAllPorts** | **kotlin.Boolean** | Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. | [optional] | +| **readonlyRootfs** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **securityOpt** | **kotlin.collections.MutableList<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] | +| **storageOpt** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] | +| **tmpfs** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` | [optional] | +| **utSMode** | **kotlin.String** | UTS namespace to use for the container. | [optional] | +| **usernsMode** | **kotlin.String** | Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | [optional] | +| **shmSize** | **kotlin.Long** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. This field is omitted if not set. | [optional] | +| **runtime** | **kotlin.String** | Runtime to use with this container. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the container. (Windows only) | [optional] | +| **maskedPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] | +| **readonlyPaths** | **kotlin.collections.MutableList<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] | + + + +## Enum: CgroupnsMode +| Name | Value | +| ---- | ----- | +| cgroupnsMode | private, host | + + + +## Enum: Isolation +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv, | + + + diff --git a/api-model-v1-52/docs/HostConfigAllOfLogConfig.md b/api-model-v1-52/docs/HostConfigAllOfLogConfig.md new file mode 100644 index 00000000..32edda39 --- /dev/null +++ b/api-model-v1-52/docs/HostConfigAllOfLogConfig.md @@ -0,0 +1,18 @@ + +# HostConfigAllOfLogConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | Name of the logging driver used for the container or \"none\" if logging is disabled. | [optional] | +| **config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific configuration options for the logging driver. | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | local, json-file, syslog, journald, gelf, fluentd, awslogs, splunk, etwlogs, none | + + + diff --git a/api-model-v1-52/docs/IDResponse.md b/api-model-v1-52/docs/IDResponse.md new file mode 100644 index 00000000..8024287d --- /dev/null +++ b/api-model-v1-52/docs/IDResponse.md @@ -0,0 +1,10 @@ + +# IDResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The id of the newly created object. | | + + + diff --git a/api-model-v1-52/docs/IPAM.md b/api-model-v1-52/docs/IPAM.md new file mode 100644 index 00000000..0dcc133a --- /dev/null +++ b/api-model-v1-52/docs/IPAM.md @@ -0,0 +1,12 @@ + +# IPAM + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] | +| **config** | [**kotlin.collections.MutableList<IPAMConfig>**](IPAMConfig.md) | List of IPAM configuration options, specified as a map: ``` {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>} ``` | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] | + + + diff --git a/api-model-v1-52/docs/IPAMConfig.md b/api-model-v1-52/docs/IPAMConfig.md new file mode 100644 index 00000000..f667c688 --- /dev/null +++ b/api-model-v1-52/docs/IPAMConfig.md @@ -0,0 +1,13 @@ + +# IPAMConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **subnet** | **kotlin.String** | | [optional] | +| **ipRange** | **kotlin.String** | | [optional] | +| **gateway** | **kotlin.String** | | [optional] | +| **auxiliaryAddresses** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/IPAMStatus.md b/api-model-v1-52/docs/IPAMStatus.md new file mode 100644 index 00000000..d44730b7 --- /dev/null +++ b/api-model-v1-52/docs/IPAMStatus.md @@ -0,0 +1,10 @@ + +# IPAMStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **subnets** | [**kotlin.collections.MutableMap<kotlin.String, SubnetStatus>**](SubnetStatus.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageConfig.md b/api-model-v1-52/docs/ImageConfig.md new file mode 100644 index 00000000..271d9dfa --- /dev/null +++ b/api-model-v1-52/docs/ImageConfig.md @@ -0,0 +1,22 @@ + +# ImageConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **user** | **kotlin.String** | The user that commands are run as inside the container. | [optional] | +| **exposedPorts** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. | [optional] | +| **cmd** | **kotlin.collections.MutableList<kotlin.String>** | Command to run specified as a string or an array of strings. | [optional] | +| **healthcheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **argsEscaped** | **kotlin.Boolean** | Command is already escaped (Windows only) | [optional] | +| **volumes** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [optional] | +| **workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional] | +| **onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop a container as a string or unsigned integer. | [optional] | +| **shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageDeleteResponseItem.md b/api-model-v1-52/docs/ImageDeleteResponseItem.md new file mode 100644 index 00000000..a5ea281f --- /dev/null +++ b/api-model-v1-52/docs/ImageDeleteResponseItem.md @@ -0,0 +1,11 @@ + +# ImageDeleteResponseItem + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **untagged** | **kotlin.String** | The image ID of an image that was untagged | [optional] | +| **deleted** | **kotlin.String** | The image ID of an image that was deleted | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageID.md b/api-model-v1-52/docs/ImageID.md new file mode 100644 index 00000000..6717d92f --- /dev/null +++ b/api-model-v1-52/docs/ImageID.md @@ -0,0 +1,10 @@ + +# ImageID + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageInspect.md b/api-model-v1-52/docs/ImageInspect.md new file mode 100644 index 00000000..3dfc99be --- /dev/null +++ b/api-model-v1-52/docs/ImageInspect.md @@ -0,0 +1,26 @@ + +# ImageInspect + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | [optional] | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | [optional] | +| **manifests** | [**kotlin.collections.MutableList<ImageManifestSummary>**](ImageManifestSummary.md) | Manifests is a list of image manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. Only available if the daemon provides a multi-platform image store and the `manifests` option is set in the inspect request. WARNING: This is experimental and may change at any time without any backward compatibility. | [optional] | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **comment** | **kotlin.String** | Optional message that was set when committing or importing the image. | [optional] | +| **created** | **kotlin.String** | Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. | [optional] | +| **author** | **kotlin.String** | Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. | [optional] | +| **config** | [**ImageConfig**](ImageConfig.md) | | [optional] | +| **architecture** | **kotlin.String** | Hardware CPU architecture that the image runs on. | [optional] | +| **variant** | **kotlin.String** | CPU architecture variant (presently ARM-only). | [optional] | +| **os** | **kotlin.String** | Operating System the image is built to run on. | [optional] | +| **osVersion** | **kotlin.String** | Operating System version the image is built to run on (especially for Windows). | [optional] | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | [optional] | +| **graphDriver** | [**DriverData**](DriverData.md) | | [optional] | +| **rootFS** | [**ImageInspectRootFS**](ImageInspectRootFS.md) | | [optional] | +| **metadata** | [**ImageInspectMetadata**](ImageInspectMetadata.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageInspectMetadata.md b/api-model-v1-52/docs/ImageInspectMetadata.md new file mode 100644 index 00000000..4a2386cd --- /dev/null +++ b/api-model-v1-52/docs/ImageInspectMetadata.md @@ -0,0 +1,10 @@ + +# ImageInspectMetadata + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **lastTagTime** | **kotlin.String** | Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageInspectRootFS.md b/api-model-v1-52/docs/ImageInspectRootFS.md new file mode 100644 index 00000000..503e2a52 --- /dev/null +++ b/api-model-v1-52/docs/ImageInspectRootFS.md @@ -0,0 +1,11 @@ + +# ImageInspectRootFS + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | +| **layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageManifestSummary.md b/api-model-v1-52/docs/ImageManifestSummary.md new file mode 100644 index 00000000..8a23d873 --- /dev/null +++ b/api-model-v1-52/docs/ImageManifestSummary.md @@ -0,0 +1,23 @@ + +# ImageManifestSummary + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | ID is the content-addressable ID of an image and is the same as the digest of the image manifest. | | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | | +| **available** | **kotlin.Boolean** | Indicates whether all the child content (image config, layers) is fully available locally. | | +| **propertySize** | [**ImageManifestSummarySize**](ImageManifestSummarySize.md) | | | +| **kind** | [**inline**](#Kind) | The kind of the manifest. kind | description -------------|----------------------------------------------------------- image | Image manifest that can be used to start a container. attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. | | +| **imageData** | [**ImageManifestSummaryImageData**](ImageManifestSummaryImageData.md) | | [optional] | +| **attestationData** | [**ImageManifestSummaryAttestationData**](ImageManifestSummaryAttestationData.md) | | [optional] | + + + +## Enum: Kind +| Name | Value | +| ---- | ----- | +| kind | image, attestation, unknown | + + + diff --git a/api-model-v1-52/docs/ImageManifestSummaryAttestationData.md b/api-model-v1-52/docs/ImageManifestSummaryAttestationData.md new file mode 100644 index 00000000..cf61eead --- /dev/null +++ b/api-model-v1-52/docs/ImageManifestSummaryAttestationData.md @@ -0,0 +1,10 @@ + +# ImageManifestSummaryAttestationData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **`for`** | **kotlin.String** | The digest of the image manifest that this attestation is for. | | + + + diff --git a/api-model-v1-52/docs/ImageManifestSummaryImageData.md b/api-model-v1-52/docs/ImageManifestSummaryImageData.md new file mode 100644 index 00000000..43263535 --- /dev/null +++ b/api-model-v1-52/docs/ImageManifestSummaryImageData.md @@ -0,0 +1,12 @@ + +# ImageManifestSummaryImageData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **platform** | [**OCIPlatform**](OCIPlatform.md) | | | +| **containers** | **kotlin.collections.MutableList<kotlin.String>** | The IDs of the containers that are using this image. | | +| **propertySize** | [**ImageManifestSummaryImageDataSize**](ImageManifestSummaryImageDataSize.md) | | | + + + diff --git a/api-model-v1-52/docs/ImageManifestSummaryImageDataSize.md b/api-model-v1-52/docs/ImageManifestSummaryImageDataSize.md new file mode 100644 index 00000000..cd5b060e --- /dev/null +++ b/api-model-v1-52/docs/ImageManifestSummaryImageDataSize.md @@ -0,0 +1,10 @@ + +# ImageManifestSummaryImageDataSize + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unpacked** | **kotlin.Long** | Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image content that's directly usable by the containers running this image. It's independent of the distributable content - e.g. the image might still have an unpacked data that's still used by some container even when the distributable/compressed content is already gone. | | + + + diff --git a/api-model-v1-52/docs/ImageManifestSummarySize.md b/api-model-v1-52/docs/ImageManifestSummarySize.md new file mode 100644 index 00000000..1f507ec4 --- /dev/null +++ b/api-model-v1-52/docs/ImageManifestSummarySize.md @@ -0,0 +1,11 @@ + +# ImageManifestSummarySize + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **total** | **kotlin.Long** | Total is the total size (in bytes) of all the locally present data (both distributable and non-distributable) that's related to this manifest and its children. This equal to the sum of [Content] size AND all the sizes in the [Size] struct present in the Kind-specific data struct. For example, for an image kind (Kind == \"image\") this would include the size of the image content and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]). | | +| **content** | **kotlin.Long** | Content is the size (in bytes) of all the locally present content in the content store (e.g. image config, layers) referenced by this manifest and its children. This only includes blobs in the content store. | | + + + diff --git a/api-model-v1-52/docs/ImagePruneResponse.md b/api-model-v1-52/docs/ImagePruneResponse.md new file mode 100644 index 00000000..79320b4a --- /dev/null +++ b/api-model-v1-52/docs/ImagePruneResponse.md @@ -0,0 +1,11 @@ + +# ImagePruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **imagesDeleted** | [**kotlin.collections.MutableList<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageSearchResponseItem.md b/api-model-v1-52/docs/ImageSearchResponseItem.md new file mode 100644 index 00000000..0831f12b --- /dev/null +++ b/api-model-v1-52/docs/ImageSearchResponseItem.md @@ -0,0 +1,14 @@ + +# ImageSearchResponseItem + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | [optional] | +| **official** | **kotlin.Boolean** | | [optional] | +| **automated** | **kotlin.Boolean** | Whether this repository has automated builds enabled. <p><br /></p> > **Deprecated**: This field is deprecated and will always be \"false\". | [optional] | +| **name** | **kotlin.String** | | [optional] | +| **starCount** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ImageSummary.md b/api-model-v1-52/docs/ImageSummary.md new file mode 100644 index 00000000..fd2a477e --- /dev/null +++ b/api-model-v1-52/docs/ImageSummary.md @@ -0,0 +1,20 @@ + +# ImageSummary + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. | | +| **parentId** | **kotlin.String** | ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. | | +| **created** | **kotlin.Int** | Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). | | +| **propertySize** | **kotlin.Long** | Total size of the image including all layers it is composed of. | | +| **sharedSize** | **kotlin.Long** | Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. | | +| **containers** | **kotlin.Int** | Number of containers using this image. Includes both stopped and running containers. `-1` indicates that the value has not been set / calculated. | | +| **repoTags** | **kotlin.collections.MutableList<kotlin.String>** | List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. | [optional] | +| **repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **manifests** | [**kotlin.collections.MutableList<ImageManifestSummary>**](ImageManifestSummary.md) | Manifests is a list of manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. WARNING: This is experimental and may change at any time without any backward compatibility. | [optional] | +| **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ImagesDiskUsage.md b/api-model-v1-52/docs/ImagesDiskUsage.md new file mode 100644 index 00000000..a8a54da4 --- /dev/null +++ b/api-model-v1-52/docs/ImagesDiskUsage.md @@ -0,0 +1,14 @@ + +# ImagesDiskUsage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **activeCount** | **kotlin.Long** | Count of active images. | [optional] | +| **totalCount** | **kotlin.Long** | Count of all images. | [optional] | +| **reclaimable** | **kotlin.Long** | Disk space that can be reclaimed by removing unused images. | [optional] | +| **totalSize** | **kotlin.Long** | Disk space in use by images. | [optional] | +| **items** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.md) | List of image summaries. | [optional] | + + + diff --git a/api-model-v1-52/docs/IndexInfo.md b/api-model-v1-52/docs/IndexInfo.md new file mode 100644 index 00000000..6b714641 --- /dev/null +++ b/api-model-v1-52/docs/IndexInfo.md @@ -0,0 +1,13 @@ + +# IndexInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of mirrors, expressed as URIs. | [optional] | +| **secure** | **kotlin.Boolean** | Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. | [optional] | +| **official** | **kotlin.Boolean** | Indicates whether this is an official registry (i.e., Docker Hub / docker.io) | [optional] | + + + diff --git a/api-model-v1-52/docs/JoinTokens.md b/api-model-v1-52/docs/JoinTokens.md new file mode 100644 index 00000000..5055d1c0 --- /dev/null +++ b/api-model-v1-52/docs/JoinTokens.md @@ -0,0 +1,11 @@ + +# JoinTokens + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **worker** | **kotlin.String** | The token workers can use to join the swarm. | [optional] | +| **manager** | **kotlin.String** | The token managers can use to join the swarm. | [optional] | + + + diff --git a/api-model-v1-52/docs/Limit.md b/api-model-v1-52/docs/Limit.md new file mode 100644 index 00000000..09c047eb --- /dev/null +++ b/api-model-v1-52/docs/Limit.md @@ -0,0 +1,12 @@ + +# Limit + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **pids** | **kotlin.Long** | Limits the maximum number of PIDs in the container. Set `0` for unlimited. | [optional] | + + + diff --git a/api-model-v1-52/docs/LocalNodeState.md b/api-model-v1-52/docs/LocalNodeState.md new file mode 100644 index 00000000..addf82f9 --- /dev/null +++ b/api-model-v1-52/docs/LocalNodeState.md @@ -0,0 +1,20 @@ + +# LocalNodeState + +## Enum + + + * `EMPTY` (value: `""`) + + * `Inactive` (value: `"inactive"`) + + * `Pending` (value: `"pending"`) + + * `Active` (value: `"active"`) + + * `Error` (value: `"error"`) + + * `Locked` (value: `"locked"`) + + + diff --git a/api-model-v1-52/docs/ManagerStatus.md b/api-model-v1-52/docs/ManagerStatus.md new file mode 100644 index 00000000..bfaa004e --- /dev/null +++ b/api-model-v1-52/docs/ManagerStatus.md @@ -0,0 +1,12 @@ + +# ManagerStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **leader** | **kotlin.Boolean** | | [optional] | +| **reachability** | [**Reachability**](Reachability.md) | | [optional] | +| **addr** | **kotlin.String** | The IP address and port at which the manager is reachable. | [optional] | + + + diff --git a/api-model-v1-52/docs/Mount.md b/api-model-v1-52/docs/Mount.md new file mode 100644 index 00000000..40df1ed9 --- /dev/null +++ b/api-model-v1-52/docs/Mount.md @@ -0,0 +1,25 @@ + +# Mount + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | Container path. | [optional] | +| **source** | **kotlin.String** | Mount source (e.g. a volume name, a host path). | [optional] | +| **type** | [**inline**](#Type) | The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `image` Mounts an image. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume | [optional] | +| **readOnly** | **kotlin.Boolean** | Whether the mount should be read-only. | [optional] | +| **consistency** | **kotlin.String** | The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. | [optional] | +| **bindOptions** | [**MountBindOptions**](MountBindOptions.md) | | [optional] | +| **volumeOptions** | [**MountVolumeOptions**](MountVolumeOptions.md) | | [optional] | +| **imageOptions** | [**MountImageOptions**](MountImageOptions.md) | | [optional] | +| **tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | bind, volume, image, tmpfs, npipe, cluster | + + + diff --git a/api-model-v1-52/docs/MountBindOptions.md b/api-model-v1-52/docs/MountBindOptions.md new file mode 100644 index 00000000..a7c987c4 --- /dev/null +++ b/api-model-v1-52/docs/MountBindOptions.md @@ -0,0 +1,21 @@ + +# MountBindOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propagation** | [**inline**](#Propagation) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] | +| **nonRecursive** | **kotlin.Boolean** | Disable recursive bind mount. | [optional] | +| **createMountpoint** | **kotlin.Boolean** | Create mount point on host if missing | [optional] | +| **readOnlyNonRecursive** | **kotlin.Boolean** | Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to `true` in conjunction). Added in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to `true` for clients on versions prior to v1.44. | [optional] | +| **readOnlyForceRecursive** | **kotlin.Boolean** | Raise an error if the mount cannot be made recursively read-only. | [optional] | + + + +## Enum: Propagation +| Name | Value | +| ---- | ----- | +| propagation | private, rprivate, shared, rshared, slave, rslave | + + + diff --git a/api-model-v1-52/docs/MountImageOptions.md b/api-model-v1-52/docs/MountImageOptions.md new file mode 100644 index 00000000..076dd194 --- /dev/null +++ b/api-model-v1-52/docs/MountImageOptions.md @@ -0,0 +1,10 @@ + +# MountImageOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **subpath** | **kotlin.String** | Source path inside the image. Must be relative without any back traversals. | [optional] | + + + diff --git a/api-model-v1-52/docs/MountPoint.md b/api-model-v1-52/docs/MountPoint.md new file mode 100644 index 00000000..c61b4425 --- /dev/null +++ b/api-model-v1-52/docs/MountPoint.md @@ -0,0 +1,24 @@ + +# MountPoint + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | [**inline**](#Type) | The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `image` a docker image - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume | [optional] | +| **name** | **kotlin.String** | Name is the name reference to the underlying data defined by `Source` e.g., the volume name. | [optional] | +| **source** | **kotlin.String** | Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. | [optional] | +| **destination** | **kotlin.String** | Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. | [optional] | +| **driver** | **kotlin.String** | Driver is the volume driver used to create the volume (if it is a volume). | [optional] | +| **mode** | **kotlin.String** | Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). | [optional] | +| **RW** | **kotlin.Boolean** | Whether the mount is mounted writable (read-write). | [optional] | +| **propagation** | **kotlin.String** | Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | bind, volume, image, tmpfs, npipe, cluster | + + + diff --git a/api-model-v1-52/docs/MountTmpfsOptions.md b/api-model-v1-52/docs/MountTmpfsOptions.md new file mode 100644 index 00000000..22c287ed --- /dev/null +++ b/api-model-v1-52/docs/MountTmpfsOptions.md @@ -0,0 +1,12 @@ + +# MountTmpfsOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **sizeBytes** | **kotlin.Long** | The size for the tmpfs mount in bytes. | [optional] | +| **mode** | **kotlin.Int** | The permission mode for the tmpfs mount in an integer. | [optional] | +| **options** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | The options to be passed to the tmpfs mount. An array of arrays. Flag options should be provided as 1-length arrays. Other types should be provided as as 2-length arrays, where the first item is the key and the second the value. | [optional] | + + + diff --git a/api-model-v1-52/docs/MountVolumeOptions.md b/api-model-v1-52/docs/MountVolumeOptions.md new file mode 100644 index 00000000..44ad3ede --- /dev/null +++ b/api-model-v1-52/docs/MountVolumeOptions.md @@ -0,0 +1,13 @@ + +# MountVolumeOptions + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **driverConfig** | [**MountVolumeOptionsDriverConfig**](MountVolumeOptionsDriverConfig.md) | | [optional] | +| **subpath** | **kotlin.String** | Source path inside the volume. Must be relative without any back traversals. | [optional] | + + + diff --git a/api-model-v1-52/docs/MountVolumeOptionsDriverConfig.md b/api-model-v1-52/docs/MountVolumeOptionsDriverConfig.md new file mode 100644 index 00000000..3cb98230 --- /dev/null +++ b/api-model-v1-52/docs/MountVolumeOptionsDriverConfig.md @@ -0,0 +1,11 @@ + +# MountVolumeOptionsDriverConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] | + + + diff --git a/api-model-v1-52/docs/Network.md b/api-model-v1-52/docs/Network.md new file mode 100644 index 00000000..5c533bd6 --- /dev/null +++ b/api-model-v1-52/docs/Network.md @@ -0,0 +1,25 @@ + +# Network + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the network. | [optional] | +| **id** | **kotlin.String** | ID that uniquely identifies a network on a single machine. | [optional] | +| **created** | **kotlin.String** | Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **scope** | **kotlin.String** | The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) | [optional] | +| **driver** | **kotlin.String** | The name of the driver used to create the network (e.g. `bridge`, `overlay`). | [optional] | +| **enableIPv4** | **kotlin.Boolean** | Whether the network was created with IPv4 enabled. | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Whether the network was created with IPv6 enabled. | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **`internal`** | **kotlin.Boolean** | Whether the network is created to only allow internal networking connectivity. | [optional] | +| **attachable** | **kotlin.Boolean** | Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. | [optional] | +| **ingress** | **kotlin.Boolean** | Whether the network is providing the routing-mesh for the swarm cluster. | [optional] | +| **configFrom** | [**ConfigReference**](ConfigReference.md) | | [optional] | +| **configOnly** | **kotlin.Boolean** | Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network-specific options uses when creating the network. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Metadata specific to the network being created. | [optional] | +| **peers** | [**kotlin.collections.MutableList<PeerInfo>**](PeerInfo.md) | List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkAttachmentConfig.md b/api-model-v1-52/docs/NetworkAttachmentConfig.md new file mode 100644 index 00000000..3f9c3cc4 --- /dev/null +++ b/api-model-v1-52/docs/NetworkAttachmentConfig.md @@ -0,0 +1,12 @@ + +# NetworkAttachmentConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] | +| **aliases** | **kotlin.collections.MutableList<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkConnectRequest.md b/api-model-v1-52/docs/NetworkConnectRequest.md new file mode 100644 index 00000000..9f9d90c2 --- /dev/null +++ b/api-model-v1-52/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. | | +| **endpointConfig** | [**EndpointSettings**](EndpointSettings.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkCreateRequest.md b/api-model-v1-52/docs/NetworkCreateRequest.md new file mode 100644 index 00000000..f06ac806 --- /dev/null +++ b/api-model-v1-52/docs/NetworkCreateRequest.md @@ -0,0 +1,22 @@ + +# NetworkCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The network's name. | | +| **driver** | **kotlin.String** | Name of the network driver plugin to use. | [optional] | +| **scope** | **kotlin.String** | The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level). | [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] | +| **configOnly** | **kotlin.Boolean** | Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. | [optional] | +| **configFrom** | [**ConfigReference**](ConfigReference.md) | | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **enableIPv4** | **kotlin.Boolean** | Enable IPv4 on the network. | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkCreateResponse.md b/api-model-v1-52/docs/NetworkCreateResponse.md new file mode 100644 index 00000000..e32b7618 --- /dev/null +++ b/api-model-v1-52/docs/NetworkCreateResponse.md @@ -0,0 +1,11 @@ + +# NetworkCreateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **id** | **kotlin.String** | The ID of the created network. | | +| **warning** | **kotlin.String** | Warnings encountered when creating the container | | + + + diff --git a/api-model-v1-52/docs/NetworkDisconnectRequest.md b/api-model-v1-52/docs/NetworkDisconnectRequest.md new file mode 100644 index 00000000..b8a9ab93 --- /dev/null +++ b/api-model-v1-52/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. | | +| **force** | **kotlin.Boolean** | Force the container to disconnect from the network. | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkInspect.md b/api-model-v1-52/docs/NetworkInspect.md new file mode 100644 index 00000000..969ace8b --- /dev/null +++ b/api-model-v1-52/docs/NetworkInspect.md @@ -0,0 +1,28 @@ + +# NetworkInspect + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the network. | [optional] | +| **id** | **kotlin.String** | ID that uniquely identifies a network on a single machine. | [optional] | +| **created** | **kotlin.String** | Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **scope** | **kotlin.String** | The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) | [optional] | +| **driver** | **kotlin.String** | The name of the driver used to create the network (e.g. `bridge`, `overlay`). | [optional] | +| **enableIPv4** | **kotlin.Boolean** | Whether the network was created with IPv4 enabled. | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Whether the network was created with IPv6 enabled. | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **`internal`** | **kotlin.Boolean** | Whether the network is created to only allow internal networking connectivity. | [optional] | +| **attachable** | **kotlin.Boolean** | Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. | [optional] | +| **ingress** | **kotlin.Boolean** | Whether the network is providing the routing-mesh for the swarm cluster. | [optional] | +| **configFrom** | [**ConfigReference**](ConfigReference.md) | | [optional] | +| **configOnly** | **kotlin.Boolean** | Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network-specific options uses when creating the network. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Metadata specific to the network being created. | [optional] | +| **peers** | [**kotlin.collections.MutableList<PeerInfo>**](PeerInfo.md) | List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. | [optional] | +| **containers** | [**kotlin.collections.MutableMap<kotlin.String, EndpointResource>**](EndpointResource.md) | Contains endpoints attached to the network. | [optional] | +| **services** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | List of services using the network. This field is only present for swarm scope networks, and omitted for local scope networks. | [optional] | +| **status** | [**NetworkStatus**](NetworkStatus.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkPruneResponse.md b/api-model-v1-52/docs/NetworkPruneResponse.md new file mode 100644 index 00000000..9458d15f --- /dev/null +++ b/api-model-v1-52/docs/NetworkPruneResponse.md @@ -0,0 +1,10 @@ + +# NetworkPruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkSettings.md b/api-model-v1-52/docs/NetworkSettings.md new file mode 100644 index 00000000..12884ee8 --- /dev/null +++ b/api-model-v1-52/docs/NetworkSettings.md @@ -0,0 +1,13 @@ + +# NetworkSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **sandboxID** | **kotlin.String** | SandboxID uniquely represents a container's network stack. | [optional] | +| **sandboxKey** | **kotlin.String** | SandboxKey is the full path of the netns handle | [optional] | +| **ports** | **kotlin.collections.MutableMap<kotlin.String, kotlin.collections.MutableList<PortBinding>>** | PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. | [optional] | +| **networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkStatus.md b/api-model-v1-52/docs/NetworkStatus.md new file mode 100644 index 00000000..84275ef8 --- /dev/null +++ b/api-model-v1-52/docs/NetworkStatus.md @@ -0,0 +1,10 @@ + +# NetworkStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **IPAM** | [**IPAMStatus**](IPAMStatus.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkSummary.md b/api-model-v1-52/docs/NetworkSummary.md new file mode 100644 index 00000000..3d9d0569 --- /dev/null +++ b/api-model-v1-52/docs/NetworkSummary.md @@ -0,0 +1,25 @@ + +# NetworkSummary + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the network. | [optional] | +| **id** | **kotlin.String** | ID that uniquely identifies a network on a single machine. | [optional] | +| **created** | **kotlin.String** | Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **scope** | **kotlin.String** | The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) | [optional] | +| **driver** | **kotlin.String** | The name of the driver used to create the network (e.g. `bridge`, `overlay`). | [optional] | +| **enableIPv4** | **kotlin.Boolean** | Whether the network was created with IPv4 enabled. | [optional] | +| **enableIPv6** | **kotlin.Boolean** | Whether the network was created with IPv6 enabled. | [optional] | +| **IPAM** | [**IPAM**](IPAM.md) | | [optional] | +| **`internal`** | **kotlin.Boolean** | Whether the network is created to only allow internal networking connectivity. | [optional] | +| **attachable** | **kotlin.Boolean** | Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. | [optional] | +| **ingress** | **kotlin.Boolean** | Whether the network is providing the routing-mesh for the swarm cluster. | [optional] | +| **configFrom** | [**ConfigReference**](ConfigReference.md) | | [optional] | +| **configOnly** | **kotlin.Boolean** | Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Network-specific options uses when creating the network. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Metadata specific to the network being created. | [optional] | +| **peers** | [**kotlin.collections.MutableList<PeerInfo>**](PeerInfo.md) | List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkTaskInfo.md b/api-model-v1-52/docs/NetworkTaskInfo.md new file mode 100644 index 00000000..e7a48a71 --- /dev/null +++ b/api-model-v1-52/docs/NetworkTaskInfo.md @@ -0,0 +1,13 @@ + +# NetworkTaskInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **endpointID** | **kotlin.String** | | [optional] | +| **endpointIP** | **kotlin.String** | | [optional] | +| **info** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/NetworkingConfig.md b/api-model-v1-52/docs/NetworkingConfig.md new file mode 100644 index 00000000..72814533 --- /dev/null +++ b/api-model-v1-52/docs/NetworkingConfig.md @@ -0,0 +1,10 @@ + +# NetworkingConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. | [optional] | + + + diff --git a/api-model-v1-52/docs/Node.md b/api-model-v1-52/docs/Node.md new file mode 100644 index 00000000..8c180d58 --- /dev/null +++ b/api-model-v1-52/docs/Node.md @@ -0,0 +1,17 @@ + +# Node + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**NodeSpec**](NodeSpec.md) | | [optional] | +| **description** | [**NodeDescription**](NodeDescription.md) | | [optional] | +| **status** | [**NodeStatus**](NodeStatus.md) | | [optional] | +| **managerStatus** | [**ManagerStatus**](ManagerStatus.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/NodeDescription.md b/api-model-v1-52/docs/NodeDescription.md new file mode 100644 index 00000000..9f9e1538 --- /dev/null +++ b/api-model-v1-52/docs/NodeDescription.md @@ -0,0 +1,14 @@ + +# NodeDescription + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostname** | **kotlin.String** | | [optional] | +| **platform** | [**Platform**](Platform.md) | | [optional] | +| **resources** | [**ResourceObject**](ResourceObject.md) | | [optional] | +| **engine** | [**EngineDescription**](EngineDescription.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/NodeSpec.md b/api-model-v1-52/docs/NodeSpec.md new file mode 100644 index 00000000..c4bf3121 --- /dev/null +++ b/api-model-v1-52/docs/NodeSpec.md @@ -0,0 +1,27 @@ + +# NodeSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name for the node. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **role** | [**inline**](#Role) | Role of the node. | [optional] | +| **availability** | [**inline**](#Availability) | Availability of the node. | [optional] | + + + +## Enum: Role +| Name | Value | +| ---- | ----- | +| role | worker, manager | + + + +## Enum: Availability +| Name | Value | +| ---- | ----- | +| availability | active, pause, drain | + + + diff --git a/api-model-v1-52/docs/NodeState.md b/api-model-v1-52/docs/NodeState.md new file mode 100644 index 00000000..b075d3fa --- /dev/null +++ b/api-model-v1-52/docs/NodeState.md @@ -0,0 +1,16 @@ + +# NodeState + +## Enum + + + * `Unknown` (value: `"unknown"`) + + * `Down` (value: `"down"`) + + * `Ready` (value: `"ready"`) + + * `Disconnected` (value: `"disconnected"`) + + + diff --git a/api-model-v1-52/docs/NodeStatus.md b/api-model-v1-52/docs/NodeStatus.md new file mode 100644 index 00000000..426c3f2d --- /dev/null +++ b/api-model-v1-52/docs/NodeStatus.md @@ -0,0 +1,12 @@ + +# NodeStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**NodeState**](NodeState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | IP address of the node. | [optional] | + + + diff --git a/api-model-v1-52/docs/OCIDescriptor.md b/api-model-v1-52/docs/OCIDescriptor.md new file mode 100644 index 00000000..cebecab3 --- /dev/null +++ b/api-model-v1-52/docs/OCIDescriptor.md @@ -0,0 +1,17 @@ + +# 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] | +| **propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] | +| **urls** | [**kotlin.collections.MutableList<java.net.URI>**](java.net.URI.md) | List of URLs from which this object MAY be downloaded. | [optional] | +| **annotations** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Arbitrary metadata relating to the targeted content. | [optional] | +| **`data`** | **kotlin.String** | Data is an embedding of the targeted content. This is encoded as a base64 string when marshalled to JSON (automatically, by encoding/json). If present, Data can be used directly to avoid fetching the targeted content. | [optional] | +| **platform** | [**OCIPlatform**](OCIPlatform.md) | | [optional] | +| **artifactType** | **kotlin.String** | ArtifactType is the IANA media type of this artifact. | [optional] | + + + diff --git a/api-model-v1-52/docs/OCIPlatform.md b/api-model-v1-52/docs/OCIPlatform.md new file mode 100644 index 00000000..606c4124 --- /dev/null +++ b/api-model-v1-52/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.MutableList<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-v1-52/docs/ObjectVersion.md b/api-model-v1-52/docs/ObjectVersion.md new file mode 100644 index 00000000..a2584d76 --- /dev/null +++ b/api-model-v1-52/docs/ObjectVersion.md @@ -0,0 +1,10 @@ + +# ObjectVersion + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **index** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/PeerInfo.md b/api-model-v1-52/docs/PeerInfo.md new file mode 100644 index 00000000..b83ec38a --- /dev/null +++ b/api-model-v1-52/docs/PeerInfo.md @@ -0,0 +1,11 @@ + +# PeerInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | ID of the peer-node in the Swarm cluster. | [optional] | +| **IP** | **kotlin.String** | IP-address of the peer-node in the Swarm cluster. | [optional] | + + + diff --git a/api-model-v1-52/docs/PeerNode.md b/api-model-v1-52/docs/PeerNode.md new file mode 100644 index 00000000..e3954b83 --- /dev/null +++ b/api-model-v1-52/docs/PeerNode.md @@ -0,0 +1,11 @@ + +# PeerNode + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **addr** | **kotlin.String** | IP address and ports at which this node can be reached. | [optional] | + + + diff --git a/api-model-v1-52/docs/Platform.md b/api-model-v1-52/docs/Platform.md new file mode 100644 index 00000000..d8a705d2 --- /dev/null +++ b/api-model-v1-52/docs/Platform.md @@ -0,0 +1,11 @@ + +# Platform + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **architecture** | **kotlin.String** | Architecture represents the hardware architecture (for example, `x86_64`). | [optional] | +| **OS** | **kotlin.String** | OS represents the Operating System (for example, `linux` or `windows`). | [optional] | + + + diff --git a/api-model-v1-52/docs/Plugin.md b/api-model-v1-52/docs/Plugin.md new file mode 100644 index 00000000..cd67ed8a --- /dev/null +++ b/api-model-v1-52/docs/Plugin.md @@ -0,0 +1,15 @@ + +# Plugin + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **enabled** | **kotlin.Boolean** | True if the plugin is running. False if the plugin is not running, only installed. | | +| **settings** | [**PluginSettings**](PluginSettings.md) | | | +| **config** | [**PluginConfig**](PluginConfig.md) | | | +| **id** | **kotlin.String** | | [optional] | +| **pluginReference** | **kotlin.String** | plugin remote reference used to push/pull the plugin | [optional] | + + + diff --git a/api-model-v1-52/docs/PluginConfig.md b/api-model-v1-52/docs/PluginConfig.md new file mode 100644 index 00000000..f37199f2 --- /dev/null +++ b/api-model-v1-52/docs/PluginConfig.md @@ -0,0 +1,24 @@ + +# PluginConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **description** | **kotlin.String** | | | +| **documentation** | **kotlin.String** | | | +| **`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | | +| **entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **workDir** | **kotlin.String** | | | +| **network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | | | +| **linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | | | +| **propagatedMount** | **kotlin.String** | | | +| **ipcHost** | **kotlin.Boolean** | | | +| **pidHost** | **kotlin.Boolean** | | | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | [**kotlin.collections.MutableList<PluginEnv>**](PluginEnv.md) | | | +| **args** | [**PluginConfigArgs**](PluginConfigArgs.md) | | | +| **user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional] | +| **rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/PluginConfigArgs.md b/api-model-v1-52/docs/PluginConfigArgs.md new file mode 100644 index 00000000..77ce533c --- /dev/null +++ b/api-model-v1-52/docs/PluginConfigArgs.md @@ -0,0 +1,13 @@ + +# PluginConfigArgs + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | | + + + diff --git a/api-model-v1-52/docs/PluginConfigInterface.md b/api-model-v1-52/docs/PluginConfigInterface.md new file mode 100644 index 00000000..39535090 --- /dev/null +++ b/api-model-v1-52/docs/PluginConfigInterface.md @@ -0,0 +1,19 @@ + +# PluginConfigInterface + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **types** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **socket** | **kotlin.String** | | | +| **protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] | + + + +## Enum: ProtocolScheme +| Name | Value | +| ---- | ----- | +| protocolScheme | , moby.plugins.http/v1 | + + + diff --git a/api-model-v1-52/docs/PluginConfigLinux.md b/api-model-v1-52/docs/PluginConfigLinux.md new file mode 100644 index 00000000..f3ca6ce8 --- /dev/null +++ b/api-model-v1-52/docs/PluginConfigLinux.md @@ -0,0 +1,12 @@ + +# PluginConfigLinux + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **allowAllDevices** | **kotlin.Boolean** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | + + + diff --git a/api-model-v1-52/docs/PluginConfigNetwork.md b/api-model-v1-52/docs/PluginConfigNetwork.md new file mode 100644 index 00000000..4b0e40e5 --- /dev/null +++ b/api-model-v1-52/docs/PluginConfigNetwork.md @@ -0,0 +1,10 @@ + +# PluginConfigNetwork + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | | + + + diff --git a/api-model-v1-52/docs/PluginConfigRootfs.md b/api-model-v1-52/docs/PluginConfigRootfs.md new file mode 100644 index 00000000..4f17530b --- /dev/null +++ b/api-model-v1-52/docs/PluginConfigRootfs.md @@ -0,0 +1,11 @@ + +# PluginConfigRootfs + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **type** | **kotlin.String** | | [optional] | +| **diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/PluginConfigUser.md b/api-model-v1-52/docs/PluginConfigUser.md new file mode 100644 index 00000000..1d3973c2 --- /dev/null +++ b/api-model-v1-52/docs/PluginConfigUser.md @@ -0,0 +1,11 @@ + +# PluginConfigUser + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **UID** | **kotlin.Int** | | [optional] | +| **GID** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/PluginDevice.md b/api-model-v1-52/docs/PluginDevice.md new file mode 100644 index 00000000..9ca354a5 --- /dev/null +++ b/api-model-v1-52/docs/PluginDevice.md @@ -0,0 +1,13 @@ + +# PluginDevice + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **path** | **kotlin.String** | | | + + + diff --git a/api-model-v1-52/docs/PluginEnv.md b/api-model-v1-52/docs/PluginEnv.md new file mode 100644 index 00000000..ff31d08b --- /dev/null +++ b/api-model-v1-52/docs/PluginEnv.md @@ -0,0 +1,13 @@ + +# PluginEnv + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **`value`** | **kotlin.String** | | | + + + diff --git a/api-model-v1-52/docs/PluginMount.md b/api-model-v1-52/docs/PluginMount.md new file mode 100644 index 00000000..77eaf741 --- /dev/null +++ b/api-model-v1-52/docs/PluginMount.md @@ -0,0 +1,16 @@ + +# PluginMount + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | +| **description** | **kotlin.String** | | | +| **settable** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **source** | **kotlin.String** | | | +| **destination** | **kotlin.String** | | | +| **type** | **kotlin.String** | | | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | | | + + + diff --git a/api-model-v1-52/docs/PluginPrivilege.md b/api-model-v1-52/docs/PluginPrivilege.md new file mode 100644 index 00000000..5c384bb6 --- /dev/null +++ b/api-model-v1-52/docs/PluginPrivilege.md @@ -0,0 +1,12 @@ + +# PluginPrivilege + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **description** | **kotlin.String** | | [optional] | +| **`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/PluginSettings.md b/api-model-v1-52/docs/PluginSettings.md new file mode 100644 index 00000000..1797e9c5 --- /dev/null +++ b/api-model-v1-52/docs/PluginSettings.md @@ -0,0 +1,13 @@ + +# PluginSettings + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mounts** | [**kotlin.collections.MutableList<PluginMount>**](PluginMount.md) | | | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | | | +| **devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | | + + + diff --git a/api-model-v1-52/docs/PluginsInfo.md b/api-model-v1-52/docs/PluginsInfo.md new file mode 100644 index 00000000..6f726d26 --- /dev/null +++ b/api-model-v1-52/docs/PluginsInfo.md @@ -0,0 +1,13 @@ + +# PluginsInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volume** | **kotlin.collections.MutableList<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] | +| **network** | **kotlin.collections.MutableList<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] | +| **authorization** | **kotlin.collections.MutableList<kotlin.String>** | Names of available authorization plugins. | [optional] | +| **log** | **kotlin.collections.MutableList<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] | + + + diff --git a/api-model-v1-52/docs/PortBinding.md b/api-model-v1-52/docs/PortBinding.md new file mode 100644 index 00000000..0cf0dea5 --- /dev/null +++ b/api-model-v1-52/docs/PortBinding.md @@ -0,0 +1,11 @@ + +# PortBinding + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **hostIp** | **kotlin.String** | Host IP address that the container's port is mapped to. | [optional] | +| **hostPort** | **kotlin.String** | Host port number that the container's port is mapped to. | [optional] | + + + diff --git a/api-model-v1-52/docs/PortStatus.md b/api-model-v1-52/docs/PortStatus.md new file mode 100644 index 00000000..24def5e3 --- /dev/null +++ b/api-model-v1-52/docs/PortStatus.md @@ -0,0 +1,10 @@ + +# PortStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/PortSummary.md b/api-model-v1-52/docs/PortSummary.md new file mode 100644 index 00000000..76affa49 --- /dev/null +++ b/api-model-v1-52/docs/PortSummary.md @@ -0,0 +1,20 @@ + +# PortSummary + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privatePort** | **kotlin.Int** | Port on the container | | +| **type** | [**inline**](#Type) | | | +| **IP** | **kotlin.String** | Host IP address that the container's port is mapped to | [optional] | +| **publicPort** | **kotlin.Int** | Port exposed on the host | [optional] | + + + +## Enum: Type +| Name | Value | +| ---- | ----- | +| type | tcp, udp, sctp | + + + diff --git a/api-model-v1-52/docs/ProcessConfig.md b/api-model-v1-52/docs/ProcessConfig.md new file mode 100644 index 00000000..921ea328 --- /dev/null +++ b/api-model-v1-52/docs/ProcessConfig.md @@ -0,0 +1,14 @@ + +# ProcessConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **privileged** | **kotlin.Boolean** | | [optional] | +| **user** | **kotlin.String** | | [optional] | +| **tty** | **kotlin.Boolean** | | [optional] | +| **entrypoint** | **kotlin.String** | | [optional] | +| **arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ProgressDetail.md b/api-model-v1-52/docs/ProgressDetail.md new file mode 100644 index 00000000..17d327a3 --- /dev/null +++ b/api-model-v1-52/docs/ProgressDetail.md @@ -0,0 +1,11 @@ + +# ProgressDetail + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **current** | **kotlin.Int** | | [optional] | +| **total** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/PushImageInfo.md b/api-model-v1-52/docs/PushImageInfo.md new file mode 100644 index 00000000..5483c263 --- /dev/null +++ b/api-model-v1-52/docs/PushImageInfo.md @@ -0,0 +1,12 @@ + +# PushImageInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **errorDetail** | [**ErrorDetail**](ErrorDetail.md) | | [optional] | +| **status** | **kotlin.String** | | [optional] | +| **progressDetail** | [**ProgressDetail**](ProgressDetail.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/Reachability.md b/api-model-v1-52/docs/Reachability.md new file mode 100644 index 00000000..a33ce341 --- /dev/null +++ b/api-model-v1-52/docs/Reachability.md @@ -0,0 +1,14 @@ + +# Reachability + +## Enum + + + * `Unknown` (value: `"unknown"`) + + * `Unreachable` (value: `"unreachable"`) + + * `Reachable` (value: `"reachable"`) + + + diff --git a/api-model-v1-52/docs/RegistryServiceConfig.md b/api-model-v1-52/docs/RegistryServiceConfig.md new file mode 100644 index 00000000..9f10019f --- /dev/null +++ b/api-model-v1-52/docs/RegistryServiceConfig.md @@ -0,0 +1,12 @@ + +# RegistryServiceConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **insecureRegistryCIDRs** | **kotlin.collections.MutableList<kotlin.String>** | List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`::1/128` and `127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. | [optional] | +| **indexConfigs** | [**kotlin.collections.MutableMap<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] | +| **mirrors** | **kotlin.collections.MutableList<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] | + + + diff --git a/api-model-v1-52/docs/ResourceObject.md b/api-model-v1-52/docs/ResourceObject.md new file mode 100644 index 00000000..b4652bf8 --- /dev/null +++ b/api-model-v1-52/docs/ResourceObject.md @@ -0,0 +1,12 @@ + +# ResourceObject + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nanoCPUs** | **kotlin.Long** | | [optional] | +| **memoryBytes** | **kotlin.Long** | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | + + + diff --git a/api-model-v1-52/docs/Resources.md b/api-model-v1-52/docs/Resources.md new file mode 100644 index 00000000..7cad7b7d --- /dev/null +++ b/api-model-v1-52/docs/Resources.md @@ -0,0 +1,39 @@ + +# Resources + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **cpuShares** | **kotlin.Int** | An integer value representing this container's relative CPU weight versus other containers. | [optional] | +| **memory** | **kotlin.Long** | Memory limit in bytes. | [optional] | +| **cgroupParent** | **kotlin.String** | Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. | [optional] | +| **blkioWeight** | **kotlin.Int** | Block IO weight (relative weight). | [optional] | +| **blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDeviceInner>**](ResourcesBlkioWeightDeviceInner.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] | +| **blkioDeviceReadBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteBps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceReadIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **blkioDeviceWriteIOps** | [**kotlin.collections.MutableList<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] | +| **cpuPeriod** | **kotlin.Long** | The length of a CPU period in microseconds. | [optional] | +| **cpuQuota** | **kotlin.Long** | Microseconds of CPU time that the container can get in a CPU period. | [optional] | +| **cpuRealtimePeriod** | **kotlin.Long** | The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpuRealtimeRuntime** | **kotlin.Long** | The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | [optional] | +| **cpusetCpus** | **kotlin.String** | CPUs in which to allow execution (e.g., `0-3`, `0,1`). | [optional] | +| **cpusetMems** | **kotlin.String** | Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | [optional] | +| **devices** | [**kotlin.collections.MutableList<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] | +| **deviceCgroupRules** | **kotlin.collections.MutableList<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] | +| **deviceRequests** | [**kotlin.collections.MutableList<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [optional] | +| **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] | +| **memorySwap** | **kotlin.Long** | Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | [optional] | +| **nanoCpus** | **kotlin.Long** | CPU quota in units of 10<sup>-9</sup> CPUs. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Disable OOM Killer for the container. | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **pidsLimit** | **kotlin.Long** | Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] | +| **cpuCount** | **kotlin.Long** | The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **cpuPercent** | **kotlin.Long** | The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. | [optional] | +| **ioMaximumIOps** | **kotlin.Long** | Maximum IOps for the container system drive (Windows only) | [optional] | +| **ioMaximumBandwidth** | **kotlin.Long** | Maximum IO in bytes per second for the container system drive (Windows only). | [optional] | + + + diff --git a/api-model-v1-52/docs/ResourcesBlkioWeightDeviceInner.md b/api-model-v1-52/docs/ResourcesBlkioWeightDeviceInner.md new file mode 100644 index 00000000..8adad1d4 --- /dev/null +++ b/api-model-v1-52/docs/ResourcesBlkioWeightDeviceInner.md @@ -0,0 +1,11 @@ + +# ResourcesBlkioWeightDeviceInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | | [optional] | +| **weight** | **kotlin.Int** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ResourcesUlimitsInner.md b/api-model-v1-52/docs/ResourcesUlimitsInner.md new file mode 100644 index 00000000..8ad484f1 --- /dev/null +++ b/api-model-v1-52/docs/ResourcesUlimitsInner.md @@ -0,0 +1,12 @@ + +# ResourcesUlimitsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of ulimit | [optional] | +| **soft** | **kotlin.Int** | Soft limit | [optional] | +| **hard** | **kotlin.Int** | Hard limit | [optional] | + + + diff --git a/api-model-v1-52/docs/RestartPolicy.md b/api-model-v1-52/docs/RestartPolicy.md new file mode 100644 index 00000000..09a0e982 --- /dev/null +++ b/api-model-v1-52/docs/RestartPolicy.md @@ -0,0 +1,18 @@ + +# RestartPolicy + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | [**inline**](#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 | [optional] | +| **maximumRetryCount** | **kotlin.Int** | If `on-failure` is used, the number of times to retry before giving up. | [optional] | + + + +## Enum: Name +| Name | Value | +| ---- | ----- | +| name | , no, always, unless-stopped, on-failure | + + + diff --git a/api-model-v1-52/docs/RootFSStorage.md b/api-model-v1-52/docs/RootFSStorage.md new file mode 100644 index 00000000..7ef3726c --- /dev/null +++ b/api-model-v1-52/docs/RootFSStorage.md @@ -0,0 +1,10 @@ + +# RootFSStorage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **snapshot** | [**RootFSStorageSnapshot**](RootFSStorageSnapshot.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/RootFSStorageSnapshot.md b/api-model-v1-52/docs/RootFSStorageSnapshot.md new file mode 100644 index 00000000..89da326c --- /dev/null +++ b/api-model-v1-52/docs/RootFSStorageSnapshot.md @@ -0,0 +1,10 @@ + +# RootFSStorageSnapshot + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the snapshotter. | [optional] | + + + diff --git a/api-model-v1-52/docs/Runtime.md b/api-model-v1-52/docs/Runtime.md new file mode 100644 index 00000000..e244ad7c --- /dev/null +++ b/api-model-v1-52/docs/Runtime.md @@ -0,0 +1,12 @@ + +# Runtime + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] | +| **status** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | + + + diff --git a/api-model-v1-52/docs/Secret.md b/api-model-v1-52/docs/Secret.md new file mode 100644 index 00000000..9a87a568 --- /dev/null +++ b/api-model-v1-52/docs/Secret.md @@ -0,0 +1,14 @@ + +# Secret + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**SecretSpec**](SecretSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SecretCreateRequest.md b/api-model-v1-52/docs/SecretCreateRequest.md new file mode 100644 index 00000000..ee3cbab0 --- /dev/null +++ b/api-model-v1-52/docs/SecretCreateRequest.md @@ -0,0 +1,14 @@ + +# SecretCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SecretSpec.md b/api-model-v1-52/docs/SecretSpec.md new file mode 100644 index 00000000..bd4a7229 --- /dev/null +++ b/api-model-v1-52/docs/SecretSpec.md @@ -0,0 +1,14 @@ + +# SecretSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | User-defined name of the secret. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **`data`** | **kotlin.String** | Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] | +| **driver** | [**Driver**](Driver.md) | | [optional] | +| **templating** | [**Driver**](Driver.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/Service.md b/api-model-v1-52/docs/Service.md new file mode 100644 index 00000000..d2e0c3c9 --- /dev/null +++ b/api-model-v1-52/docs/Service.md @@ -0,0 +1,18 @@ + +# Service + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **spec** | [**ServiceSpec**](ServiceSpec.md) | | [optional] | +| **endpoint** | [**ServiceEndpoint**](ServiceEndpoint.md) | | [optional] | +| **updateStatus** | [**ServiceUpdateStatus**](ServiceUpdateStatus.md) | | [optional] | +| **serviceStatus** | [**ServiceServiceStatus**](ServiceServiceStatus.md) | | [optional] | +| **jobStatus** | [**ServiceJobStatus**](ServiceJobStatus.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceCreateRequest.md b/api-model-v1-52/docs/ServiceCreateRequest.md new file mode 100644 index 00000000..e13b9730 --- /dev/null +++ b/api-model-v1-52/docs/ServiceCreateRequest.md @@ -0,0 +1,17 @@ + +# ServiceCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceCreateResponse.md b/api-model-v1-52/docs/ServiceCreateResponse.md new file mode 100644 index 00000000..bccceaa6 --- /dev/null +++ b/api-model-v1-52/docs/ServiceCreateResponse.md @@ -0,0 +1,11 @@ + +# ServiceCreateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the created service. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceEndpoint.md b/api-model-v1-52/docs/ServiceEndpoint.md new file mode 100644 index 00000000..e0f1c900 --- /dev/null +++ b/api-model-v1-52/docs/ServiceEndpoint.md @@ -0,0 +1,12 @@ + +# ServiceEndpoint + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | +| **ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] | +| **virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPsInner>**](ServiceEndpointVirtualIPsInner.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceEndpointVirtualIPsInner.md b/api-model-v1-52/docs/ServiceEndpointVirtualIPsInner.md new file mode 100644 index 00000000..f893c9c6 --- /dev/null +++ b/api-model-v1-52/docs/ServiceEndpointVirtualIPsInner.md @@ -0,0 +1,11 @@ + +# ServiceEndpointVirtualIPsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **networkID** | **kotlin.String** | | [optional] | +| **addr** | **kotlin.String** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceInfo.md b/api-model-v1-52/docs/ServiceInfo.md new file mode 100644 index 00000000..fed33ecd --- /dev/null +++ b/api-model-v1-52/docs/ServiceInfo.md @@ -0,0 +1,13 @@ + +# ServiceInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **VIP** | **kotlin.String** | | [optional] | +| **ports** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] | +| **localLBIndex** | **kotlin.Int** | | [optional] | +| **tasks** | [**kotlin.collections.MutableList<NetworkTaskInfo>**](NetworkTaskInfo.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceJobStatus.md b/api-model-v1-52/docs/ServiceJobStatus.md new file mode 100644 index 00000000..8227bff6 --- /dev/null +++ b/api-model-v1-52/docs/ServiceJobStatus.md @@ -0,0 +1,11 @@ + +# ServiceJobStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **lastExecution** | **kotlin.String** | The last time, as observed by the server, that this job was started. | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceServiceStatus.md b/api-model-v1-52/docs/ServiceServiceStatus.md new file mode 100644 index 00000000..79fd1de2 --- /dev/null +++ b/api-model-v1-52/docs/ServiceServiceStatus.md @@ -0,0 +1,12 @@ + +# ServiceServiceStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **runningTasks** | **kotlin.Int** | The number of tasks for the service currently in the Running state. | [optional] | +| **desiredTasks** | **kotlin.Int** | The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. | [optional] | +| **completedTasks** | **kotlin.Int** | The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceSpec.md b/api-model-v1-52/docs/ServiceSpec.md new file mode 100644 index 00000000..2c5c547c --- /dev/null +++ b/api-model-v1-52/docs/ServiceSpec.md @@ -0,0 +1,17 @@ + +# ServiceSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceSpecMode.md b/api-model-v1-52/docs/ServiceSpecMode.md new file mode 100644 index 00000000..7b9ddebd --- /dev/null +++ b/api-model-v1-52/docs/ServiceSpecMode.md @@ -0,0 +1,13 @@ + +# ServiceSpecMode + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicated** | [**ServiceSpecModeReplicated**](ServiceSpecModeReplicated.md) | | [optional] | +| **global** | [**kotlin.Any**](.md) | | [optional] | +| **replicatedJob** | [**ServiceSpecModeReplicatedJob**](ServiceSpecModeReplicatedJob.md) | | [optional] | +| **globalJob** | [**kotlin.Any**](.md) | The mode used for services which run a task to the completed state on each valid node. | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceSpecModeReplicated.md b/api-model-v1-52/docs/ServiceSpecModeReplicated.md new file mode 100644 index 00000000..9e2617c0 --- /dev/null +++ b/api-model-v1-52/docs/ServiceSpecModeReplicated.md @@ -0,0 +1,10 @@ + +# ServiceSpecModeReplicated + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **replicas** | **kotlin.Long** | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceSpecModeReplicatedJob.md b/api-model-v1-52/docs/ServiceSpecModeReplicatedJob.md new file mode 100644 index 00000000..215cf92f --- /dev/null +++ b/api-model-v1-52/docs/ServiceSpecModeReplicatedJob.md @@ -0,0 +1,11 @@ + +# ServiceSpecModeReplicatedJob + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **maxConcurrent** | **kotlin.Long** | The maximum number of replicas to run simultaneously. | [optional] | +| **totalCompletions** | **kotlin.Long** | The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceSpecRollbackConfig.md b/api-model-v1-52/docs/ServiceSpecRollbackConfig.md new file mode 100644 index 00000000..109ce61a --- /dev/null +++ b/api-model-v1-52/docs/ServiceSpecRollbackConfig.md @@ -0,0 +1,29 @@ + +# ServiceSpecRollbackConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between rollback iterations, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each rolled back task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | + + + +## Enum: FailureAction +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause | + + + +## Enum: Order +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | + + + diff --git a/api-model-v1-52/docs/ServiceSpecUpdateConfig.md b/api-model-v1-52/docs/ServiceSpecUpdateConfig.md new file mode 100644 index 00000000..b8a267a7 --- /dev/null +++ b/api-model-v1-52/docs/ServiceSpecUpdateConfig.md @@ -0,0 +1,29 @@ + +# ServiceSpecUpdateConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **parallelism** | **kotlin.Long** | Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). | [optional] | +| **delay** | **kotlin.Long** | Amount of time between updates, in nanoseconds. | [optional] | +| **failureAction** | [**inline**](#FailureAction) | Action to take if an updated task fails to run, or stops running during the update. | [optional] | +| **monitor** | **kotlin.Long** | Amount of time to monitor each updated task for failures, in nanoseconds. | [optional] | +| **maxFailureRatio** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. | [optional] | +| **order** | [**inline**](#Order) | The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. | [optional] | + + + +## Enum: FailureAction +| Name | Value | +| ---- | ----- | +| failureAction | continue, pause, rollback | + + + +## Enum: Order +| Name | Value | +| ---- | ----- | +| order | stop-first, start-first | + + + diff --git a/api-model-v1-52/docs/ServiceUpdateRequest.md b/api-model-v1-52/docs/ServiceUpdateRequest.md new file mode 100644 index 00000000..17c4c804 --- /dev/null +++ b/api-model-v1-52/docs/ServiceUpdateRequest.md @@ -0,0 +1,17 @@ + +# ServiceUpdateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the service. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **taskTemplate** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **mode** | [**ServiceSpecMode**](ServiceSpecMode.md) | | [optional] | +| **updateConfig** | [**ServiceSpecUpdateConfig**](ServiceSpecUpdateConfig.md) | | [optional] | +| **rollbackConfig** | [**ServiceSpecRollbackConfig**](ServiceSpecRollbackConfig.md) | | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. | [optional] | +| **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceUpdateResponse.md b/api-model-v1-52/docs/ServiceUpdateResponse.md new file mode 100644 index 00000000..d131f923 --- /dev/null +++ b/api-model-v1-52/docs/ServiceUpdateResponse.md @@ -0,0 +1,10 @@ + +# ServiceUpdateResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] | + + + diff --git a/api-model-v1-52/docs/ServiceUpdateStatus.md b/api-model-v1-52/docs/ServiceUpdateStatus.md new file mode 100644 index 00000000..be528d9c --- /dev/null +++ b/api-model-v1-52/docs/ServiceUpdateStatus.md @@ -0,0 +1,20 @@ + +# ServiceUpdateStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **state** | [**inline**](#State) | | [optional] | +| **startedAt** | **kotlin.String** | | [optional] | +| **completedAt** | **kotlin.String** | | [optional] | +| **message** | **kotlin.String** | | [optional] | + + + +## Enum: State +| Name | Value | +| ---- | ----- | +| state | updating, paused, completed | + + + diff --git a/api-model-v1-52/docs/Storage.md b/api-model-v1-52/docs/Storage.md new file mode 100644 index 00000000..b0f14f4c --- /dev/null +++ b/api-model-v1-52/docs/Storage.md @@ -0,0 +1,10 @@ + +# Storage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **rootFS** | [**RootFSStorage**](RootFSStorage.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SubnetStatus.md b/api-model-v1-52/docs/SubnetStatus.md new file mode 100644 index 00000000..74736ccb --- /dev/null +++ b/api-model-v1-52/docs/SubnetStatus.md @@ -0,0 +1,11 @@ + +# SubnetStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ipsInUse** | **kotlin.Int** | Number of IP addresses in the subnet that are in use or reserved and are therefore unavailable for allocation, saturating at 2<sup>64</sup> - 1. | [optional] | +| **dynamicIPsAvailable** | **kotlin.Int** | Number of IP addresses within the network's IPRange for the subnet that are available for allocation, saturating at 2<sup>64</sup> - 1. | [optional] | + + + diff --git a/api-model-v1-52/docs/Swarm.md b/api-model-v1-52/docs/Swarm.md new file mode 100644 index 00000000..6c752000 --- /dev/null +++ b/api-model-v1-52/docs/Swarm.md @@ -0,0 +1,20 @@ + +# Swarm + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the swarm. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **updatedAt** | **kotlin.String** | Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **spec** | [**SwarmSpec**](SwarmSpec.md) | | [optional] | +| **tlSInfo** | [**TLSInfo**](TLSInfo.md) | | [optional] | +| **rootRotationInProgress** | **kotlin.Boolean** | Whether there is currently a root CA rotation in progress for the swarm | [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, the default port (4789) is used. | [optional] | +| **defaultAddrPool** | **kotlin.collections.MutableList<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] | +| **subnetSize** | **kotlin.Int** | SubnetSize specifies the subnet size of the networks created from the default subnet pool. | [optional] | +| **joinTokens** | [**JoinTokens**](JoinTokens.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmInfo.md b/api-model-v1-52/docs/SwarmInfo.md new file mode 100644 index 00000000..cb655c0b --- /dev/null +++ b/api-model-v1-52/docs/SwarmInfo.md @@ -0,0 +1,18 @@ + +# SwarmInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeID** | **kotlin.String** | Unique identifier of for this node in the swarm. | [optional] | +| **nodeAddr** | **kotlin.String** | IP address at which this node can be reached by other nodes in the swarm. | [optional] | +| **localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] | +| **controlAvailable** | **kotlin.Boolean** | | [optional] | +| **error** | **kotlin.String** | | [optional] | +| **remoteManagers** | [**kotlin.collections.MutableList<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [optional] | +| **nodes** | **kotlin.Int** | Total number of nodes in the swarm. | [optional] | +| **managers** | **kotlin.Int** | Total number of managers in the swarm. | [optional] | +| **cluster** | [**ClusterInfo**](ClusterInfo.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmInitRequest.md b/api-model-v1-52/docs/SwarmInitRequest.md new file mode 100644 index 00000000..f4503ae3 --- /dev/null +++ b/api-model-v1-52/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.MutableList<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-v1-52/docs/SwarmJoinRequest.md b/api-model-v1-52/docs/SwarmJoinRequest.md new file mode 100644 index 00000000..854e0fc2 --- /dev/null +++ b/api-model-v1-52/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.MutableList<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-v1-52/docs/SwarmSpec.md b/api-model-v1-52/docs/SwarmSpec.md new file mode 100644 index 00000000..55042008 --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpec.md @@ -0,0 +1,17 @@ + +# SwarmSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the swarm. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **orchestration** | [**SwarmSpecOrchestration**](SwarmSpecOrchestration.md) | | [optional] | +| **raft** | [**SwarmSpecRaft**](SwarmSpecRaft.md) | | [optional] | +| **dispatcher** | [**SwarmSpecDispatcher**](SwarmSpecDispatcher.md) | | [optional] | +| **caConfig** | [**SwarmSpecCAConfig**](SwarmSpecCAConfig.md) | | [optional] | +| **encryptionConfig** | [**SwarmSpecEncryptionConfig**](SwarmSpecEncryptionConfig.md) | | [optional] | +| **taskDefaults** | [**SwarmSpecTaskDefaults**](SwarmSpecTaskDefaults.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecCAConfig.md b/api-model-v1-52/docs/SwarmSpecCAConfig.md new file mode 100644 index 00000000..72a0dca2 --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecCAConfig.md @@ -0,0 +1,14 @@ + +# SwarmSpecCAConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] | +| **externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAsInner>**](SwarmSpecCAConfigExternalCAsInner.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] | +| **signingCACert** | **kotlin.String** | The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **signingCAKey** | **kotlin.String** | The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. | [optional] | +| **forceRotate** | **kotlin.Int** | An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecCAConfigExternalCAsInner.md b/api-model-v1-52/docs/SwarmSpecCAConfigExternalCAsInner.md new file mode 100644 index 00000000..d4e29b6c --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecCAConfigExternalCAsInner.md @@ -0,0 +1,20 @@ + +# SwarmSpecCAConfigExternalCAsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **protocol** | [**inline**](#Protocol) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] | +| **URL** | **kotlin.String** | URL where certificate signing requests should be sent. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [optional] | +| **caCert** | **kotlin.String** | The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). | [optional] | + + + +## Enum: Protocol +| Name | Value | +| ---- | ----- | +| protocol | cfssl | + + + diff --git a/api-model-v1-52/docs/SwarmSpecDispatcher.md b/api-model-v1-52/docs/SwarmSpecDispatcher.md new file mode 100644 index 00000000..281781e0 --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecDispatcher.md @@ -0,0 +1,10 @@ + +# SwarmSpecDispatcher + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **heartbeatPeriod** | **kotlin.Long** | The delay for an agent to send a heartbeat to the dispatcher. | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecEncryptionConfig.md b/api-model-v1-52/docs/SwarmSpecEncryptionConfig.md new file mode 100644 index 00000000..f26480bf --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecEncryptionConfig.md @@ -0,0 +1,10 @@ + +# SwarmSpecEncryptionConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **autoLockManagers** | **kotlin.Boolean** | If set, generate a key and use it to lock data stored on the managers. | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecOrchestration.md b/api-model-v1-52/docs/SwarmSpecOrchestration.md new file mode 100644 index 00000000..1152816f --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecOrchestration.md @@ -0,0 +1,10 @@ + +# SwarmSpecOrchestration + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **taskHistoryRetentionLimit** | **kotlin.Long** | The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecRaft.md b/api-model-v1-52/docs/SwarmSpecRaft.md new file mode 100644 index 00000000..c31ecfa2 --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecRaft.md @@ -0,0 +1,14 @@ + +# SwarmSpecRaft + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **snapshotInterval** | **kotlin.Int** | The number of log entries between snapshots. | [optional] | +| **keepOldSnapshots** | **kotlin.Int** | The number of snapshots to keep beyond the current snapshot. | [optional] | +| **logEntriesForSlowFollowers** | **kotlin.Int** | The number of log entries to keep around to sync up slow followers after a snapshot is created. | [optional] | +| **electionTick** | **kotlin.Int** | The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | +| **heartbeatTick** | **kotlin.Int** | The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecTaskDefaults.md b/api-model-v1-52/docs/SwarmSpecTaskDefaults.md new file mode 100644 index 00000000..acb39d26 --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecTaskDefaults.md @@ -0,0 +1,10 @@ + +# SwarmSpecTaskDefaults + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **logDriver** | [**SwarmSpecTaskDefaultsLogDriver**](SwarmSpecTaskDefaultsLogDriver.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmSpecTaskDefaultsLogDriver.md b/api-model-v1-52/docs/SwarmSpecTaskDefaultsLogDriver.md new file mode 100644 index 00000000..e1b7526f --- /dev/null +++ b/api-model-v1-52/docs/SwarmSpecTaskDefaultsLogDriver.md @@ -0,0 +1,11 @@ + +# SwarmSpecTaskDefaultsLogDriver + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selected log driver, specified as key/value pairs. | [optional] | + + + diff --git a/api-model-v1-52/docs/SwarmUnlockRequest.md b/api-model-v1-52/docs/SwarmUnlockRequest.md new file mode 100644 index 00000000..0f2b14e8 --- /dev/null +++ b/api-model-v1-52/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-v1-52/docs/SystemDataUsageResponse.md b/api-model-v1-52/docs/SystemDataUsageResponse.md new file mode 100644 index 00000000..a912d973 --- /dev/null +++ b/api-model-v1-52/docs/SystemDataUsageResponse.md @@ -0,0 +1,13 @@ + +# SystemDataUsageResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **imagesDiskUsage** | [**ImagesDiskUsage**](ImagesDiskUsage.md) | | [optional] | +| **containersDiskUsage** | [**ContainersDiskUsage**](ContainersDiskUsage.md) | | [optional] | +| **volumesDiskUsage** | [**VolumesDiskUsage**](VolumesDiskUsage.md) | | [optional] | +| **buildCacheDiskUsage** | [**BuildCacheDiskUsage**](BuildCacheDiskUsage.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/SystemInfo.md b/api-model-v1-52/docs/SystemInfo.md new file mode 100644 index 00000000..41b01ad7 --- /dev/null +++ b/api-model-v1-52/docs/SystemInfo.md @@ -0,0 +1,91 @@ + +# SystemInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | Unique identifier of the daemon. <p><br /></p> > **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. | [optional] | +| **containers** | **kotlin.Int** | Total number of containers on the host. | [optional] | +| **containersRunning** | **kotlin.Int** | Number of containers with status `\"running\"`. | [optional] | +| **containersPaused** | **kotlin.Int** | Number of containers with status `\"paused\"`. | [optional] | +| **containersStopped** | **kotlin.Int** | Number of containers with status `\"stopped\"`. | [optional] | +| **images** | **kotlin.Int** | Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. | [optional] | +| **driver** | **kotlin.String** | Name of the storage driver in use. | [optional] | +| **driverStatus** | **kotlin.collections.MutableList<kotlin.collections.MutableList<kotlin.String>>** | Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line. <p><br /></p> > **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. | [optional] | +| **dockerRootDir** | **kotlin.String** | Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. | [optional] | +| **plugins** | [**PluginsInfo**](PluginsInfo.md) | | [optional] | +| **memoryLimit** | **kotlin.Boolean** | Indicates if the host has memory limit support enabled. | [optional] | +| **swapLimit** | **kotlin.Boolean** | Indicates if the host has memory swap limit support enabled. | [optional] | +| **cpuCfsPeriod** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | [optional] | +| **cpuCfsQuota** | **kotlin.Boolean** | Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | [optional] | +| **cpUShares** | **kotlin.Boolean** | Indicates if CPU Shares limiting is supported by the host. | [optional] | +| **cpUSet** | **kotlin.Boolean** | Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) | [optional] | +| **pidsLimit** | **kotlin.Boolean** | Indicates if the host kernel has PID limit support enabled. | [optional] | +| **oomKillDisable** | **kotlin.Boolean** | Indicates if OOM killer disable is supported on the host. | [optional] | +| **ipv4Forwarding** | **kotlin.Boolean** | Indicates IPv4 forwarding is enabled. | [optional] | +| **debug** | **kotlin.Boolean** | Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | [optional] | +| **nfd** | **kotlin.Int** | The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | [optional] | +| **ngoroutines** | **kotlin.Int** | The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | [optional] | +| **systemTime** | **kotlin.String** | Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. | [optional] | +| **loggingDriver** | **kotlin.String** | The logging driver to use as a default for new containers. | [optional] | +| **cgroupDriver** | [**inline**](#CgroupDriver) | The driver to use for managing cgroups. | [optional] | +| **cgroupVersion** | [**inline**](#CgroupVersion) | The version of the cgroup. | [optional] | +| **neventsListener** | **kotlin.Int** | Number of event listeners subscribed. | [optional] | +| **kernelVersion** | **kotlin.String** | Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd> registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. | [optional] | +| **operatingSystem** | **kotlin.String** | Name of the host's operating system, for example: \"Ubuntu 24.04 LTS\" or \"Windows Server 2016 Datacenter\" | [optional] | +| **osVersion** | **kotlin.String** | Version of the host's operating system <p><br /></p> > **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. | [optional] | +| **osType** | **kotlin.String** | Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **architecture** | **kotlin.String** | Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). | [optional] | +| **NCPU** | **kotlin.Int** | The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | [optional] | +| **memTotal** | **kotlin.Long** | Total amount of physical memory available on the host, in bytes. | [optional] | +| **indexServerAddress** | **kotlin.String** | Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | [optional] | +| **registryConfig** | [**RegistryServiceConfig**](RegistryServiceConfig.md) | | [optional] | +| **genericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **httpProxy** | **kotlin.String** | HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **httpsProxy** | **kotlin.String** | HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. | [optional] | +| **noProxy** | **kotlin.String** | Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. | [optional] | +| **name** | **kotlin.String** | Hostname of the host. | [optional] | +| **labels** | **kotlin.collections.MutableList<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. | [optional] | +| **runtimes** | [**kotlin.collections.MutableMap<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] | +| **defaultRuntime** | **kotlin.String** | Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | [optional] | +| **swarm** | [**SwarmInfo**](SwarmInfo.md) | | [optional] | +| **liveRestoreEnabled** | **kotlin.Boolean** | Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | [optional] | +| **isolation** | [**inline**](#Isolation) | Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. | [optional] | +| **initBinary** | **kotlin.String** | Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. | [optional] | +| **containerdCommit** | [**Commit**](Commit.md) | | [optional] | +| **runcCommit** | [**Commit**](Commit.md) | | [optional] | +| **initCommit** | [**Commit**](Commit.md) | | [optional] | +| **securityOptions** | **kotlin.collections.MutableList<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [optional] | +| **productLicense** | **kotlin.String** | Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | [optional] | +| **defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPoolsInner>**](SystemInfoDefaultAddressPoolsInner.md) | List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | [optional] | +| **firewallBackend** | [**FirewallInfo**](FirewallInfo.md) | | [optional] | +| **discoveredDevices** | [**kotlin.collections.MutableList<DeviceInfo>**](DeviceInfo.md) | List of devices discovered by device drivers. Each device includes information about its source driver, kind, name, and additional driver-specific attributes. | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | [optional] | +| **cdISpecDirs** | **kotlin.collections.MutableList<kotlin.String>** | List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. | [optional] | +| **containerd** | [**ContainerdInfo**](ContainerdInfo.md) | | [optional] | + + + +## Enum: CgroupDriver +| Name | Value | +| ---- | ----- | +| cgroupDriver | cgroupfs, systemd, none | + + + +## Enum: CgroupVersion +| Name | Value | +| ---- | ----- | +| cgroupVersion | 1, 2 | + + + +## Enum: Isolation +| Name | Value | +| ---- | ----- | +| isolation | default, hyperv, process, | + + + diff --git a/api-model-v1-52/docs/SystemInfoDefaultAddressPoolsInner.md b/api-model-v1-52/docs/SystemInfoDefaultAddressPoolsInner.md new file mode 100644 index 00000000..1db98475 --- /dev/null +++ b/api-model-v1-52/docs/SystemInfoDefaultAddressPoolsInner.md @@ -0,0 +1,11 @@ + +# SystemInfoDefaultAddressPoolsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **base** | **kotlin.String** | The network address in CIDR format | [optional] | +| **propertySize** | **kotlin.Int** | The network pool size | [optional] | + + + diff --git a/api-model-v1-52/docs/SystemVersion.md b/api-model-v1-52/docs/SystemVersion.md new file mode 100644 index 00000000..cead3f34 --- /dev/null +++ b/api-model-v1-52/docs/SystemVersion.md @@ -0,0 +1,21 @@ + +# SystemVersion + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] | +| **components** | [**kotlin.collections.MutableList<SystemVersionComponentsInner>**](SystemVersionComponentsInner.md) | Information about system components | [optional] | +| **version** | **kotlin.String** | The version of the daemon | [optional] | +| **apiVersion** | **kotlin.String** | The default (and highest) API version that is supported by the daemon | [optional] | +| **minAPIVersion** | **kotlin.String** | The minimum API version that is supported by the daemon | [optional] | +| **gitCommit** | **kotlin.String** | The Git commit of the source code that was used to build the daemon | [optional] | +| **goVersion** | **kotlin.String** | The version Go used to compile the daemon, and the version of the Go runtime in use. | [optional] | +| **os** | **kotlin.String** | The operating system that the daemon is running on (\"linux\" or \"windows\") | [optional] | +| **arch** | **kotlin.String** | The architecture that the daemon is running on | [optional] | +| **kernelVersion** | **kotlin.String** | The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. | [optional] | +| **experimental** | **kotlin.Boolean** | Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. | [optional] | +| **buildTime** | **kotlin.String** | The date and time that the daemon was compiled. | [optional] | + + + diff --git a/api-model-v1-52/docs/SystemVersionComponentsInner.md b/api-model-v1-52/docs/SystemVersionComponentsInner.md new file mode 100644 index 00000000..804428ca --- /dev/null +++ b/api-model-v1-52/docs/SystemVersionComponentsInner.md @@ -0,0 +1,12 @@ + +# SystemVersionComponentsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the component | | +| **version** | **kotlin.String** | Version of the component | | +| **details** | [**kotlin.Any**](.md) | Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. | [optional] | + + + diff --git a/api-model-v1-52/docs/SystemVersionPlatform.md b/api-model-v1-52/docs/SystemVersionPlatform.md new file mode 100644 index 00000000..285b4a47 --- /dev/null +++ b/api-model-v1-52/docs/SystemVersionPlatform.md @@ -0,0 +1,10 @@ + +# SystemVersionPlatform + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | | + + + diff --git a/api-model-v1-52/docs/TLSInfo.md b/api-model-v1-52/docs/TLSInfo.md new file mode 100644 index 00000000..27168d2c --- /dev/null +++ b/api-model-v1-52/docs/TLSInfo.md @@ -0,0 +1,12 @@ + +# TLSInfo + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **trustRoot** | **kotlin.String** | The root CA certificate(s) that are used to validate leaf TLS certificates. | [optional] | +| **certIssuerSubject** | **kotlin.String** | The base64-url-safe-encoded raw subject bytes of the issuer. | [optional] | +| **certIssuerPublicKey** | **kotlin.String** | The base64-url-safe-encoded raw public key bytes of the issuer. | [optional] | + + + diff --git a/api-model-v1-52/docs/Task.md b/api-model-v1-52/docs/Task.md new file mode 100644 index 00000000..f68e5e2f --- /dev/null +++ b/api-model-v1-52/docs/Task.md @@ -0,0 +1,23 @@ + +# Task + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **ID** | **kotlin.String** | The ID of the task. | [optional] | +| **version** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | +| **createdAt** | **kotlin.String** | | [optional] | +| **updatedAt** | **kotlin.String** | | [optional] | +| **name** | **kotlin.String** | Name of the task. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **spec** | [**TaskSpec**](TaskSpec.md) | | [optional] | +| **serviceID** | **kotlin.String** | The ID of the service this task is part of. | [optional] | +| **slot** | **kotlin.Int** | | [optional] | +| **nodeID** | **kotlin.String** | The ID of the node that this task is on. | [optional] | +| **assignedGenericResources** | [**kotlin.collections.MutableList<GenericResourcesInner>**](GenericResourcesInner.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] | +| **status** | [**TaskStatus**](TaskStatus.md) | | [optional] | +| **desiredState** | [**TaskState**](TaskState.md) | | [optional] | +| **jobIteration** | [**ObjectVersion**](ObjectVersion.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpec.md b/api-model-v1-52/docs/TaskSpec.md new file mode 100644 index 00000000..bf55bec5 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpec.md @@ -0,0 +1,19 @@ + +# TaskSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **pluginSpec** | [**TaskSpecPluginSpec**](TaskSpecPluginSpec.md) | | [optional] | +| **containerSpec** | [**TaskSpecContainerSpec**](TaskSpecContainerSpec.md) | | [optional] | +| **networkAttachmentSpec** | [**TaskSpecNetworkAttachmentSpec**](TaskSpecNetworkAttachmentSpec.md) | | [optional] | +| **resources** | [**TaskSpecResources**](TaskSpecResources.md) | | [optional] | +| **restartPolicy** | [**TaskSpecRestartPolicy**](TaskSpecRestartPolicy.md) | | [optional] | +| **placement** | [**TaskSpecPlacement**](TaskSpecPlacement.md) | | [optional] | +| **forceUpdate** | **kotlin.Int** | A counter that triggers an update even if no relevant parameters have been changed. | [optional] | +| **runtime** | **kotlin.String** | Runtime is the type of runtime specified for the task executor. | [optional] | +| **networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] | +| **logDriver** | [**TaskSpecLogDriver**](TaskSpecLogDriver.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpec.md b/api-model-v1-52/docs/TaskSpecContainerSpec.md new file mode 100644 index 00000000..de1036eb --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpec.md @@ -0,0 +1,44 @@ + +# TaskSpecContainerSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **image** | **kotlin.String** | The image name to use for the container | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] | +| **command** | **kotlin.collections.MutableList<kotlin.String>** | The command to be run in the image. | [optional] | +| **args** | **kotlin.collections.MutableList<kotlin.String>** | Arguments to the command. | [optional] | +| **hostname** | **kotlin.String** | The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. | [optional] | +| **env** | **kotlin.collections.MutableList<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [optional] | +| **dir** | **kotlin.String** | The working directory for commands to run in. | [optional] | +| **user** | **kotlin.String** | The user inside the container. | [optional] | +| **groups** | **kotlin.collections.MutableList<kotlin.String>** | A list of additional groups that the container process will run as. | [optional] | +| **privileges** | [**TaskSpecContainerSpecPrivileges**](TaskSpecContainerSpecPrivileges.md) | | [optional] | +| **TTY** | **kotlin.Boolean** | Whether a pseudo-TTY should be allocated. | [optional] | +| **openStdin** | **kotlin.Boolean** | Open `stdin` | [optional] | +| **readOnly** | **kotlin.Boolean** | Mount the container's root filesystem as read only. | [optional] | +| **mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [optional] | +| **stopSignal** | **kotlin.String** | Signal to stop the container. | [optional] | +| **stopGracePeriod** | **kotlin.Long** | Amount of time to wait for the container to terminate before forcefully killing it. | [optional] | +| **healthCheck** | [**HealthConfig**](HealthConfig.md) | | [optional] | +| **hosts** | **kotlin.collections.MutableList<kotlin.String>** | A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] | [optional] | +| **dnSConfig** | [**TaskSpecContainerSpecDNSConfig**](TaskSpecContainerSpecDNSConfig.md) | | [optional] | +| **secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecretsInner>**](TaskSpecContainerSpecSecretsInner.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] | +| **oomScoreAdj** | **kotlin.Long** | An integer value containing the score given to the container in order to tune OOM killer preferences. | [optional] | +| **configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigsInner>**](TaskSpecContainerSpecConfigsInner.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] | +| **isolation** | [**inline**](#Isolation) | Isolation technology of the containers running the service. (Windows only) | [optional] | +| **`init`** | **kotlin.Boolean** | Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | [optional] | +| **sysctls** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. | [optional] | +| **capabilityAdd** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] | +| **capabilityDrop** | **kotlin.collections.MutableList<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] | +| **ulimits** | [**kotlin.collections.MutableList<ResourcesUlimitsInner>**](ResourcesUlimitsInner.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] | + + + +## Enum: Isolation +| Name | Value | +| ---- | ----- | +| isolation | default, process, hyperv, | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecConfigsInner.md b/api-model-v1-52/docs/TaskSpecContainerSpecConfigsInner.md new file mode 100644 index 00000000..b3fd4ce2 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecConfigsInner.md @@ -0,0 +1,13 @@ + +# TaskSpecContainerSpecConfigsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecConfigsInnerFile**](TaskSpecContainerSpecConfigsInnerFile.md) | | [optional] | +| **runtime** | [**kotlin.Any**](.md) | Runtime represents a target that is not mounted into the container but is used by the task <p><br /><p> > **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive | [optional] | +| **configID** | **kotlin.String** | ConfigID represents the ID of the specific config that we're referencing. | [optional] | +| **configName** | **kotlin.String** | ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecConfigsInnerFile.md b/api-model-v1-52/docs/TaskSpecContainerSpecConfigsInnerFile.md new file mode 100644 index 00000000..8d06a999 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecConfigsInnerFile.md @@ -0,0 +1,13 @@ + +# TaskSpecContainerSpecConfigsInnerFile + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecDNSConfig.md b/api-model-v1-52/docs/TaskSpecContainerSpecDNSConfig.md new file mode 100644 index 00000000..e2f2192a --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecDNSConfig.md @@ -0,0 +1,12 @@ + +# TaskSpecContainerSpecDNSConfig + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **nameservers** | **kotlin.collections.MutableList<kotlin.String>** | The IP addresses of the name servers. | [optional] | +| **search** | **kotlin.collections.MutableList<kotlin.String>** | A search list for host-name lookup. | [optional] | +| **options** | **kotlin.collections.MutableList<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecPrivileges.md b/api-model-v1-52/docs/TaskSpecContainerSpecPrivileges.md new file mode 100644 index 00000000..03edb15c --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecPrivileges.md @@ -0,0 +1,14 @@ + +# TaskSpecContainerSpecPrivileges + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **credentialSpec** | [**TaskSpecContainerSpecPrivilegesCredentialSpec**](TaskSpecContainerSpecPrivilegesCredentialSpec.md) | | [optional] | +| **seLinuxContext** | [**TaskSpecContainerSpecPrivilegesSELinuxContext**](TaskSpecContainerSpecPrivilegesSELinuxContext.md) | | [optional] | +| **seccomp** | [**TaskSpecContainerSpecPrivilegesSeccomp**](TaskSpecContainerSpecPrivilegesSeccomp.md) | | [optional] | +| **appArmor** | [**TaskSpecContainerSpecPrivilegesAppArmor**](TaskSpecContainerSpecPrivilegesAppArmor.md) | | [optional] | +| **noNewPrivileges** | **kotlin.Boolean** | Configuration of the no_new_privs bit in the container | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesAppArmor.md b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesAppArmor.md new file mode 100644 index 00000000..9551f4bc --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesAppArmor.md @@ -0,0 +1,17 @@ + +# TaskSpecContainerSpecPrivilegesAppArmor + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | | [optional] | + + + +## Enum: Mode +| Name | Value | +| ---- | ----- | +| mode | default, disabled | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md new file mode 100644 index 00000000..427e0c31 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesCredentialSpec.md @@ -0,0 +1,12 @@ + +# TaskSpecContainerSpecPrivilegesCredentialSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **config** | **kotlin.String** | Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **file** | **kotlin.String** | Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`. <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | +| **registry** | **kotlin.String** | Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs` <p><br /></p> > **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md new file mode 100644 index 00000000..996b8470 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesSELinuxContext.md @@ -0,0 +1,14 @@ + +# TaskSpecContainerSpecPrivilegesSELinuxContext + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **disable** | **kotlin.Boolean** | Disable SELinux | [optional] | +| **user** | **kotlin.String** | SELinux user label | [optional] | +| **role** | **kotlin.String** | SELinux role label | [optional] | +| **type** | **kotlin.String** | SELinux type label | [optional] | +| **level** | **kotlin.String** | SELinux level label | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesSeccomp.md b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesSeccomp.md new file mode 100644 index 00000000..8eb1cf79 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecPrivilegesSeccomp.md @@ -0,0 +1,18 @@ + +# TaskSpecContainerSpecPrivilegesSeccomp + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **mode** | [**inline**](#Mode) | | [optional] | +| **profile** | **kotlin.String** | The custom seccomp profile as a json object | [optional] | + + + +## Enum: Mode +| Name | Value | +| ---- | ----- | +| mode | default, unconfined, custom | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecSecretsInner.md b/api-model-v1-52/docs/TaskSpecContainerSpecSecretsInner.md new file mode 100644 index 00000000..11d5721e --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecSecretsInner.md @@ -0,0 +1,12 @@ + +# TaskSpecContainerSpecSecretsInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **file** | [**TaskSpecContainerSpecSecretsInnerFile**](TaskSpecContainerSpecSecretsInnerFile.md) | | [optional] | +| **secretID** | **kotlin.String** | SecretID represents the ID of the specific secret that we're referencing. | [optional] | +| **secretName** | **kotlin.String** | SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecContainerSpecSecretsInnerFile.md b/api-model-v1-52/docs/TaskSpecContainerSpecSecretsInnerFile.md new file mode 100644 index 00000000..c90d914f --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecContainerSpecSecretsInnerFile.md @@ -0,0 +1,13 @@ + +# TaskSpecContainerSpecSecretsInnerFile + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name represents the final filename in the filesystem. | [optional] | +| **UID** | **kotlin.String** | UID represents the file UID. | [optional] | +| **GID** | **kotlin.String** | GID represents the file GID. | [optional] | +| **mode** | **kotlin.Int** | Mode represents the FileMode of the file. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecLogDriver.md b/api-model-v1-52/docs/TaskSpecLogDriver.md new file mode 100644 index 00000000..be81c423 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecLogDriver.md @@ -0,0 +1,11 @@ + +# TaskSpecLogDriver + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | | [optional] | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecNetworkAttachmentSpec.md b/api-model-v1-52/docs/TaskSpecNetworkAttachmentSpec.md new file mode 100644 index 00000000..ae098a2f --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecNetworkAttachmentSpec.md @@ -0,0 +1,10 @@ + +# TaskSpecNetworkAttachmentSpec + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **containerID** | **kotlin.String** | ID of the container represented by this task | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecPlacement.md b/api-model-v1-52/docs/TaskSpecPlacement.md new file mode 100644 index 00000000..77547827 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecPlacement.md @@ -0,0 +1,13 @@ + +# TaskSpecPlacement + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **constraints** | **kotlin.collections.MutableList<kotlin.String>** | An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-24.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). | [optional] | +| **preferences** | [**kotlin.collections.MutableList<TaskSpecPlacementPreferencesInner>**](TaskSpecPlacementPreferencesInner.md) | Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. | [optional] | +| **maxReplicas** | **kotlin.Long** | Maximum number of replicas for per node (default value is 0, which is unlimited) | [optional] | +| **platforms** | [**kotlin.collections.MutableList<Platform>**](Platform.md) | Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecPlacementPreferencesInner.md b/api-model-v1-52/docs/TaskSpecPlacementPreferencesInner.md new file mode 100644 index 00000000..2894f7e5 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecPlacementPreferencesInner.md @@ -0,0 +1,10 @@ + +# TaskSpecPlacementPreferencesInner + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spread** | [**TaskSpecPlacementPreferencesInnerSpread**](TaskSpecPlacementPreferencesInnerSpread.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecPlacementPreferencesInnerSpread.md b/api-model-v1-52/docs/TaskSpecPlacementPreferencesInnerSpread.md new file mode 100644 index 00000000..9643c6ae --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecPlacementPreferencesInnerSpread.md @@ -0,0 +1,10 @@ + +# TaskSpecPlacementPreferencesInnerSpread + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spreadDescriptor** | **kotlin.String** | label descriptor, such as `engine.labels.az`. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecPluginSpec.md b/api-model-v1-52/docs/TaskSpecPluginSpec.md new file mode 100644 index 00000000..45eb9382 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecPluginSpec.md @@ -0,0 +1,13 @@ + +# TaskSpecPluginSpec + +## Properties +| 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.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecResources.md b/api-model-v1-52/docs/TaskSpecResources.md new file mode 100644 index 00000000..a2bd6fea --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecResources.md @@ -0,0 +1,13 @@ + +# TaskSpecResources + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **limits** | [**Limit**](Limit.md) | | [optional] | +| **reservations** | [**ResourceObject**](ResourceObject.md) | | [optional] | +| **swapBytes** | **kotlin.Long** | Amount of swap in bytes - can only be used together with a memory limit. If not specified, the default behaviour is to grant a swap space twice as big as the memory limit. Set to -1 to enable unlimited swap. | [optional] | +| **memorySwappiness** | **kotlin.Long** | Tune the service's containers' memory swappiness (0 to 100). If not specified, defaults to the containers' OS' default, generally 60, or whatever value was predefined in the image. Set to -1 to unset a previously set value. | [optional] | + + + diff --git a/api-model-v1-52/docs/TaskSpecRestartPolicy.md b/api-model-v1-52/docs/TaskSpecRestartPolicy.md new file mode 100644 index 00000000..d139ec81 --- /dev/null +++ b/api-model-v1-52/docs/TaskSpecRestartPolicy.md @@ -0,0 +1,20 @@ + +# TaskSpecRestartPolicy + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **condition** | [**inline**](#Condition) | Condition for restart. | [optional] | +| **delay** | **kotlin.Long** | Delay between restart attempts. | [optional] | +| **maxAttempts** | **kotlin.Long** | Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). | [optional] | +| **window** | **kotlin.Long** | Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). | [optional] | + + + +## Enum: Condition +| Name | Value | +| ---- | ----- | +| condition | none, on-failure, any | + + + diff --git a/api-model-v1-52/docs/TaskState.md b/api-model-v1-52/docs/TaskState.md new file mode 100644 index 00000000..5652eb48 --- /dev/null +++ b/api-model-v1-52/docs/TaskState.md @@ -0,0 +1,38 @@ + +# TaskState + +## Enum + + + * `New` (value: `"new"`) + + * `Allocated` (value: `"allocated"`) + + * `Pending` (value: `"pending"`) + + * `Assigned` (value: `"assigned"`) + + * `Accepted` (value: `"accepted"`) + + * `Preparing` (value: `"preparing"`) + + * `Ready` (value: `"ready"`) + + * `Starting` (value: `"starting"`) + + * `Running` (value: `"running"`) + + * `Complete` (value: `"complete"`) + + * `Shutdown` (value: `"shutdown"`) + + * `Failed` (value: `"failed"`) + + * `Rejected` (value: `"rejected"`) + + * `Remove` (value: `"remove"`) + + * `Orphaned` (value: `"orphaned"`) + + + diff --git a/api-model-v1-52/docs/TaskStatus.md b/api-model-v1-52/docs/TaskStatus.md new file mode 100644 index 00000000..347db437 --- /dev/null +++ b/api-model-v1-52/docs/TaskStatus.md @@ -0,0 +1,15 @@ + +# TaskStatus + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **timestamp** | **kotlin.String** | | [optional] | +| **state** | [**TaskState**](TaskState.md) | | [optional] | +| **message** | **kotlin.String** | | [optional] | +| **err** | **kotlin.String** | | [optional] | +| **containerStatus** | [**ContainerStatus**](ContainerStatus.md) | | [optional] | +| **portStatus** | [**PortStatus**](PortStatus.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/ThrottleDevice.md b/api-model-v1-52/docs/ThrottleDevice.md new file mode 100644 index 00000000..a4dbeb34 --- /dev/null +++ b/api-model-v1-52/docs/ThrottleDevice.md @@ -0,0 +1,11 @@ + +# ThrottleDevice + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **path** | **kotlin.String** | Device path | [optional] | +| **rate** | **kotlin.Long** | Rate | [optional] | + + + diff --git a/api-model-v1-52/docs/UnlockKeyResponse.md b/api-model-v1-52/docs/UnlockKeyResponse.md new file mode 100644 index 00000000..e530f063 --- /dev/null +++ b/api-model-v1-52/docs/UnlockKeyResponse.md @@ -0,0 +1,10 @@ + +# UnlockKeyResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **unlockKey** | **kotlin.String** | The swarm's unlock key. | [optional] | + + + diff --git a/api-model-v1-52/docs/Volume.md b/api-model-v1-52/docs/Volume.md new file mode 100644 index 00000000..25fce51e --- /dev/null +++ b/api-model-v1-52/docs/Volume.md @@ -0,0 +1,26 @@ + +# Volume + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | Name of the volume. | | +| **driver** | **kotlin.String** | Name of the volume driver used by the volume. | | +| **mountpoint** | **kotlin.String** | Mount path of the volume on the host. | | +| **options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | | +| **createdAt** | **kotlin.String** | Date/Time the volume was created. | [optional] | +| **status** | [**kotlin.collections.MutableMap<kotlin.String, kotlin.Any>**](kotlin.Any.md) | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | [optional] | +| **clusterVolume** | [**ClusterVolume**](ClusterVolume.md) | | [optional] | +| **usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] | + + + +## Enum: Scope +| Name | Value | +| ---- | ----- | +| scope | local, global | + + + diff --git a/api-model-v1-52/docs/VolumeCreateRequest.md b/api-model-v1-52/docs/VolumeCreateRequest.md new file mode 100644 index 00000000..32ca6979 --- /dev/null +++ b/api-model-v1-52/docs/VolumeCreateRequest.md @@ -0,0 +1,14 @@ + +# VolumeCreateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **name** | **kotlin.String** | The new volume's name. If not specified, Docker generates a name. | [optional] | +| **driver** | **kotlin.String** | Name of the volume driver to use. | [optional] | +| **driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | A mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional] | +| **labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] | +| **clusterVolumeSpec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/VolumeListResponse.md b/api-model-v1-52/docs/VolumeListResponse.md new file mode 100644 index 00000000..832e8349 --- /dev/null +++ b/api-model-v1-52/docs/VolumeListResponse.md @@ -0,0 +1,11 @@ + +# VolumeListResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | [optional] | +| **warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | [optional] | + + + diff --git a/api-model-v1-52/docs/VolumePruneResponse.md b/api-model-v1-52/docs/VolumePruneResponse.md new file mode 100644 index 00000000..e1b6e248 --- /dev/null +++ b/api-model-v1-52/docs/VolumePruneResponse.md @@ -0,0 +1,11 @@ + +# VolumePruneResponse + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **volumesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Volumes that were deleted | [optional] | +| **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] | + + + diff --git a/api-model-v1-52/docs/VolumeUpdateRequest.md b/api-model-v1-52/docs/VolumeUpdateRequest.md new file mode 100644 index 00000000..8988303b --- /dev/null +++ b/api-model-v1-52/docs/VolumeUpdateRequest.md @@ -0,0 +1,10 @@ + +# VolumeUpdateRequest + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **spec** | [**ClusterVolumeSpec**](ClusterVolumeSpec.md) | | [optional] | + + + diff --git a/api-model-v1-52/docs/VolumeUsageData.md b/api-model-v1-52/docs/VolumeUsageData.md new file mode 100644 index 00000000..442e3a02 --- /dev/null +++ b/api-model-v1-52/docs/VolumeUsageData.md @@ -0,0 +1,11 @@ + +# VolumeUsageData + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **propertySize** | **kotlin.Long** | Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") | | +| **refCount** | **kotlin.Long** | The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. | | + + + diff --git a/api-model-v1-52/docs/VolumesDiskUsage.md b/api-model-v1-52/docs/VolumesDiskUsage.md new file mode 100644 index 00000000..d2974ce8 --- /dev/null +++ b/api-model-v1-52/docs/VolumesDiskUsage.md @@ -0,0 +1,14 @@ + +# VolumesDiskUsage + +## Properties +| Name | Type | Description | Notes | +| ------------ | ------------- | ------------- | ------------- | +| **activeCount** | **kotlin.Long** | Count of active volumes. | [optional] | +| **totalCount** | **kotlin.Long** | Count of all volumes. | [optional] | +| **reclaimable** | **kotlin.Long** | Disk space that can be reclaimed by removing inactive volumes. | [optional] | +| **totalSize** | **kotlin.Long** | Disk space in use by volumes. | [optional] | +| **items** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.md) | List of volumes. | [optional] | + + + diff --git a/api-model-v1-52/openapi-generator-config.yaml b/api-model-v1-52/openapi-generator-config.yaml new file mode 100644 index 00000000..d8a645b0 --- /dev/null +++ b/api-model-v1-52/openapi-generator-config.yaml @@ -0,0 +1,19 @@ +inputSpec: https://docs.docker.com/reference/api/engine/version/v1.52/ +additionalProperties: + hideGenerationTimestamp: true +generatorName: kotlin +packageName: de.gesellix.docker.remote.api +#invokerPackage: de.gesellix.docker.remote.invoker +apiPackage: de.gesellix.docker.remote.client.api +modelPackage: de.gesellix.docker.remote.api +enumPropertyNaming: PascalCase +nameMappings: + is_official: official + is_automated: automated +groupId: de.gesellix +artifactId: docker-remote-api-model +artifactVersion: 1.52 +outputDir: api-model-v1-52 +dateLibrary: java8 +moshiCodeGen: true +modelMutable: true diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt new file mode 100644 index 00000000..241b422a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Address represents an IPv4 or IPv6 IP address. + * + * @param addr IP address. + * @param prefixLen Mask length of the IP address. + */ +@JsonClass(generateAdapter = true) +data class Address( + // IP address. + @Json(name = "Addr") + var addr: kotlin.String? = null, + // Mask length of the IP address. + @Json(name = "PrefixLen") + var prefixLen: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt new file mode 100644 index 00000000..ea2f03c9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param username + * @param password + * @param serveraddress + */ +@JsonClass(generateAdapter = true) +data class AuthConfig( + @Json(name = "username") + var username: kotlin.String? = null, + @Json(name = "password") + var password: kotlin.String? = null, + @Json(name = "serveraddress") + var serveraddress: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/AuthResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/AuthResponse.kt new file mode 100644 index 00000000..34cb7079 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/AuthResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * An identity token was generated successfully. + * + * @param status The status of the authentication + * @param identityToken An opaque token used to authenticate a user after a successful login + */ +@JsonClass(generateAdapter = true) +data class AuthResponse( + // The status of the authentication + @Json(name = "Status") + var status: kotlin.String, + // An opaque token used to authenticate a user after a successful login + @Json(name = "IdentityToken") + var identityToken: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt new file mode 100644 index 00000000..80a48034 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt @@ -0,0 +1,92 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * BuildCache contains information about a build cache record. + * + * @param ID Unique ID of the build cache record. + * @param parents List of parent build cache record IDs. + * @param type Cache record type. + * @param description Description of the build-step that produced the build cache. + * @param inUse Indicates if the build cache is in use. + * @param shared Indicates if the build cache is shared. + * @param propertySize Amount of disk space used by the build cache (in bytes). + * @param createdAt Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param lastUsedAt Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param usageCount + */ +@JsonClass(generateAdapter = true) +data class BuildCache( + // Unique ID of the build cache record. + @Json(name = "ID") + var ID: kotlin.String? = null, + // List of parent build cache record IDs. + @Json(name = "Parents") + var parents: kotlin.collections.MutableList? = null, + // Cache record type. + @Json(name = "Type") + var type: BuildCache.Type? = null, + // Description of the build-step that produced the build cache. + @Json(name = "Description") + var description: kotlin.String? = null, + // Indicates if the build cache is in use. + @Json(name = "InUse") + var inUse: kotlin.Boolean? = null, + // Indicates if the build cache is shared. + @Json(name = "Shared") + var shared: kotlin.Boolean? = null, + // Amount of disk space used by the build cache (in bytes). + @Json(name = "Size") + var propertySize: kotlin.Int? = null, + // Date and time at which the build cache was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the build cache was last used in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "LastUsedAt") + var lastUsedAt: kotlin.String? = null, + @Json(name = "UsageCount") + var usageCount: kotlin.Int? = null, +) { + /** + * Cache record type. + * + * Values: Internal,Frontend,SourcePeriodLocal,SourcePeriodGitPeriodCheckout,ExecPeriodCachemount,Regular + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "internal") + Internal("internal"), + + @Json(name = "frontend") + Frontend("frontend"), + + @Json(name = "source.local") + SourcePeriodLocal("source.local"), + + @Json(name = "source.git.checkout") + SourcePeriodGitPeriodCheckout("source.git.checkout"), + + @Json(name = "exec.cachemount") + ExecPeriodCachemount("exec.cachemount"), + + @Json(name = "regular") + Regular("regular"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildCacheDiskUsage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildCacheDiskUsage.kt new file mode 100644 index 00000000..a5dd119e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildCacheDiskUsage.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents system data usage for build cache resources. + * + * @param activeCount Count of active build cache records. + * @param totalCount Count of all build cache records. + * @param reclaimable Disk space that can be reclaimed by removing inactive build cache records. + * @param totalSize Disk space in use by build cache records. + * @param items List of build cache records. + */ +@JsonClass(generateAdapter = true) +data class BuildCacheDiskUsage( + // Count of active build cache records. + @Json(name = "ActiveCount") + var activeCount: kotlin.Long? = null, + // Count of all build cache records. + @Json(name = "TotalCount") + var totalCount: kotlin.Long? = null, + // Disk space that can be reclaimed by removing inactive build cache records. + @Json(name = "Reclaimable") + var reclaimable: kotlin.Long? = null, + // Disk space in use by build cache records. + @Json(name = "TotalSize") + var totalSize: kotlin.Long? = null, + // List of build cache records. + @Json(name = "Items") + var items: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt new file mode 100644 index 00000000..f0af14e6 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id + * @param stream + * @param errorDetail + * @param status + * @param progressDetail + * @param aux + */ +@JsonClass(generateAdapter = true) +data class BuildInfo( + @Json(name = "id") + var id: kotlin.String? = null, + @Json(name = "stream") + var stream: kotlin.String? = null, + @Json(name = "errorDetail") + var errorDetail: ErrorDetail? = null, + @Json(name = "status") + var status: kotlin.String? = null, + @Json(name = "progressDetail") + var progressDetail: ProgressDetail? = null, + @Json(name = "aux") + var aux: ImageID? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt new file mode 100644 index 00000000..b0be3cb6 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param cachesDeleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class BuildPruneResponse( + @Json(name = "CachesDeleted") + var cachesDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt new file mode 100644 index 00000000..c76d0e50 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ChangeType.kt @@ -0,0 +1,65 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Kind of change Can be one of: - `0`: Modified (\"C\") - `1`: Added (\"A\") - `2`: Deleted (\"D\") + * + * Values: T0,T1,T2 + */ + +@JsonClass(generateAdapter = false) +enum class ChangeType(val value: kotlin.Int) { + @Json(name = "0") + T0(0), + + @Json(name = "1") + T1(1), + + @Json(name = "2") + T2(2), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value.toString() + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is ChangeType) "$data" else null + + /** + * Returns a valid [ChangeType] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): ChangeType? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt new file mode 100644 index 00000000..15db9529 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt @@ -0,0 +1,64 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ClusterInfo represents information about the swarm as is returned by the \"/info\" endpoint. Join-tokens are not included. + * + * @param ID The ID of the swarm. + * @param version + * @param createdAt Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param updatedAt Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param spec + * @param tlSInfo + * @param rootRotationInProgress Whether there is currently a root CA rotation in progress for the swarm + * @param dataPathPort 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, the default port (4789) is used. + * @param defaultAddrPool Default Address Pool specifies default subnet pools for global scope networks. + * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. + */ +@JsonClass(generateAdapter = true) +data class ClusterInfo( + // The ID of the swarm. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + // Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: SwarmSpec? = null, + @Json(name = "TLSInfo") + var tlSInfo: TLSInfo? = null, + // Whether there is currently a root CA rotation in progress for the swarm + @Json(name = "RootRotationInProgress") + var rootRotationInProgress: kotlin.Boolean? = null, + // 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, the default port (4789) is used. + @Json(name = "DataPathPort") + var dataPathPort: kotlin.Int? = null, + // Default Address Pool specifies default subnet pools for global scope networks. + @Json(name = "DefaultAddrPool") + var defaultAddrPool: kotlin.collections.MutableList? = null, + // SubnetSize specifies the subnet size of the networks created from the default subnet pool. + @Json(name = "SubnetSize") + var subnetSize: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt new file mode 100644 index 00000000..3056cbe3 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolume.kt @@ -0,0 +1,50 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Options and information specific to, and only present on, Swarm CSI cluster volumes. + * + * @param ID The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. + * @param version + * @param createdAt + * @param updatedAt + * @param spec + * @param info + * @param publishStatus The status of the volume as it pertains to its publishing and use on specific nodes + */ +@JsonClass(generateAdapter = true) +data class ClusterVolume( + // The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: ClusterVolumeSpec? = null, + @Json(name = "Info") + var info: ClusterVolumeInfo? = null, + // The status of the volume as it pertains to its publishing and use on specific nodes + @Json(name = "PublishStatus") + var publishStatus: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt new file mode 100644 index 00000000..020c0822 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeInfo.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the global status of the volume. + * + * @param capacityBytes The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. + * @param volumeContext A map of strings to strings returned from the storage plugin when the volume is created. + * @param volumeID The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. + * @param accessibleTopology The topology this volume is actually accessible from. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeInfo( + // The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown. + @Json(name = "CapacityBytes") + var capacityBytes: kotlin.Long? = null, + // A map of strings to strings returned from the storage plugin when the volume is created. + @Json(name = "VolumeContext") + var volumeContext: kotlin.collections.MutableMap? = null, + // The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet. + @Json(name = "VolumeID") + var volumeID: kotlin.String? = null, + // The topology this volume is actually accessible from. + @Json(name = "AccessibleTopology") + var accessibleTopology: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt new file mode 100644 index 00000000..2bdb091b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumePublishStatusInner.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param nodeID The ID of the Swarm node the volume is published on. + * @param state The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + * @param publishContext A map of strings to strings returned by the CSI controller plugin when a volume is published. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumePublishStatusInner( + // The ID of the Swarm node the volume is published on. + @Json(name = "NodeID") + var nodeID: kotlin.String? = null, + // The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + @Json(name = "State") + var state: ClusterVolumePublishStatusInner.State? = null, + // A map of strings to strings returned by the CSI controller plugin when a volume is published. + @Json(name = "PublishContext") + var publishContext: kotlin.collections.MutableMap? = null, +) { + /** + * The published state of the volume. * `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * `published` The volume is published successfully to the node. * `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller. + * + * Values: PendingPublish,Published,PendingNodeUnpublish,PendingControllerUnpublish + */ + @JsonClass(generateAdapter = false) + enum class State(val value: kotlin.String) { + @Json(name = "pending-publish") + PendingPublish("pending-publish"), + + @Json(name = "published") + Published("published"), + + @Json(name = "pending-node-unpublish") + PendingNodeUnpublish("pending-node-unpublish"), + + @Json(name = "pending-controller-unpublish") + PendingControllerUnpublish("pending-controller-unpublish"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt new file mode 100644 index 00000000..ee4034cc --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpec.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Cluster-specific options used to create the volume. + * + * @param group Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. + * @param accessMode + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpec( + // Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group. + @Json(name = "Group") + var group: kotlin.String? = null, + @Json(name = "AccessMode") + var accessMode: ClusterVolumeSpecAccessMode? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt new file mode 100644 index 00000000..75c554ec --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessMode.kt @@ -0,0 +1,104 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Defines how the volume is used by tasks. + * + * @param scope The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. + * @param sharing The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. + * @param mountVolume Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. + * @param secrets Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. + * @param accessibilityRequirements + * @param capacityRange + * @param availability The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessMode( + // The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. + @Json(name = "Scope") + var scope: ClusterVolumeSpecAccessMode.Scope? = Scope.Single, + // The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. + @Json(name = "Sharing") + var sharing: ClusterVolumeSpecAccessMode.Sharing? = Sharing.None, + // Options for using this volume as a Mount-type volume. Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: \"string\" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: \"array\" description: | Flags to pass when mounting the volume. Optional. items: type: \"string\" BlockVolume: type: \"object\" description: | Options for using this volume as a Block-type volume. Intentionally empty. + @Json(name = "MountVolume") + var mountVolume: kotlin.Any? = null, + // Swarm Secrets that are passed to the CSI storage plugin when operating on this volume. + @Json(name = "Secrets") + var secrets: kotlin.collections.MutableList? = null, + @Json(name = "AccessibilityRequirements") + var accessibilityRequirements: ClusterVolumeSpecAccessModeAccessibilityRequirements? = null, + @Json(name = "CapacityRange") + var capacityRange: ClusterVolumeSpecAccessModeCapacityRange? = null, + // The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + @Json(name = "Availability") + var availability: ClusterVolumeSpecAccessMode.Availability? = Availability.Active, +) { + /** + * The set of nodes this volume can be used on at one time. - `single` The volume may only be scheduled to one node at a time. - `multi` the volume may be scheduled to any supported number of nodes at a time. + * + * Values: Single,Multi + */ + @JsonClass(generateAdapter = false) + enum class Scope(val value: kotlin.String) { + @Json(name = "single") + Single("single"), + + @Json(name = "multi") + Multi("multi"), + } + + /** + * The number and way that different tasks can use this volume at one time. - `none` The volume may only be used by one task at a time. - `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly - `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write. - `all` The volume may have any number of readers and writers. + * + * Values: None,Readonly,Onewriter,All + */ + @JsonClass(generateAdapter = false) + enum class Sharing(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "readonly") + Readonly("readonly"), + + @Json(name = "onewriter") + Onewriter("onewriter"), + + @Json(name = "all") + All("all"), + } + + /** + * The availability of the volume for use in tasks. - `active` The volume is fully available for scheduling on the cluster - `pause` No new workloads should use the volume, but existing workloads are not stopped. - `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started. + * + * Values: Active,Pause,Drain + */ + @JsonClass(generateAdapter = false) + enum class Availability(val value: kotlin.String) { + @Json(name = "active") + Active("active"), + + @Json(name = "pause") + Pause("pause"), + + @Json(name = "drain") + Drain("drain"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt new file mode 100644 index 00000000..c3768ebc --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeAccessibilityRequirements.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Requirements for the accessible topology of the volume. These fields are optional. For an in-depth description of what these fields mean, see the CSI specification. + * + * @param requisite A list of required topologies, at least one of which the volume must be accessible from. + * @param preferred A list of topologies that the volume should attempt to be provisioned in. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessModeAccessibilityRequirements( + // A list of required topologies, at least one of which the volume must be accessible from. + @Json(name = "Requisite") + var requisite: kotlin.collections.MutableList>? = null, + // A list of topologies that the volume should attempt to be provisioned in. + @Json(name = "Preferred") + var preferred: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt new file mode 100644 index 00000000..96340413 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeCapacityRange.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity. + * + * @param requiredBytes The volume must be at least this big. The value of 0 indicates an unspecified minimum + * @param limitBytes The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessModeCapacityRange( + // The volume must be at least this big. The value of 0 indicates an unspecified minimum + @Json(name = "RequiredBytes") + var requiredBytes: kotlin.Long? = null, + // The volume must not be bigger than this. The value of 0 indicates an unspecified maximum. + @Json(name = "LimitBytes") + var limitBytes: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt new file mode 100644 index 00000000..d6a4f13f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ClusterVolumeSpecAccessModeSecretsInner.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * One cluster volume secret entry. Defines a key-value pair that is passed to the plugin. + * + * @param key Key is the name of the key of the key-value pair passed to the plugin. + * @param secret Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. + */ +@JsonClass(generateAdapter = true) +data class ClusterVolumeSpecAccessModeSecretsInner( + // Key is the name of the key of the key-value pair passed to the plugin. + @Json(name = "Key") + var key: kotlin.String? = null, + // Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin. + @Json(name = "Secret") + var secret: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt new file mode 100644 index 00000000..ee45ec9e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`. + * + * @param ID Actual commit ID of external tool. + */ +@JsonClass(generateAdapter = true) +data class Commit( + // Actual commit ID of external tool. + @Json(name = "ID") + var ID: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt new file mode 100644 index 00000000..d1ac38ed --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt + * @param updatedAt + * @param spec + */ +@JsonClass(generateAdapter = true) +data class Config( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: ConfigSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt new file mode 100644 index 00000000..2551f34c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the config. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + * @param templating + */ +@JsonClass(generateAdapter = true) +data class ConfigCreateRequest( + // User-defined name of the config. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt new file mode 100644 index 00000000..5bd0bdd8 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigReference.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The config-only network source to provide the configuration for this network. + * + * @param network The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. + */ +@JsonClass(generateAdapter = true) +data class ConfigReference( + // The name of the config-only network that provides the network's configuration. The specified network must be an existing config-only network. Only network names are allowed, not network IDs. + @Json(name = "Network") + var network: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt new file mode 100644 index 00000000..20ae0c3b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the config. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + * @param templating + */ +@JsonClass(generateAdapter = true) +data class ConfigSpec( + // User-defined name of the config. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a config, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0-20250103191802-8c1959736554/manager/controlapi#MaxConfigSize). + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStatEntry.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStatEntry.kt new file mode 100644 index 00000000..d061acf3 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStatEntry.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Blkio stats entry. This type is Linux-specific and omitted for Windows containers. + * + * @param major + * @param minor + * @param op + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class ContainerBlkioStatEntry( + @Json(name = "major") + var major: kotlin.Int? = null, + @Json(name = "minor") + var minor: kotlin.Int? = null, + @Json(name = "op") + var op: kotlin.String? = null, + @Json(name = "value") + var `value`: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStats.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStats.kt new file mode 100644 index 00000000..aecbed24 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerBlkioStats.kt @@ -0,0 +1,58 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * BlkioStats stores all IO service stats for data read and write. This type is Linux-specific and holds many fields that are specific to cgroups v1. On a cgroup v2 host, all fields other than `io_service_bytes_recursive` are omitted or `null`. This type is only populated on Linux and omitted for Windows containers. + * + * @param ioServiceBytesRecursive + * @param ioServicedRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + * @param ioQueueRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + * @param ioServiceTimeRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + * @param ioWaitTimeRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + * @param ioMergedRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + * @param ioTimeRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + * @param sectorsRecursive This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + */ +@JsonClass(generateAdapter = true) +data class ContainerBlkioStats( + @Json(name = "io_service_bytes_recursive") + var ioServiceBytesRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "io_serviced_recursive") + var ioServicedRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "io_queue_recursive") + var ioQueueRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "io_service_time_recursive") + var ioServiceTimeRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "io_wait_time_recursive") + var ioWaitTimeRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "io_merged_recursive") + var ioMergedRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "io_time_recursive") + var ioTimeRecursive: kotlin.collections.MutableList? = null, + // This field is only available when using Linux containers with cgroups v1. It is omitted or `null` when using cgroups v2. + @Json(name = "sectors_recursive") + var sectorsRecursive: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUStats.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUStats.kt new file mode 100644 index 00000000..795e15db --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUStats.kt @@ -0,0 +1,41 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * CPU related info of the container + * + * @param cpuUsage + * @param systemCpuUsage System Usage. This field is Linux-specific and omitted for Windows containers. + * @param onlineCpus Number of online CPUs. This field is Linux-specific and omitted for Windows containers. + * @param throttlingData + */ +@JsonClass(generateAdapter = true) +data class ContainerCPUStats( + @Json(name = "cpu_usage") + var cpuUsage: ContainerCPUUsage? = null, + // System Usage. This field is Linux-specific and omitted for Windows containers. + @Json(name = "system_cpu_usage") + var systemCpuUsage: kotlin.Int? = null, + // Number of online CPUs. This field is Linux-specific and omitted for Windows containers. + @Json(name = "online_cpus") + var onlineCpus: kotlin.Int? = null, + @Json(name = "throttling_data") + var throttlingData: ContainerThrottlingData? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUUsage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUUsage.kt new file mode 100644 index 00000000..e6719cf4 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCPUUsage.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * All CPU stats aggregated since container inception. + * + * @param totalUsage Total CPU time consumed in nanoseconds (Linux) or 100's of nanoseconds (Windows). + * @param percpuUsage Total CPU time (in nanoseconds) consumed per core (Linux). This field is Linux-specific when using cgroups v1. It is omitted when using cgroups v2 and Windows containers. + * @param usageInKernelmode Time (in nanoseconds) spent by tasks of the cgroup in kernel mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. + * @param usageInUsermode Time (in nanoseconds) spent by tasks of the cgroup in user mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. + */ +@JsonClass(generateAdapter = true) +data class ContainerCPUUsage( + // Total CPU time consumed in nanoseconds (Linux) or 100's of nanoseconds (Windows). + @Json(name = "total_usage") + var totalUsage: kotlin.Int? = null, + // Total CPU time (in nanoseconds) consumed per core (Linux). This field is Linux-specific when using cgroups v1. It is omitted when using cgroups v2 and Windows containers. + @Json(name = "percpu_usage") + var percpuUsage: kotlin.collections.MutableList? = null, + // Time (in nanoseconds) spent by tasks of the cgroup in kernel mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. + @Json(name = "usage_in_kernelmode") + var usageInKernelmode: kotlin.Int? = null, + // Time (in nanoseconds) spent by tasks of the cgroup in user mode (Linux), or time spent (in 100's of nanoseconds) by all container processes in kernel mode (Windows). Not populated for Windows containers using Hyper-V isolation. + @Json(name = "usage_in_usermode") + var usageInUsermode: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt new file mode 100644 index 00000000..0ae42418 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt @@ -0,0 +1,122 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Configuration for a container that is portable between hosts. + * + * @param hostname The hostname to use for the container, as a valid RFC 1123 hostname. + * @param domainname The domain name to use for the container. + * @param user Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`[<:group-name|GID>]`). + * @param attachStdin Whether to attach to `stdin`. + * @param attachStdout Whether to attach to `stdout`. + * @param attachStderr Whether to attach to `stderr`. + * @param exposedPorts An object mapping ports to an empty object in the form: `{\"/\": {}}` + * @param tty Attach standard streams to a TTY, including `stdin` if it is not closed. + * @param openStdin Open `stdin` + * @param stdinOnce Close `stdin` after one attached client disconnects + * @param env A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + * @param cmd Command to run specified as a string or an array of strings. + * @param healthcheck + * @param argsEscaped Command is already escaped (Windows only) + * @param image The name (or reference) of the image to use when creating the container, or which was used when the container was created. + * @param volumes An object mapping mount point paths inside the container to empty objects. + * @param workingDir The working directory for commands to run in. + * @param entrypoint The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + * @param networkDisabled Disable networking for the container. + * @param onBuild `ONBUILD` metadata that were defined in the image's `Dockerfile`. + * @param labels User-defined key/value metadata. + * @param stopSignal Signal to stop a container as a string or unsigned integer. + * @param stopTimeout Timeout to stop a container in seconds. + * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + */ +@JsonClass(generateAdapter = true) +data class ContainerConfig( + // The hostname to use for the container, as a valid RFC 1123 hostname. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // The domain name to use for the container. + @Json(name = "Domainname") + var domainname: kotlin.String? = null, + // Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`[<:group-name|GID>]`). + @Json(name = "User") + var user: kotlin.String? = null, + // Whether to attach to `stdin`. + @Json(name = "AttachStdin") + var attachStdin: kotlin.Boolean? = false, + // Whether to attach to `stdout`. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = true, + // Whether to attach to `stderr`. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = true, + // An object mapping ports to an empty object in the form: `{\"/\": {}}` + @Json(name = "ExposedPorts") + var exposedPorts: kotlin.collections.MutableMap? = null, + // Attach standard streams to a TTY, including `stdin` if it is not closed. + @Json(name = "Tty") + var tty: kotlin.Boolean? = false, + // Open `stdin` + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = false, + // Close `stdin` after one attached client disconnects + @Json(name = "StdinOnce") + var stdinOnce: kotlin.Boolean? = false, + // A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run specified as a string or an array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + @Json(name = "Healthcheck") + var healthcheck: HealthConfig? = null, + // Command is already escaped (Windows only) + @Json(name = "ArgsEscaped") + var argsEscaped: kotlin.Boolean? = null, + // The name (or reference) of the image to use when creating the container, or which was used when the container was created. + @Json(name = "Image") + var image: kotlin.String? = null, + // An object mapping mount point paths inside the container to empty objects. + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableMap? = null, + // The working directory for commands to run in. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, + // The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList? = null, + // Disable networking for the container. + @Json(name = "NetworkDisabled") + var networkDisabled: kotlin.Boolean? = null, + // `ONBUILD` metadata that were defined in the image's `Dockerfile`. + @Json(name = "OnBuild") + var onBuild: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Signal to stop a container as a string or unsigned integer. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = "SIGTERM", + // Timeout to stop a container in seconds. + @Json(name = "StopTimeout") + var stopTimeout: kotlin.Int? = null, + // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + @Json(name = "Shell") + var shell: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt new file mode 100644 index 00000000..30cf1818 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt @@ -0,0 +1,128 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param hostname The hostname to use for the container, as a valid RFC 1123 hostname. + * @param domainname The domain name to use for the container. + * @param user Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`[<:group-name|GID>]`). + * @param attachStdin Whether to attach to `stdin`. + * @param attachStdout Whether to attach to `stdout`. + * @param attachStderr Whether to attach to `stderr`. + * @param exposedPorts An object mapping ports to an empty object in the form: `{\"/\": {}}` + * @param tty Attach standard streams to a TTY, including `stdin` if it is not closed. + * @param openStdin Open `stdin` + * @param stdinOnce Close `stdin` after one attached client disconnects + * @param env A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + * @param cmd Command to run specified as a string or an array of strings. + * @param healthcheck + * @param argsEscaped Command is already escaped (Windows only) + * @param image The name (or reference) of the image to use when creating the container, or which was used when the container was created. + * @param volumes An object mapping mount point paths inside the container to empty objects. + * @param workingDir The working directory for commands to run in. + * @param entrypoint The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + * @param networkDisabled Disable networking for the container. + * @param onBuild `ONBUILD` metadata that were defined in the image's `Dockerfile`. + * @param labels User-defined key/value metadata. + * @param stopSignal Signal to stop a container as a string or unsigned integer. + * @param stopTimeout Timeout to stop a container in seconds. + * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + * @param hostConfig + * @param networkingConfig + */ +@JsonClass(generateAdapter = true) +data class ContainerCreateRequest( + // The hostname to use for the container, as a valid RFC 1123 hostname. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // The domain name to use for the container. + @Json(name = "Domainname") + var domainname: kotlin.String? = null, + // Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from. Can be either user-name or UID, and optional group-name or GID, separated by a colon (`[<:group-name|GID>]`). + @Json(name = "User") + var user: kotlin.String? = null, + // Whether to attach to `stdin`. + @Json(name = "AttachStdin") + var attachStdin: kotlin.Boolean? = false, + // Whether to attach to `stdout`. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = true, + // Whether to attach to `stderr`. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = true, + // An object mapping ports to an empty object in the form: `{\"/\": {}}` + @Json(name = "ExposedPorts") + var exposedPorts: kotlin.collections.MutableMap? = null, + // Attach standard streams to a TTY, including `stdin` if it is not closed. + @Json(name = "Tty") + var tty: kotlin.Boolean? = false, + // Open `stdin` + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = false, + // Close `stdin` after one attached client disconnects + @Json(name = "StdinOnce") + var stdinOnce: kotlin.Boolean? = false, + // A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run specified as a string or an array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + @Json(name = "Healthcheck") + var healthcheck: HealthConfig? = null, + // Command is already escaped (Windows only) + @Json(name = "ArgsEscaped") + var argsEscaped: kotlin.Boolean? = null, + // The name (or reference) of the image to use when creating the container, or which was used when the container was created. + @Json(name = "Image") + var image: kotlin.String? = null, + // An object mapping mount point paths inside the container to empty objects. + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableMap? = null, + // The working directory for commands to run in. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, + // The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList? = null, + // Disable networking for the container. + @Json(name = "NetworkDisabled") + var networkDisabled: kotlin.Boolean? = null, + // `ONBUILD` metadata that were defined in the image's `Dockerfile`. + @Json(name = "OnBuild") + var onBuild: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Signal to stop a container as a string or unsigned integer. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = "SIGTERM", + // Timeout to stop a container in seconds. + @Json(name = "StopTimeout") + var stopTimeout: kotlin.Int? = null, + // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + @Json(name = "Shell") + var shell: kotlin.collections.MutableList? = null, + @Json(name = "HostConfig") + var hostConfig: HostConfig? = null, + @Json(name = "NetworkingConfig") + var networkingConfig: NetworkingConfig? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt new file mode 100644 index 00000000..88307467 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to ContainerCreate operation + * + * @param id The ID of the created container + * @param warnings Warnings encountered when creating the container + */ +@JsonClass(generateAdapter = true) +data class ContainerCreateResponse( + // The ID of the created container + @Json(name = "Id") + var id: kotlin.String, + // Warnings encountered when creating the container + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt new file mode 100644 index 00000000..3b3ceb60 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt @@ -0,0 +1,128 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). + * @param created Date and time at which the container was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param path The path to the command being run + * @param args The arguments to the command being run + * @param state + * @param image The ID (digest) of the image that this container was created from. + * @param resolvConfPath Location of the `/etc/resolv.conf` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + * @param hostnamePath Location of the `/etc/hostname` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + * @param hostsPath Location of the `/etc/hosts` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + * @param logPath Location of the file used to buffer the container's logs. Depending on the logging-driver used for the container, this field may be omitted. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + * @param name The name associated with this container. For historic reasons, the name may be prefixed with a forward-slash (`/`). + * @param restartCount Number of times the container was restarted since it was created, or since daemon was started. + * @param driver The storage-driver used for the container's filesystem (graph-driver or snapshotter). + * @param platform The platform (operating system) for which the container was created. This field was introduced for the experimental \"LCOW\" (Linux Containers On Windows) features, which has been removed. In most cases, this field is equal to the host's operating system (`linux` or `windows`). + * @param imageManifestDescriptor + * @param mountLabel SELinux mount label set for the container. + * @param processLabel SELinux process label set for the container. + * @param appArmorProfile The AppArmor profile set for the container. + * @param execIDs IDs of exec instances that are running in the container. + * @param hostConfig + * @param graphDriver + * @param storage + * @param sizeRw The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. + * @param sizeRootFs The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. + * @param mounts List of mounts used by the container. + * @param config + * @param networkSettings + */ +@JsonClass(generateAdapter = true) +data class ContainerInspectResponse( + // The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). + @Json(name = "Id") + var id: kotlin.String? = null, + // Date and time at which the container was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Created") + var created: kotlin.String? = null, + // The path to the command being run + @Json(name = "Path") + var path: kotlin.String? = null, + // The arguments to the command being run + @Json(name = "Args") + var args: kotlin.collections.MutableList? = null, + @Json(name = "State") + var state: ContainerState? = null, + // The ID (digest) of the image that this container was created from. + @Json(name = "Image") + var image: kotlin.String? = null, + // Location of the `/etc/resolv.conf` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + @Json(name = "ResolvConfPath") + var resolvConfPath: kotlin.String? = null, + // Location of the `/etc/hostname` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + @Json(name = "HostnamePath") + var hostnamePath: kotlin.String? = null, + // Location of the `/etc/hosts` generated for the container on the host. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + @Json(name = "HostsPath") + var hostsPath: kotlin.String? = null, + // Location of the file used to buffer the container's logs. Depending on the logging-driver used for the container, this field may be omitted. This file is managed through the docker daemon, and should not be accessed or modified by other tools. + @Json(name = "LogPath") + var logPath: kotlin.String? = null, + // The name associated with this container. For historic reasons, the name may be prefixed with a forward-slash (`/`). + @Json(name = "Name") + var name: kotlin.String? = null, + // Number of times the container was restarted since it was created, or since daemon was started. + @Json(name = "RestartCount") + var restartCount: kotlin.Int? = null, + // The storage-driver used for the container's filesystem (graph-driver or snapshotter). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // The platform (operating system) for which the container was created. This field was introduced for the experimental \"LCOW\" (Linux Containers On Windows) features, which has been removed. In most cases, this field is equal to the host's operating system (`linux` or `windows`). + @Json(name = "Platform") + var platform: kotlin.String? = null, + @Json(name = "ImageManifestDescriptor") + var imageManifestDescriptor: OCIDescriptor? = null, + // SELinux mount label set for the container. + @Json(name = "MountLabel") + var mountLabel: kotlin.String? = null, + // SELinux process label set for the container. + @Json(name = "ProcessLabel") + var processLabel: kotlin.String? = null, + // The AppArmor profile set for the container. + @Json(name = "AppArmorProfile") + var appArmorProfile: kotlin.String? = null, + // IDs of exec instances that are running in the container. + @Json(name = "ExecIDs") + var execIDs: kotlin.collections.MutableList? = null, + @Json(name = "HostConfig") + var hostConfig: HostConfig? = null, + @Json(name = "GraphDriver") + var graphDriver: DriverData? = null, + @Json(name = "Storage") + var storage: Storage? = null, + // The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. + @Json(name = "SizeRw") + var sizeRw: kotlin.Long? = null, + // The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. + @Json(name = "SizeRootFs") + var sizeRootFs: kotlin.Long? = null, + // List of mounts used by the container. + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + @Json(name = "Config") + var config: ContainerConfig? = null, + @Json(name = "NetworkSettings") + var networkSettings: NetworkSettings? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerMemoryStats.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerMemoryStats.kt new file mode 100644 index 00000000..8ecc90b4 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerMemoryStats.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only. + * + * @param usage Current `res_counter` usage for memory. This field is Linux-specific and omitted for Windows containers. + * @param maxUsage Maximum usage ever recorded. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. + * @param stats All the stats exported via memory.stat. when using cgroups v2. This field is Linux-specific and omitted for Windows containers. + * @param failcnt Number of times memory usage hits limits. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. + * @param limit This field is Linux-specific and omitted for Windows containers. + * @param commitbytes Committed bytes. This field is Windows-specific and omitted for Linux containers. + * @param commitpeakbytes Peak committed bytes. This field is Windows-specific and omitted for Linux containers. + * @param privateworkingset Private working set. This field is Windows-specific and omitted for Linux containers. + */ +@JsonClass(generateAdapter = true) +data class ContainerMemoryStats( + // Current `res_counter` usage for memory. This field is Linux-specific and omitted for Windows containers. + @Json(name = "usage") + var usage: kotlin.Int? = null, + // Maximum usage ever recorded. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. + @Json(name = "max_usage") + var maxUsage: kotlin.Int? = null, + // All the stats exported via memory.stat. when using cgroups v2. This field is Linux-specific and omitted for Windows containers. + @Json(name = "stats") + var stats: kotlin.collections.MutableMap? = null, + // Number of times memory usage hits limits. This field is Linux-specific and only supported on cgroups v1. It is omitted when using cgroups v2 and for Windows containers. + @Json(name = "failcnt") + var failcnt: kotlin.Int? = null, + // This field is Linux-specific and omitted for Windows containers. + @Json(name = "limit") + var limit: kotlin.Int? = null, + // Committed bytes. This field is Windows-specific and omitted for Linux containers. + @Json(name = "commitbytes") + var commitbytes: kotlin.Int? = null, + // Peak committed bytes. This field is Windows-specific and omitted for Linux containers. + @Json(name = "commitpeakbytes") + var commitpeakbytes: kotlin.Int? = null, + // Private working set. This field is Windows-specific and omitted for Linux containers. + @Json(name = "privateworkingset") + var privateworkingset: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerNetworkStats.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerNetworkStats.kt new file mode 100644 index 00000000..a7ac2f42 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerNetworkStats.kt @@ -0,0 +1,67 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Aggregates the network stats of one container + * + * @param rxBytes Bytes received. Windows and Linux. + * @param rxPackets Packets received. Windows and Linux. + * @param rxErrors Received errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. + * @param rxDropped Incoming packets dropped. Windows and Linux. + * @param txBytes Bytes sent. Windows and Linux. + * @param txPackets Packets sent. Windows and Linux. + * @param txErrors Sent errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. + * @param txDropped Outgoing packets dropped. Windows and Linux. + * @param endpointId Endpoint ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. + * @param instanceId Instance ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. + */ +@JsonClass(generateAdapter = true) +data class ContainerNetworkStats( + // Bytes received. Windows and Linux. + @Json(name = "rx_bytes") + var rxBytes: kotlin.Int? = null, + // Packets received. Windows and Linux. + @Json(name = "rx_packets") + var rxPackets: kotlin.Int? = null, + // Received errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. + @Json(name = "rx_errors") + var rxErrors: kotlin.Int? = null, + // Incoming packets dropped. Windows and Linux. + @Json(name = "rx_dropped") + var rxDropped: kotlin.Int? = null, + // Bytes sent. Windows and Linux. + @Json(name = "tx_bytes") + var txBytes: kotlin.Int? = null, + // Packets sent. Windows and Linux. + @Json(name = "tx_packets") + var txPackets: kotlin.Int? = null, + // Sent errors. Not used on Windows. This field is Linux-specific and always zero for Windows containers. + @Json(name = "tx_errors") + var txErrors: kotlin.Int? = null, + // Outgoing packets dropped. Windows and Linux. + @Json(name = "tx_dropped") + var txDropped: kotlin.Int? = null, + // Endpoint ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. + @Json(name = "endpoint_id") + var endpointId: kotlin.String? = null, + // Instance ID. Not used on Linux. This field is Windows-specific and omitted for Linux containers. + @Json(name = "instance_id") + var instanceId: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPidsStats.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPidsStats.kt new file mode 100644 index 00000000..6b5ef3fd --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPidsStats.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * PidsStats contains Linux-specific stats of a container's process-IDs (PIDs). This type is Linux-specific and omitted for Windows containers. + * + * @param current Current is the number of PIDs in the cgroup. + * @param limit Limit is the hard limit on the number of pids in the cgroup. A \"Limit\" of 0 means that there is no limit. + */ +@JsonClass(generateAdapter = true) +data class ContainerPidsStats( + // Current is the number of PIDs in the cgroup. + @Json(name = "current") + var current: kotlin.Int? = null, + // Limit is the hard limit on the number of pids in the cgroup. A \"Limit\" of 0 means that there is no limit. + @Json(name = "limit") + var limit: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt new file mode 100644 index 00000000..944ed8b5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param containersDeleted Container IDs that were deleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class ContainerPruneResponse( + // Container IDs that were deleted + @Json(name = "ContainersDeleted") + var containersDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt new file mode 100644 index 00000000..aa168c4c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt @@ -0,0 +1,101 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the \"inspect\" command. + * + * @param status String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". + * @param running Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". + * @param paused Whether this container is paused. + * @param restarting Whether this container is restarting. + * @param ooMKilled Whether a process within this container has been killed because it ran out of memory since the container was last started. + * @param dead + * @param pid The process ID of this container + * @param exitCode The last exit code of this container + * @param error + * @param startedAt The time when this container was last started. + * @param finishedAt The time when this container last exited. + * @param health + */ +@JsonClass(generateAdapter = true) +data class ContainerState( + // String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". + @Json(name = "Status") + var status: ContainerState.Status? = null, + // Whether this container is running. Note that a running container can be _paused_. The `Running` and `Paused` booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both `Running` _and_ `Paused`. Use the `Status` field instead to determine if a container's state is \"running\". + @Json(name = "Running") + var running: kotlin.Boolean? = null, + // Whether this container is paused. + @Json(name = "Paused") + var paused: kotlin.Boolean? = null, + // Whether this container is restarting. + @Json(name = "Restarting") + var restarting: kotlin.Boolean? = null, + // Whether a process within this container has been killed because it ran out of memory since the container was last started. + @Json(name = "OOMKilled") + var ooMKilled: kotlin.Boolean? = null, + @Json(name = "Dead") + var dead: kotlin.Boolean? = null, + // The process ID of this container + @Json(name = "Pid") + var pid: kotlin.Int? = null, + // The last exit code of this container + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, + @Json(name = "Error") + var error: kotlin.String? = null, + // The time when this container was last started. + @Json(name = "StartedAt") + var startedAt: kotlin.String? = null, + // The time when this container last exited. + @Json(name = "FinishedAt") + var finishedAt: kotlin.String? = null, + @Json(name = "Health") + var health: Health? = null, +) { + /** + * String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". + * + * Values: Created,Running,Paused,Restarting,Removing,Exited,Dead + */ + @JsonClass(generateAdapter = false) + enum class Status(val value: kotlin.String) { + @Json(name = "created") + Created("created"), + + @Json(name = "running") + Running("running"), + + @Json(name = "paused") + Paused("paused"), + + @Json(name = "restarting") + Restarting("restarting"), + + @Json(name = "removing") + Removing("removing"), + + @Json(name = "exited") + Exited("exited"), + + @Json(name = "dead") + Dead("dead"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatsResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatsResponse.kt new file mode 100644 index 00000000..a5983874 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatsResponse.kt @@ -0,0 +1,73 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Statistics sample for a container. + * + * @param id ID of the container for which the stats were collected. + * @param name Name of the container for which the stats were collected. + * @param osType OSType is the OS of the container (\"linux\" or \"windows\") to allow platform-specific handling of stats. + * @param read Date and time at which this sample was collected. The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. + * @param cpuStats + * @param memoryStats + * @param networks Network statistics for the container per interface. This field is omitted if the container has no networking enabled. + * @param pidsStats + * @param blkioStats + * @param numProcs The number of processors on the system. This field is Windows-specific and always zero for Linux containers. + * @param storageStats + * @param preread Date and time at which this first sample was collected. This field is not propagated if the \"one-shot\" option is set. If the \"one-shot\" option is set, this field may be omitted, empty, or set to a default date (`0001-01-01T00:00:00Z`). The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. + * @param precpuStats + */ +@JsonClass(generateAdapter = true) +data class ContainerStatsResponse( + // ID of the container for which the stats were collected. + @Json(name = "id") + var id: kotlin.String? = null, + // Name of the container for which the stats were collected. + @Json(name = "name") + var name: kotlin.String? = null, + // OSType is the OS of the container (\"linux\" or \"windows\") to allow platform-specific handling of stats. + @Json(name = "os_type") + var osType: kotlin.String? = null, + // Date and time at which this sample was collected. The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. + @Json(name = "read") + var read: java.time.OffsetDateTime? = null, + @Json(name = "cpu_stats") + var cpuStats: ContainerCPUStats? = null, + @Json(name = "memory_stats") + var memoryStats: ContainerMemoryStats? = null, + // Network statistics for the container per interface. This field is omitted if the container has no networking enabled. + @Json(name = "networks") + var networks: kotlin.Any? = null, + @Json(name = "pids_stats") + var pidsStats: ContainerPidsStats? = null, + @Json(name = "blkio_stats") + var blkioStats: ContainerBlkioStats? = null, + // The number of processors on the system. This field is Windows-specific and always zero for Linux containers. + @Json(name = "num_procs") + var numProcs: kotlin.Int? = null, + @Json(name = "storage_stats") + var storageStats: ContainerStorageStats? = null, + // Date and time at which this first sample was collected. This field is not propagated if the \"one-shot\" option is set. If the \"one-shot\" option is set, this field may be omitted, empty, or set to a default date (`0001-01-01T00:00:00Z`). The value is formatted as [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) with nano-seconds. + @Json(name = "preread") + var preread: java.time.OffsetDateTime? = null, + @Json(name = "precpu_stats") + var precpuStats: ContainerCPUStats? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt new file mode 100644 index 00000000..da1bef16 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStatus.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents the status of a container. + * + * @param containerID + * @param PID + * @param exitCode + */ +@JsonClass(generateAdapter = true) +data class ContainerStatus( + @Json(name = "ContainerID") + var containerID: kotlin.String? = null, + @Json(name = "PID") + var PID: kotlin.Int? = null, + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStorageStats.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStorageStats.kt new file mode 100644 index 00000000..6c095977 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerStorageStats.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * StorageStats is the disk I/O stats for read/write on Windows. This type is Windows-specific and omitted for Linux containers. + * + * @param readCountNormalized + * @param readSizeBytes + * @param writeCountNormalized + * @param writeSizeBytes + */ +@JsonClass(generateAdapter = true) +data class ContainerStorageStats( + @Json(name = "read_count_normalized") + var readCountNormalized: kotlin.Int? = null, + @Json(name = "read_size_bytes") + var readSizeBytes: kotlin.Int? = null, + @Json(name = "write_count_normalized") + var writeCountNormalized: kotlin.Int? = null, + @Json(name = "write_size_bytes") + var writeSizeBytes: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt new file mode 100644 index 00000000..996c7942 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt @@ -0,0 +1,120 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). + * @param names The names associated with this container. Most containers have a single name, but when using legacy \"links\", the container can have multiple names. For historic reasons, names are prefixed with a forward-slash (`/`). + * @param image The name or ID of the image used to create the container. This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., `docker.io/library/ubuntu:latest` or `docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`), short form (e.g., `ubuntu:latest`)), or the ID(-prefix) of the image (e.g., `72297848456d`). The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., `sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`). + * @param imageID The ID (digest) of the image that this container was created from. + * @param imageManifestDescriptor + * @param command Command to run when starting the container + * @param created Date and time at which the container was created as a Unix timestamp (number of seconds since EPOCH). + * @param ports Port-mappings for the container. + * @param sizeRw The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. + * @param sizeRootFs The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. + * @param labels User-defined key/value metadata. + * @param state The state of this container. + * @param status Additional human-readable status of this container (e.g. `Exit 0`) + * @param hostConfig + * @param networkSettings + * @param mounts List of mounts used by the container. + * @param health + */ +@JsonClass(generateAdapter = true) +data class ContainerSummary( + // The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes). + @Json(name = "Id") + var id: kotlin.String? = null, + // The names associated with this container. Most containers have a single name, but when using legacy \"links\", the container can have multiple names. For historic reasons, names are prefixed with a forward-slash (`/`). + @Json(name = "Names") + var names: kotlin.collections.MutableList? = null, + // The name or ID of the image used to create the container. This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., `docker.io/library/ubuntu:latest` or `docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`), short form (e.g., `ubuntu:latest`)), or the ID(-prefix) of the image (e.g., `72297848456d`). The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., `sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782`). + @Json(name = "Image") + var image: kotlin.String? = null, + // The ID (digest) of the image that this container was created from. + @Json(name = "ImageID") + var imageID: kotlin.String? = null, + @Json(name = "ImageManifestDescriptor") + var imageManifestDescriptor: OCIDescriptor? = null, + // Command to run when starting the container + @Json(name = "Command") + var command: kotlin.String? = null, + // Date and time at which the container was created as a Unix timestamp (number of seconds since EPOCH). + @Json(name = "Created") + var created: kotlin.Long? = null, + // Port-mappings for the container. + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, + // The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request. + @Json(name = "SizeRw") + var sizeRw: kotlin.Long? = null, + // The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request. + @Json(name = "SizeRootFs") + var sizeRootFs: kotlin.Long? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // The state of this container. + @Json(name = "State") + var state: ContainerSummary.State? = null, + // Additional human-readable status of this container (e.g. `Exit 0`) + @Json(name = "Status") + var status: kotlin.String? = null, + @Json(name = "HostConfig") + var hostConfig: ContainerSummaryHostConfig? = null, + @Json(name = "NetworkSettings") + var networkSettings: ContainerSummaryNetworkSettings? = null, + // List of mounts used by the container. + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + @Json(name = "Health") + var health: ContainerSummaryHealth? = null, +) { + /** + * The state of this container. + * + * Values: Created,Running,Paused,Restarting,Exited,Removing,Dead + */ + @JsonClass(generateAdapter = false) + enum class State(val value: kotlin.String) { + @Json(name = "created") + Created("created"), + + @Json(name = "running") + Running("running"), + + @Json(name = "paused") + Paused("paused"), + + @Json(name = "restarting") + Restarting("restarting"), + + @Json(name = "exited") + Exited("exited"), + + @Json(name = "removing") + Removing("removing"), + + @Json(name = "dead") + Dead("dead"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHealth.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHealth.kt new file mode 100644 index 00000000..40b1a737 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHealth.kt @@ -0,0 +1,55 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Summary of health status Added in v1.52, before that version all container summary not include Health. After this attribute introduced, it includes containers with no health checks configured, or containers that are not running with none + * + * @param status the health status of the container + * @param failingStreak FailingStreak is the number of consecutive failures + */ +@JsonClass(generateAdapter = true) +data class ContainerSummaryHealth( + // the health status of the container + @Json(name = "Status") + var status: ContainerSummaryHealth.Status? = null, + // FailingStreak is the number of consecutive failures + @Json(name = "FailingStreak") + var failingStreak: kotlin.Int? = null, +) { + /** + * the health status of the container + * + * Values: None,Starting,Healthy,Unhealthy + */ + @JsonClass(generateAdapter = false) + enum class Status(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "starting") + Starting("starting"), + + @Json(name = "healthy") + Healthy("healthy"), + + @Json(name = "unhealthy") + Unhealthy("unhealthy"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt new file mode 100644 index 00000000..3208ff09 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Summary of host-specific runtime information of the container. This is a reduced set of information in the container's \"HostConfig\" as available in the container \"inspect\" response. + * + * @param networkMode Networking mode (`host`, `none`, `container:`) or name of the primary network the container is using. This field is primarily for backward compatibility. The container can be connected to multiple networks for which information can be found in the `NetworkSettings.Networks` field, which enumerates settings per network. + * @param annotations Arbitrary key-value metadata attached to the container. + */ +@JsonClass(generateAdapter = true) +data class ContainerSummaryHostConfig( + // Networking mode (`host`, `none`, `container:`) or name of the primary network the container is using. This field is primarily for backward compatibility. The container can be connected to multiple networks for which information can be found in the `NetworkSettings.Networks` field, which enumerates settings per network. + @Json(name = "NetworkMode") + var networkMode: kotlin.String? = null, + // Arbitrary key-value metadata attached to the container. + @Json(name = "Annotations") + var annotations: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt new file mode 100644 index 00000000..8d7ba735 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Summary of the container's network settings + * + * @param networks Summary of network-settings for each network the container is attached to. + */ +@JsonClass(generateAdapter = true) +data class ContainerSummaryNetworkSettings( + // Summary of network-settings for each network the container is attached to. + @Json(name = "Networks") + var networks: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerThrottlingData.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerThrottlingData.kt new file mode 100644 index 00000000..4a68f3ea --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerThrottlingData.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * CPU throttling stats of the container. This type is Linux-specific and omitted for Windows containers. + * + * @param periods Number of periods with throttling active. + * @param throttledPeriods Number of periods when the container hit its throttling limit. + * @param throttledTime Aggregated time (in nanoseconds) the container was throttled for. + */ +@JsonClass(generateAdapter = true) +data class ContainerThrottlingData( + // Number of periods with throttling active. + @Json(name = "periods") + var periods: kotlin.Int? = null, + // Number of periods when the container hit its throttling limit. + @Json(name = "throttled_periods") + var throttledPeriods: kotlin.Int? = null, + // Aggregated time (in nanoseconds) the container was throttled for. + @Json(name = "throttled_time") + var throttledTime: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt new file mode 100644 index 00000000..14125a5e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Container \"top\" response. + * + * @param titles The ps column titles + * @param processes Each process running in the container, where each process is an array of values corresponding to the titles. + */ +@JsonClass(generateAdapter = true) +data class ContainerTopResponse( + // The ps column titles + @Json(name = "Titles") + var titles: kotlin.collections.MutableList? = null, + // Each process running in the container, where each process is an array of values corresponding to the titles. + @Json(name = "Processes") + var processes: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt new file mode 100644 index 00000000..953209d0 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt @@ -0,0 +1,150 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param cpuShares An integer value representing this container's relative CPU weight versus other containers. + * @param memory Memory limit in bytes. + * @param cgroupParent Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + * @param blkioWeight Block IO weight (relative weight). + * @param blkioWeightDevice Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + * @param blkioDeviceReadBps Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteBps Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceReadIOps Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteIOps Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param cpuPeriod The length of a CPU period in microseconds. + * @param cpuQuota Microseconds of CPU time that the container can get in a CPU period. + * @param cpuRealtimePeriod The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpuRealtimeRuntime The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpusetCpus CPUs in which to allow execution (e.g., `0-3`, `0,1`). + * @param cpusetMems Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + * @param devices A list of devices to add to the container. + * @param deviceCgroupRules a list of cgroup rules to apply to the container + * @param deviceRequests A list of requests for devices to be sent to device drivers. + * @param memoryReservation Memory soft limit in bytes. + * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + * @param nanoCpus CPU quota in units of 10-9 CPUs. + * @param oomKillDisable Disable OOM Killer for the container. + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param pidsLimit Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + * @param ulimits A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + * @param cpuCount The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param cpuPercent The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param ioMaximumIOps Maximum IOps for the container system drive (Windows only) + * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). + * @param restartPolicy + */ +@JsonClass(generateAdapter = true) +data class ContainerUpdateRequest( + // An integer value representing this container's relative CPU weight versus other containers. + @Json(name = "CpuShares") + var cpuShares: kotlin.Int? = null, + // Memory limit in bytes. + @Json(name = "Memory") + var memory: kotlin.Long? = 0L, + // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + @Json(name = "CgroupParent") + var cgroupParent: kotlin.String? = null, + // Block IO weight (relative weight). + @Json(name = "BlkioWeight") + var blkioWeight: kotlin.Int? = null, + // Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + @Json(name = "BlkioWeightDevice") + var blkioWeightDevice: kotlin.collections.MutableList? = null, + // Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadBps") + var blkioDeviceReadBps: kotlin.collections.MutableList? = null, + // Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteBps") + var blkioDeviceWriteBps: kotlin.collections.MutableList? = null, + // Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadIOps") + var blkioDeviceReadIOps: kotlin.collections.MutableList? = null, + // Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteIOps") + var blkioDeviceWriteIOps: kotlin.collections.MutableList? = null, + // The length of a CPU period in microseconds. + @Json(name = "CpuPeriod") + var cpuPeriod: kotlin.Long? = null, + // Microseconds of CPU time that the container can get in a CPU period. + @Json(name = "CpuQuota") + var cpuQuota: kotlin.Long? = null, + // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimePeriod") + var cpuRealtimePeriod: kotlin.Long? = null, + // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimeRuntime") + var cpuRealtimeRuntime: kotlin.Long? = null, + // CPUs in which to allow execution (e.g., `0-3`, `0,1`). + @Json(name = "CpusetCpus") + var cpusetCpus: kotlin.String? = null, + // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + @Json(name = "CpusetMems") + var cpusetMems: kotlin.String? = null, + // A list of devices to add to the container. + @Json(name = "Devices") + var devices: kotlin.collections.MutableList? = null, + // a list of cgroup rules to apply to the container + @Json(name = "DeviceCgroupRules") + var deviceCgroupRules: kotlin.collections.MutableList? = null, + // A list of requests for devices to be sent to device drivers. + @Json(name = "DeviceRequests") + var deviceRequests: kotlin.collections.MutableList? = null, + // Memory soft limit in bytes. + @Json(name = "MemoryReservation") + var memoryReservation: kotlin.Long? = null, + // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + @Json(name = "MemorySwap") + var memorySwap: kotlin.Long? = null, + // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, + // CPU quota in units of 10-9 CPUs. + @Json(name = "NanoCpus") + var nanoCpus: kotlin.Long? = null, + // Disable OOM Killer for the container. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Long? = null, + // A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, + // The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuCount") + var cpuCount: kotlin.Long? = null, + // The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuPercent") + var cpuPercent: kotlin.Long? = null, + // Maximum IOps for the container system drive (Windows only) + @Json(name = "IOMaximumIOps") + var ioMaximumIOps: kotlin.Long? = null, + // Maximum IO in bytes per second for the container system drive (Windows only). + @Json(name = "IOMaximumBandwidth") + var ioMaximumBandwidth: kotlin.Long? = null, + @Json(name = "RestartPolicy") + var restartPolicy: RestartPolicy? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt new file mode 100644 index 00000000..85e282a0 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Response for a successful container-update. + * + * @param warnings Warnings encountered when updating the container. + */ +@JsonClass(generateAdapter = true) +data class ContainerUpdateResponse( + // Warnings encountered when updating the container. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt new file mode 100644 index 00000000..e58142f7 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * container waiting error, if any + * + * @param message Details of an error + */ +@JsonClass(generateAdapter = true) +data class ContainerWaitExitError( + // Details of an error + @Json(name = "Message") + var message: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt new file mode 100644 index 00000000..68d6dd7b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to ContainerWait operation + * + * @param statusCode Exit code of the container + * @param error + */ +@JsonClass(generateAdapter = true) +data class ContainerWaitResponse( + // Exit code of the container + @Json(name = "StatusCode") + var statusCode: kotlin.Long, + @Json(name = "Error") + var error: ContainerWaitExitError? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfo.kt new file mode 100644 index 00000000..f98b99d9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfo.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information for connecting to the containerd instance that is used by the daemon. This is included for debugging purposes only. + * + * @param address The address of the containerd socket. + * @param namespaces + */ +@JsonClass(generateAdapter = true) +data class ContainerdInfo( + // The address of the containerd socket. + @Json(name = "Address") + var address: kotlin.String? = null, + @Json(name = "Namespaces") + var namespaces: ContainerdInfoNamespaces? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfoNamespaces.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfoNamespaces.kt new file mode 100644 index 00000000..739dcf34 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainerdInfoNamespaces.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The namespaces that the daemon uses for running containers and plugins in containerd. These namespaces can be configured in the daemon configuration, and are considered to be used exclusively by the daemon, Tampering with the containerd instance may cause unexpected behavior. As these namespaces are considered to be exclusively accessed by the daemon, it is not recommended to change these values, or to change them to a value that is used by other systems, such as cri-containerd. + * + * @param containers The default containerd namespace used for containers managed by the daemon. The default namespace for containers is \"moby\", but will be suffixed with the `.` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. + * @param plugins The default containerd namespace used for plugins managed by the daemon. The default namespace for plugins is \"plugins.moby\", but will be suffixed with the `.` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. + */ +@JsonClass(generateAdapter = true) +data class ContainerdInfoNamespaces( + // The default containerd namespace used for containers managed by the daemon. The default namespace for containers is \"moby\", but will be suffixed with the `.` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. + @Json(name = "Containers") + var containers: kotlin.String? = "moby", + // The default containerd namespace used for plugins managed by the daemon. The default namespace for plugins is \"plugins.moby\", but will be suffixed with the `.` of the remapped `root` if user-namespaces are enabled and the containerd image-store is used. + @Json(name = "Plugins") + var plugins: kotlin.String? = "plugins.moby", +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainersDiskUsage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainersDiskUsage.kt new file mode 100644 index 00000000..8a963411 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ContainersDiskUsage.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents system data usage information for container resources. + * + * @param activeCount Count of active containers. + * @param totalCount Count of all containers. + * @param reclaimable Disk space that can be reclaimed by removing inactive containers. + * @param totalSize Disk space in use by containers. + * @param items List of container summaries. + */ +@JsonClass(generateAdapter = true) +data class ContainersDiskUsage( + // Count of active containers. + @Json(name = "ActiveCount") + var activeCount: kotlin.Long? = null, + // Count of all containers. + @Json(name = "TotalCount") + var totalCount: kotlin.Long? = null, + // Disk space that can be reclaimed by removing inactive containers. + @Json(name = "Reclaimable") + var reclaimable: kotlin.Long? = null, + // Disk space in use by containers. + @Json(name = "TotalSize") + var totalSize: kotlin.Long? = null, + // List of container summaries. + @Json(name = "Items") + var items: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt new file mode 100644 index 00000000..e0c22ccf --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id + * @param errorDetail + * @param status + * @param progressDetail + */ +@JsonClass(generateAdapter = true) +data class CreateImageInfo( + @Json(name = "id") + var id: kotlin.String? = null, + @Json(name = "errorDetail") + var errorDetail: ErrorDetail? = null, + @Json(name = "status") + var status: kotlin.String? = null, + @Json(name = "progressDetail") + var progressDetail: ProgressDetail? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceInfo.kt new file mode 100644 index 00000000..e09ab996 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceInfo.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * DeviceInfo represents a device that can be used by a container. + * + * @param source The origin device driver. + * @param ID The unique identifier for the device within its source driver. For CDI devices, this would be an FQDN like \"vendor.com/gpu=0\". + */ +@JsonClass(generateAdapter = true) +data class DeviceInfo( + // The origin device driver. + @Json(name = "Source") + var source: kotlin.String? = null, + // The unique identifier for the device within its source driver. For CDI devices, this would be an FQDN like \"vendor.com/gpu=0\". + @Json(name = "ID") + var ID: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt new file mode 100644 index 00000000..72ca8fdb --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A device mapping between the host and container + * + * @param pathOnHost + * @param pathInContainer + * @param cgroupPermissions + */ +@JsonClass(generateAdapter = true) +data class DeviceMapping( + @Json(name = "PathOnHost") + var pathOnHost: kotlin.String? = null, + @Json(name = "PathInContainer") + var pathInContainer: kotlin.String? = null, + @Json(name = "CgroupPermissions") + var cgroupPermissions: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt new file mode 100644 index 00000000..0aabbf83 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A request for devices to be sent to device drivers + * + * @param driver The name of the device driver to use for this request. Note that if this is specified the capabilities are ignored when selecting a device driver. + * @param count + * @param deviceIDs + * @param capabilities A list of capabilities; an OR list of AND lists of capabilities. Note that if a driver is specified the capabilities have no effect on selecting a driver as the driver name is used directly. Note that if no driver is specified the capabilities are used to select a driver with the required capabilities. + * @param options Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. + */ +@JsonClass(generateAdapter = true) +data class DeviceRequest( + // The name of the device driver to use for this request. Note that if this is specified the capabilities are ignored when selecting a device driver. + @Json(name = "Driver") + var driver: kotlin.String? = null, + @Json(name = "Count") + var count: kotlin.Int? = null, + @Json(name = "DeviceIDs") + var deviceIDs: kotlin.collections.MutableList? = null, + // A list of capabilities; an OR list of AND lists of capabilities. Note that if a driver is specified the capabilities have no effect on selecting a driver as the driver name is used directly. Note that if no driver is specified the capabilities are used to select a driver with the required capabilities. + @Json(name = "Capabilities") + var capabilities: kotlin.collections.MutableList>? = null, + // Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt new file mode 100644 index 00000000..845598dd --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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 DistributionInspect( + @Json(name = "Descriptor") + var descriptor: OCIDescriptor, + // An array containing all platforms supported by the image. + @Json(name = "Platforms") + var platforms: kotlin.collections.MutableList, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt new file mode 100644 index 00000000..a4f83256 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Driver represents a driver (network, logging, secrets). + * + * @param name Name of the driver. + * @param options Key/value map of driver-specific options. + */ +@JsonClass(generateAdapter = true) +data class Driver( + // Name of the driver. + @Json(name = "Name") + var name: kotlin.String, + // Key/value map of driver-specific options. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DriverData.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DriverData.kt new file mode 100644 index 00000000..4d3278ae --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/DriverData.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the storage driver used to store the container's and image's filesystem. + * + * @param name Name of the storage driver. + * @param `data` Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. + */ +@JsonClass(generateAdapter = true) +data class DriverData( + // Name of the storage driver. + @Json(name = "Name") + var name: kotlin.String, + // Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. + @Json(name = "Data") + var `data`: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt new file mode 100644 index 00000000..12dfe787 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * EndpointIPAMConfig represents an endpoint's IPAM configuration. + * + * @param ipv4Address + * @param ipv6Address + * @param linkLocalIPs + */ +@JsonClass(generateAdapter = true) +data class EndpointIPAMConfig( + @Json(name = "IPv4Address") + var ipv4Address: kotlin.String? = null, + @Json(name = "IPv6Address") + var ipv6Address: kotlin.String? = null, + @Json(name = "LinkLocalIPs") + var linkLocalIPs: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt new file mode 100644 index 00000000..983ff67f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt @@ -0,0 +1,76 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param protocol + * @param targetPort The port inside the container. + * @param publishedPort The port on the swarm hosts. + * @param publishMode The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. + */ +@JsonClass(generateAdapter = true) +data class EndpointPortConfig( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "Protocol") + var protocol: EndpointPortConfig.Protocol? = null, + // The port inside the container. + @Json(name = "TargetPort") + var targetPort: kotlin.Int? = null, + // The port on the swarm hosts. + @Json(name = "PublishedPort") + var publishedPort: kotlin.Int? = null, + // The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. + @Json(name = "PublishMode") + var publishMode: EndpointPortConfig.PublishMode? = PublishMode.Ingress, +) { + /** + * + * + * Values: Tcp,Udp,Sctp + */ + @JsonClass(generateAdapter = false) + enum class Protocol(val value: kotlin.String) { + @Json(name = "tcp") + Tcp("tcp"), + + @Json(name = "udp") + Udp("udp"), + + @Json(name = "sctp") + Sctp("sctp"), + } + + /** + * The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. + * + * Values: Ingress,Host + */ + @JsonClass(generateAdapter = false) + enum class PublishMode(val value: kotlin.String) { + @Json(name = "ingress") + Ingress("ingress"), + + @Json(name = "host") + Host("host"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointResource.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointResource.kt new file mode 100644 index 00000000..d6b12738 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointResource.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * contains network resources allocated and used for a container in a network. + * + * @param name + * @param endpointID + * @param macAddress + * @param ipv4Address + * @param ipv6Address + */ +@JsonClass(generateAdapter = true) +data class EndpointResource( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "EndpointID") + var endpointID: kotlin.String? = null, + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + @Json(name = "IPv4Address") + var ipv4Address: kotlin.String? = null, + @Json(name = "IPv6Address") + var ipv6Address: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt new file mode 100644 index 00000000..e98967be --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt @@ -0,0 +1,84 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Configuration for a network endpoint. + * + * @param ipAMConfig + * @param links + * @param macAddress MAC address for the endpoint on this network. The network driver might ignore this parameter. + * @param aliases + * @param driverOpts DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. + * @param gwPriority This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked. + * @param networkID Unique ID of the network. + * @param endpointID Unique ID for the service endpoint in a Sandbox. + * @param gateway Gateway address for this network. + * @param ipAddress IPv4 address. + * @param ipPrefixLen Mask length of the IPv4 address. + * @param ipv6Gateway IPv6 gateway address. + * @param globalIPv6Address Global IPv6 address. + * @param globalIPv6PrefixLen Mask length of the global IPv6 address. + * @param dnSNames List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. + */ +@JsonClass(generateAdapter = true) +data class EndpointSettings( + @Json(name = "IPAMConfig") + var ipAMConfig: EndpointIPAMConfig? = null, + @Json(name = "Links") + var links: kotlin.collections.MutableList? = null, + // MAC address for the endpoint on this network. The network driver might ignore this parameter. + @Json(name = "MacAddress") + var macAddress: kotlin.String? = null, + @Json(name = "Aliases") + var aliases: kotlin.collections.MutableList? = null, + // DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. + @Json(name = "DriverOpts") + var driverOpts: kotlin.collections.MutableMap? = null, + // This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked. + @Json(name = "GwPriority") + var gwPriority: kotlin.Long? = null, + // Unique ID of the network. + @Json(name = "NetworkID") + var networkID: kotlin.String? = null, + // Unique ID for the service endpoint in a Sandbox. + @Json(name = "EndpointID") + var endpointID: kotlin.String? = null, + // Gateway address for this network. + @Json(name = "Gateway") + var gateway: kotlin.String? = null, + // IPv4 address. + @Json(name = "IPAddress") + var ipAddress: kotlin.String? = null, + // Mask length of the IPv4 address. + @Json(name = "IPPrefixLen") + var ipPrefixLen: kotlin.Int? = null, + // IPv6 gateway address. + @Json(name = "IPv6Gateway") + var ipv6Gateway: kotlin.String? = null, + // Global IPv6 address. + @Json(name = "GlobalIPv6Address") + var globalIPv6Address: kotlin.String? = null, + // Mask length of the global IPv6 address. + @Json(name = "GlobalIPv6PrefixLen") + var globalIPv6PrefixLen: kotlin.Long? = null, + // List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending `.`. For instance, if container name is `my.ctr` and the network is named `testnet`, `DNSNames` will contain `my.ctr` and the FQDN will be `my.ctr.testnet`. + @Json(name = "DNSNames") + var dnSNames: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt new file mode 100644 index 00000000..a9887b7a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt @@ -0,0 +1,49 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Properties that can be configured to access and load balance a service. + * + * @param mode The mode of resolution to use for internal load balancing between tasks. + * @param ports List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. + */ +@JsonClass(generateAdapter = true) +data class EndpointSpec( + // The mode of resolution to use for internal load balancing between tasks. + @Json(name = "Mode") + var mode: EndpointSpec.Mode? = Mode.Vip, + // List of exposed ports that this service is accessible on from the outside. Ports can only be provided if `vip` resolution mode is used. + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, +) { + /** + * The mode of resolution to use for internal load balancing between tasks. + * + * Values: Vip,Dnsrr + */ + @JsonClass(generateAdapter = false) + enum class Mode(val value: kotlin.String) { + @Json(name = "vip") + Vip("vip"), + + @Json(name = "dnsrr") + Dnsrr("dnsrr"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt new file mode 100644 index 00000000..f16ef09c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * EngineDescription provides information about an engine. + * + * @param engineVersion + * @param labels + * @param plugins + */ +@JsonClass(generateAdapter = true) +data class EngineDescription( + @Json(name = "EngineVersion") + var engineVersion: kotlin.String? = null, + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Plugins") + var plugins: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt new file mode 100644 index 00000000..e6c9f02c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param type + * @param name + */ +@JsonClass(generateAdapter = true) +data class EngineDescriptionPluginsInner( + @Json(name = "Type") + var type: kotlin.String? = null, + @Json(name = "Name") + var name: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt new file mode 100644 index 00000000..fa5fdb13 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param code + * @param message + */ +@JsonClass(generateAdapter = true) +data class ErrorDetail( + @Json(name = "code") + var code: kotlin.Int? = null, + @Json(name = "message") + var message: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt new file mode 100644 index 00000000..facdf1d2 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Represents an error. + * + * @param message The error message. + */ +@JsonClass(generateAdapter = true) +data class ErrorResponse( + // The error message. + @Json(name = "message") + var message: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt new file mode 100644 index 00000000..e391e21b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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. + */ +@JsonClass(generateAdapter = true) +data class EventActor( + // The ID of the object emitting the event + @Json(name = "ID") + var ID: kotlin.String? = null, + // Various key/value attributes of the object, depending on its type. + @Json(name = "Attributes") + var attributes: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt new file mode 100644 index 00000000..d43978a0 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt @@ -0,0 +1,105 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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 EventMessage( + // The type of object emitting the event + @Json(name = "Type") + var type: EventMessage.Type? = null, + // The type of event + @Json(name = "Action") + var action: kotlin.String? = null, + @Json(name = "Actor") + var actor: EventActor? = null, + // Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. + @Json(name = "scope") + var scope: EventMessage.Scope? = null, + // Timestamp of event + @Json(name = "time") + var time: kotlin.Long? = null, + // Timestamp of event, with nanosecond accuracy + @Json(name = "timeNano") + var timeNano: kotlin.Long? = null, +) { + /** + * The type of object emitting the event + * + * Values: Builder,Config,Container,Daemon,Image,Network,Node,Plugin,Secret,Service,Volume + */ + @JsonClass(generateAdapter = false) + 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 + */ + @JsonClass(generateAdapter = false) + enum class Scope(val value: kotlin.String) { + @Json(name = "local") + Local("local"), + + @Json(name = "swarm") + Swarm("swarm"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt new file mode 100644 index 00000000..26059794 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt @@ -0,0 +1,71 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +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 consoleSize Initial console size, as an `[height, width]` array. + * @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") + var attachStdin: kotlin.Boolean? = null, + // Attach to `stdout` of the exec command. + @Json(name = "AttachStdout") + var attachStdout: kotlin.Boolean? = null, + // Attach to `stderr` of the exec command. + @Json(name = "AttachStderr") + var attachStderr: kotlin.Boolean? = null, + // Initial console size, as an `[height, width]` array. + @Json(name = "ConsoleSize") + var consoleSize: kotlin.collections.MutableList? = 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") + var detachKeys: kotlin.String? = null, + // Allocate a pseudo-TTY. + @Json(name = "Tty") + var tty: kotlin.Boolean? = null, + // A list of environment variables in the form `[\"VAR=value\", ...]`. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run, as a string or array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + // Runs the exec process with extended privileges. + @Json(name = "Privileged") + var privileged: kotlin.Boolean? = false, + // 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") + var user: kotlin.String? = null, + // The working directory for the exec process inside the container. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt new file mode 100644 index 00000000..a41fb785 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt @@ -0,0 +1,61 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param canRemove + * @param detachKeys + * @param ID + * @param running + * @param exitCode + * @param processConfig + * @param openStdin + * @param openStderr + * @param openStdout + * @param containerID + * @param pid The system process ID for the exec process. + */ +@JsonClass(generateAdapter = true) +data class ExecInspectResponse( + @Json(name = "CanRemove") + var canRemove: kotlin.Boolean? = null, + @Json(name = "DetachKeys") + var detachKeys: kotlin.String? = null, + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Running") + var running: kotlin.Boolean? = null, + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, + @Json(name = "ProcessConfig") + var processConfig: ProcessConfig? = null, + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = null, + @Json(name = "OpenStderr") + var openStderr: kotlin.Boolean? = null, + @Json(name = "OpenStdout") + var openStdout: kotlin.Boolean? = null, + @Json(name = "ContainerID") + var containerID: kotlin.String? = null, + // The system process ID for the exec process. + @Json(name = "Pid") + var pid: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt new file mode 100644 index 00000000..a9961553 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param detach Detach from the command. + * @param tty Allocate a pseudo-TTY. + * @param consoleSize Initial console size, as an `[height, width]` array. + */ +@JsonClass(generateAdapter = true) +data class ExecStartConfig( + // Detach from the command. + @Json(name = "Detach") + var detach: kotlin.Boolean? = null, + // Allocate a pseudo-TTY. + @Json(name = "Tty") + var tty: kotlin.Boolean? = null, + // Initial console size, as an `[height, width]` array. + @Json(name = "ConsoleSize") + var consoleSize: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt new file mode 100644 index 00000000..a5a03b95 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/FilesystemChange.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Change in the container's filesystem. + * + * @param path Path to file or directory that has changed. + * @param kind + */ +@JsonClass(generateAdapter = true) +data class FilesystemChange( + // Path to file or directory that has changed. + @Json(name = "Path") + var path: kotlin.String, + @Json(name = "Kind") + var kind: ChangeType, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/FirewallInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/FirewallInfo.kt new file mode 100644 index 00000000..df214820 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/FirewallInfo.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the daemon's firewalling configuration. This field is currently only used on Linux, and omitted on other platforms. + * + * @param driver The name of the firewall backend driver. + * @param info Information about the firewall backend, provided as \"label\" / \"value\" pairs.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + */ +@JsonClass(generateAdapter = true) +data class FirewallInfo( + // The name of the firewall backend driver. + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Information about the firewall backend, provided as \"label\" / \"value\" pairs.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + @Json(name = "Info") + var info: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt new file mode 100644 index 00000000..9224058e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param namedResourceSpec + * @param discreteResourceSpec + */ +@JsonClass(generateAdapter = true) +data class GenericResourcesInner( + @Json(name = "NamedResourceSpec") + var namedResourceSpec: GenericResourcesInnerNamedResourceSpec? = null, + @Json(name = "DiscreteResourceSpec") + var discreteResourceSpec: GenericResourcesInnerDiscreteResourceSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt new file mode 100644 index 00000000..7cb81d23 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param kind + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class GenericResourcesInnerDiscreteResourceSpec( + @Json(name = "Kind") + var kind: kotlin.String? = null, + @Json(name = "Value") + var `value`: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt new file mode 100644 index 00000000..3de0fa30 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param kind + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class GenericResourcesInnerNamedResourceSpec( + @Json(name = "Kind") + var kind: kotlin.String? = null, + @Json(name = "Value") + var `value`: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt new file mode 100644 index 00000000..87142b26 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Health stores information about the container's healthcheck results. + * + * @param status Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem + * @param failingStreak FailingStreak is the number of consecutive failures + * @param log Log contains the last few results (oldest first) + */ +@JsonClass(generateAdapter = true) +data class Health( + // Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem + @Json(name = "Status") + var status: Health.Status? = null, + // FailingStreak is the number of consecutive failures + @Json(name = "FailingStreak") + var failingStreak: kotlin.Int? = null, + // Log contains the last few results (oldest first) + @Json(name = "Log") + var log: kotlin.collections.MutableList? = null, +) { + /** + * Status is one of `none`, `starting`, `healthy` or `unhealthy` - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem + * + * Values: None,Starting,Healthy,Unhealthy + */ + @JsonClass(generateAdapter = false) + enum class Status(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "starting") + Starting("starting"), + + @Json(name = "healthy") + Healthy("healthy"), + + @Json(name = "unhealthy") + Unhealthy("unhealthy"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt new file mode 100644 index 00000000..4e22085f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A test to perform to check that the container is healthy. + * + * @param test The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell + * @param interval The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + * @param timeout The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + * @param retries The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. + * @param startPeriod Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + * @param startInterval The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + */ +@JsonClass(generateAdapter = true) +data class HealthConfig( + // The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `[\"NONE\"]` disable healthcheck - `[\"CMD\", args...]` exec arguments directly - `[\"CMD-SHELL\", command]` run command with system's default shell + @Json(name = "Test") + var test: kotlin.collections.MutableList? = null, + // The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "Interval") + var interval: kotlin.Long? = null, + // The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "Timeout") + var timeout: kotlin.Long? = null, + // The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. + @Json(name = "Retries") + var retries: kotlin.Int? = null, + // Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "StartPeriod") + var startPeriod: kotlin.Long? = null, + // The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. + @Json(name = "StartInterval") + var startInterval: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt new file mode 100644 index 00000000..73ef988e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * HealthcheckResult stores information about a single run of a healthcheck probe + * + * @param start Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param end Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param exitCode ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe + * @param output Output from last check + */ +@JsonClass(generateAdapter = true) +data class HealthcheckResult( + // Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Start") + var start: java.time.OffsetDateTime? = null, + // Date and time at which this check ended in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "End") + var end: kotlin.String? = null, + // ExitCode meanings: - `0` healthy - `1` unhealthy - `2` reserved (considered unhealthy) - other values: error running probe + @Json(name = "ExitCode") + var exitCode: kotlin.Int? = null, + // Output from last check + @Json(name = "Output") + var output: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt new file mode 100644 index 00000000..55f0c7fb --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * individual image layer information in response to ImageHistory operation + * + * @param id + * @param created + * @param createdBy + * @param tags + * @param propertySize + * @param comment + */ +@JsonClass(generateAdapter = true) +data class HistoryResponseItem( + @Json(name = "Id") + var id: kotlin.String, + @Json(name = "Created") + var created: kotlin.Long, + @Json(name = "CreatedBy") + var createdBy: kotlin.String, + @Json(name = "Tags") + var tags: kotlin.collections.MutableList?, + @Json(name = "Size") + var propertySize: kotlin.Long, + @Json(name = "Comment") + var comment: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt new file mode 100644 index 00000000..ebe58e6f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt @@ -0,0 +1,335 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Container configuration that depends on the host we are running on + * + * @param cpuShares An integer value representing this container's relative CPU weight versus other containers. + * @param memory Memory limit in bytes. + * @param cgroupParent Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + * @param blkioWeight Block IO weight (relative weight). + * @param blkioWeightDevice Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + * @param blkioDeviceReadBps Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteBps Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceReadIOps Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteIOps Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param cpuPeriod The length of a CPU period in microseconds. + * @param cpuQuota Microseconds of CPU time that the container can get in a CPU period. + * @param cpuRealtimePeriod The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpuRealtimeRuntime The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpusetCpus CPUs in which to allow execution (e.g., `0-3`, `0,1`). + * @param cpusetMems Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + * @param devices A list of devices to add to the container. + * @param deviceCgroupRules a list of cgroup rules to apply to the container + * @param deviceRequests A list of requests for devices to be sent to device drivers. + * @param memoryReservation Memory soft limit in bytes. + * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + * @param nanoCpus CPU quota in units of 10-9 CPUs. + * @param oomKillDisable Disable OOM Killer for the container. + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param pidsLimit Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + * @param ulimits A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + * @param cpuCount The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param cpuPercent The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param ioMaximumIOps Maximum IOps for the container system drive (Windows only) + * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). + * @param binds A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. + * @param containerIDFile Path to a file where the container ID is written + * @param logConfig + * @param networkMode Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:`. Any other value is taken as a custom network's name to which this container should connect to. + * @param portBindings PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + * @param restartPolicy + * @param autoRemove Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. + * @param volumeDriver Driver that this container uses to mount volumes. + * @param volumesFrom A list of volumes to inherit from another container, specified in the form `[:]`. + * @param mounts Specification for mounts to be added to the container. + * @param consoleSize Initial console size, as an `[height, width]` array. + * @param annotations Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. + * @param capAdd A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. + * @param capDrop A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. + * @param cgroupnsMode cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. + * @param dns A list of DNS servers for the container to use. + * @param dnsOptions A list of DNS options. + * @param dnsSearch A list of DNS search domains. + * @param extraHosts A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. + * @param groupAdd A list of additional groups that the container process will run as. + * @param ipcMode IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. + * @param cgroup Cgroup to use for the container. + * @param links A list of links for the container in the form `container_name:alias`. + * @param oomScoreAdj An integer value containing the score given to the container in order to tune OOM killer preferences. + * @param pidMode Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container + * @param privileged Gives the container full access to the host. + * @param publishAllPorts Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. + * @param readonlyRootfs Mount the container's root filesystem as read only. + * @param securityOpt A list of string values to customize labels for MLS systems, such as SELinux. + * @param storageOpt Storage driver options for this container, in the form `{\"size\": \"120G\"}`. + * @param tmpfs A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` + * @param utSMode UTS namespace to use for the container. + * @param usernsMode Sets the usernamespace mode for the container when usernamespace remapping option is enabled. + * @param shmSize Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. + * @param sysctls A list of kernel parameters (sysctls) to set in the container. This field is omitted if not set. + * @param runtime Runtime to use with this container. + * @param isolation Isolation technology of the container. (Windows only) + * @param maskedPaths The list of paths to be masked inside the container (this overrides the default set of paths). + * @param readonlyPaths The list of paths to be set as read-only inside the container (this overrides the default set of paths). + */ +@JsonClass(generateAdapter = true) +data class HostConfig( + // An integer value representing this container's relative CPU weight versus other containers. + @Json(name = "CpuShares") + var cpuShares: kotlin.Int? = null, + // Memory limit in bytes. + @Json(name = "Memory") + var memory: kotlin.Long? = 0L, + // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + @Json(name = "CgroupParent") + var cgroupParent: kotlin.String? = null, + // Block IO weight (relative weight). + @Json(name = "BlkioWeight") + var blkioWeight: kotlin.Int? = null, + // Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + @Json(name = "BlkioWeightDevice") + var blkioWeightDevice: kotlin.collections.MutableList? = null, + // Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadBps") + var blkioDeviceReadBps: kotlin.collections.MutableList? = null, + // Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteBps") + var blkioDeviceWriteBps: kotlin.collections.MutableList? = null, + // Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadIOps") + var blkioDeviceReadIOps: kotlin.collections.MutableList? = null, + // Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteIOps") + var blkioDeviceWriteIOps: kotlin.collections.MutableList? = null, + // The length of a CPU period in microseconds. + @Json(name = "CpuPeriod") + var cpuPeriod: kotlin.Long? = null, + // Microseconds of CPU time that the container can get in a CPU period. + @Json(name = "CpuQuota") + var cpuQuota: kotlin.Long? = null, + // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimePeriod") + var cpuRealtimePeriod: kotlin.Long? = null, + // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimeRuntime") + var cpuRealtimeRuntime: kotlin.Long? = null, + // CPUs in which to allow execution (e.g., `0-3`, `0,1`). + @Json(name = "CpusetCpus") + var cpusetCpus: kotlin.String? = null, + // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + @Json(name = "CpusetMems") + var cpusetMems: kotlin.String? = null, + // A list of devices to add to the container. + @Json(name = "Devices") + var devices: kotlin.collections.MutableList? = null, + // a list of cgroup rules to apply to the container + @Json(name = "DeviceCgroupRules") + var deviceCgroupRules: kotlin.collections.MutableList? = null, + // A list of requests for devices to be sent to device drivers. + @Json(name = "DeviceRequests") + var deviceRequests: kotlin.collections.MutableList? = null, + // Memory soft limit in bytes. + @Json(name = "MemoryReservation") + var memoryReservation: kotlin.Long? = null, + // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + @Json(name = "MemorySwap") + var memorySwap: kotlin.Long? = null, + // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, + // CPU quota in units of 10-9 CPUs. + @Json(name = "NanoCpus") + var nanoCpus: kotlin.Long? = null, + // Disable OOM Killer for the container. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Long? = null, + // A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, + // The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuCount") + var cpuCount: kotlin.Long? = null, + // The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuPercent") + var cpuPercent: kotlin.Long? = null, + // Maximum IOps for the container system drive (Windows only) + @Json(name = "IOMaximumIOps") + var ioMaximumIOps: kotlin.Long? = null, + // Maximum IO in bytes per second for the container system drive (Windows only). + @Json(name = "IOMaximumBandwidth") + var ioMaximumBandwidth: kotlin.Long? = null, + // A list of volume bindings for this container. Each volume binding is a string in one of these forms: - `host-src:container-dest[:options]` to bind-mount a host path into the container. Both `host-src`, and `container-dest` must be an _absolute_ path. - `volume-name:container-dest[:options]` to bind-mount a volume managed by a volume driver into the container. `container-dest` must be an _absolute_ path. `options` is an optional, comma-delimited list of: - `nocopy` disables automatic copying of data from the container path to the volume. The `nocopy` flag only applies to named volumes. - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or set to `rw`, volumes are mounted read-write. - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read and write to the same volume. - `z`: a _shared_ content label is applied to the content. This label indicates that multiple containers can share the volume content, for both reading and writing. - `Z`: a _private unshared_ label is applied to the content. This label indicates that only the current container can use a private volume. Labeling systems such as SELinux require proper labels to be placed on volume content that is mounted into a container. Without a label, the security system can prevent a container's processes from using the content. By default, the labels set by the host operating system are not modified. - `[[r]shared|[r]slave|[r]private]` specifies mount [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt). This only applies to bind-mounted volumes, not internal volumes or named volumes. Mount propagation requires the source mount point (the location where the source directory is mounted in the host operating system) to have the correct propagation properties. For shared volumes, the source mount point must be set to `shared`. For slave volumes, the mount must be set to either `shared` or `slave`. + @Json(name = "Binds") + var binds: kotlin.collections.MutableList? = null, + // Path to a file where the container ID is written + @Json(name = "ContainerIDFile") + var containerIDFile: kotlin.String? = null, + @Json(name = "LogConfig") + var logConfig: HostConfigAllOfLogConfig? = null, + // Network mode to use for this container. Supported standard values are: `bridge`, `host`, `none`, and `container:`. Any other value is taken as a custom network's name to which this container should connect to. + @Json(name = "NetworkMode") + var networkMode: kotlin.String? = null, + // PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + @Json(name = "PortBindings") + var portBindings: kotlin.collections.MutableMap>? = null, + @Json(name = "RestartPolicy") + var restartPolicy: RestartPolicy? = null, + // Automatically remove the container when the container's process exits. This has no effect if `RestartPolicy` is set. + @Json(name = "AutoRemove") + var autoRemove: kotlin.Boolean? = null, + // Driver that this container uses to mount volumes. + @Json(name = "VolumeDriver") + var volumeDriver: kotlin.String? = null, + // A list of volumes to inherit from another container, specified in the form `[:]`. + @Json(name = "VolumesFrom") + var volumesFrom: kotlin.collections.MutableList? = null, + // Specification for mounts to be added to the container. + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + // Initial console size, as an `[height, width]` array. + @Json(name = "ConsoleSize") + var consoleSize: kotlin.collections.MutableList? = null, + // Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. + @Json(name = "Annotations") + var annotations: kotlin.collections.MutableMap? = null, + // A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. + @Json(name = "CapAdd") + var capAdd: kotlin.collections.MutableList? = null, + // A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. + @Json(name = "CapDrop") + var capDrop: kotlin.collections.MutableList? = null, + // cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. + @Json(name = "CgroupnsMode") + var cgroupnsMode: HostConfig.CgroupnsMode? = null, + // A list of DNS servers for the container to use. + @Json(name = "Dns") + var dns: kotlin.collections.MutableList? = null, + // A list of DNS options. + @Json(name = "DnsOptions") + var dnsOptions: kotlin.collections.MutableList? = null, + // A list of DNS search domains. + @Json(name = "DnsSearch") + var dnsSearch: kotlin.collections.MutableList? = null, + // A list of hostnames/IP mappings to add to the container's `/etc/hosts` file. Specified in the form `[\"hostname:IP\"]`. + @Json(name = "ExtraHosts") + var extraHosts: kotlin.collections.MutableList? = null, + // A list of additional groups that the container process will run as. + @Json(name = "GroupAdd") + var groupAdd: kotlin.collections.MutableList? = null, + // IPC sharing mode for the container. Possible values are: - `\"none\"`: own private IPC namespace, with /dev/shm not mounted - `\"private\"`: own private IPC namespace - `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers - `\"container:\"`: join another (shareable) container's IPC namespace - `\"host\"`: use the host system's IPC namespace If not specified, daemon default is used, which can either be `\"private\"` or `\"shareable\"`, depending on daemon version and configuration. + @Json(name = "IpcMode") + var ipcMode: kotlin.String? = null, + // Cgroup to use for the container. + @Json(name = "Cgroup") + var cgroup: kotlin.String? = null, + // A list of links for the container in the form `container_name:alias`. + @Json(name = "Links") + var links: kotlin.collections.MutableList? = null, + // An integer value containing the score given to the container in order to tune OOM killer preferences. + @Json(name = "OomScoreAdj") + var oomScoreAdj: kotlin.Int? = null, + // Set the PID (Process) Namespace mode for the container. It can be either: - `\"container:\"`: joins another container's PID namespace - `\"host\"`: use the host's PID namespace inside the container + @Json(name = "PidMode") + var pidMode: kotlin.String? = null, + // Gives the container full access to the host. + @Json(name = "Privileged") + var privileged: kotlin.Boolean? = null, + // Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by `/proc/sys/net/ipv4/ip_local_port_range`. + @Json(name = "PublishAllPorts") + var publishAllPorts: kotlin.Boolean? = null, + // Mount the container's root filesystem as read only. + @Json(name = "ReadonlyRootfs") + var readonlyRootfs: kotlin.Boolean? = null, + // A list of string values to customize labels for MLS systems, such as SELinux. + @Json(name = "SecurityOpt") + var securityOpt: kotlin.collections.MutableList? = null, + // Storage driver options for this container, in the form `{\"size\": \"120G\"}`. + @Json(name = "StorageOpt") + var storageOpt: kotlin.collections.MutableMap? = null, + // A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: ``` { \"/run\": \"rw,noexec,nosuid,size=65536k\" } ``` + @Json(name = "Tmpfs") + var tmpfs: kotlin.collections.MutableMap? = null, + // UTS namespace to use for the container. + @Json(name = "UTSMode") + var utSMode: kotlin.String? = null, + // Sets the usernamespace mode for the container when usernamespace remapping option is enabled. + @Json(name = "UsernsMode") + var usernsMode: kotlin.String? = null, + // Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. + @Json(name = "ShmSize") + var shmSize: kotlin.Long? = null, + // A list of kernel parameters (sysctls) to set in the container. This field is omitted if not set. + @Json(name = "Sysctls") + var sysctls: kotlin.collections.MutableMap? = null, + // Runtime to use with this container. + @Json(name = "Runtime") + var runtime: kotlin.String? = null, + // Isolation technology of the container. (Windows only) + @Json(name = "Isolation") + var isolation: HostConfig.Isolation? = null, + // The list of paths to be masked inside the container (this overrides the default set of paths). + @Json(name = "MaskedPaths") + var maskedPaths: kotlin.collections.MutableList? = null, + // The list of paths to be set as read-only inside the container (this overrides the default set of paths). + @Json(name = "ReadonlyPaths") + var readonlyPaths: kotlin.collections.MutableList? = null, +) { + /** + * cgroup namespace mode for the container. Possible values are: - `\"private\"`: the container runs in its own private cgroup namespace - `\"host\"`: use the host system's cgroup namespace If not specified, the daemon default is used, which can either be `\"private\"` or `\"host\"`, depending on daemon version, kernel support and configuration. + * + * Values: Private,Host + */ + @JsonClass(generateAdapter = false) + enum class CgroupnsMode(val value: kotlin.String) { + @Json(name = "private") + Private("private"), + + @Json(name = "host") + Host("host"), + } + + /** + * Isolation technology of the container. (Windows only) + * + * Values: Default,Process,Hyperv,EMPTY + */ + @JsonClass(generateAdapter = false) + enum class Isolation(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "process") + Process("process"), + + @Json(name = "hyperv") + Hyperv("hyperv"), + + @Json(name = "") + EMPTY(""), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt new file mode 100644 index 00000000..33069d7b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt @@ -0,0 +1,73 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The logging configuration for this container + * + * @param type Name of the logging driver used for the container or \"none\" if logging is disabled. + * @param config Driver-specific configuration options for the logging driver. + */ +@JsonClass(generateAdapter = true) +data class HostConfigAllOfLogConfig( + // Name of the logging driver used for the container or \"none\" if logging is disabled. + @Json(name = "Type") + var type: HostConfigAllOfLogConfig.Type? = null, + // Driver-specific configuration options for the logging driver. + @Json(name = "Config") + var config: kotlin.collections.MutableMap? = null, +) { + /** + * Name of the logging driver used for the container or \"none\" if logging is disabled. + * + * Values: Local,JsonFile,Syslog,Journald,Gelf,Fluentd,Awslogs,Splunk,Etwlogs,None + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "local") + Local("local"), + + @Json(name = "json-file") + JsonFile("json-file"), + + @Json(name = "syslog") + Syslog("syslog"), + + @Json(name = "journald") + Journald("journald"), + + @Json(name = "gelf") + Gelf("gelf"), + + @Json(name = "fluentd") + Fluentd("fluentd"), + + @Json(name = "awslogs") + Awslogs("awslogs"), + + @Json(name = "splunk") + Splunk("splunk"), + + @Json(name = "etwlogs") + Etwlogs("etwlogs"), + + @Json(name = "none") + None("none"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IDResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IDResponse.kt new file mode 100644 index 00000000..4a03c99b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IDResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Response to an API call that returns just an Id + * + * @param id The id of the newly created object. + */ +@JsonClass(generateAdapter = true) +data class IDResponse( + // The id of the newly created object. + @Json(name = "Id") + var id: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt new file mode 100644 index 00000000..6b12e613 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param driver Name of the IPAM driver to use. + * @param config List of IPAM configuration options, specified as a map: ``` {\"Subnet\": , \"IPRange\": , \"Gateway\": , \"AuxAddress\": } ``` + * @param options Driver-specific options, specified as a map. + */ +@JsonClass(generateAdapter = true) +data class IPAM( + // Name of the IPAM driver to use. + @Json(name = "Driver") + var driver: kotlin.String? = "default", + // List of IPAM configuration options, specified as a map: ``` {\"Subnet\": , \"IPRange\": , \"Gateway\": , \"AuxAddress\": } ``` + @Json(name = "Config") + var config: kotlin.collections.MutableList? = null, + // Driver-specific options, specified as a map. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt new file mode 100644 index 00000000..dac6a0e4 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param subnet + * @param ipRange + * @param gateway + * @param auxiliaryAddresses + */ +@JsonClass(generateAdapter = true) +data class IPAMConfig( + @Json(name = "Subnet") + var subnet: kotlin.String? = null, + @Json(name = "IPRange") + var ipRange: kotlin.String? = null, + @Json(name = "Gateway") + var gateway: kotlin.String? = null, + @Json(name = "AuxiliaryAddresses") + var auxiliaryAddresses: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAMStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAMStatus.kt new file mode 100644 index 00000000..472a0ce2 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IPAMStatus.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param subnets + */ +@JsonClass(generateAdapter = true) +data class IPAMStatus( + @Json(name = "Subnets") + var subnets: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt new file mode 100644 index 00000000..db6185d1 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageConfig.kt @@ -0,0 +1,78 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Configuration of the image. These fields are used as defaults when starting a container from the image. + * + * @param user The user that commands are run as inside the container. + * @param exposedPorts An object mapping ports to an empty object in the form: `{\"/\": {}}` + * @param env A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + * @param cmd Command to run specified as a string or an array of strings. + * @param healthcheck + * @param argsEscaped Command is already escaped (Windows only) + * @param volumes An object mapping mount point paths inside the container to empty objects. + * @param workingDir The working directory for commands to run in. + * @param entrypoint The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + * @param onBuild `ONBUILD` metadata that were defined in the image's `Dockerfile`. + * @param labels User-defined key/value metadata. + * @param stopSignal Signal to stop a container as a string or unsigned integer. + * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + */ +@JsonClass(generateAdapter = true) +data class ImageConfig( + // The user that commands are run as inside the container. + @Json(name = "User") + var user: kotlin.String? = null, + // An object mapping ports to an empty object in the form: `{\"/\": {}}` + @Json(name = "ExposedPorts") + var exposedPorts: kotlin.collections.MutableMap? = null, + // A list of environment variables to set inside the container in the form `[\"VAR=value\", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // Command to run specified as a string or an array of strings. + @Json(name = "Cmd") + var cmd: kotlin.collections.MutableList? = null, + @Json(name = "Healthcheck") + var healthcheck: HealthConfig? = null, + // Command is already escaped (Windows only) + @Json(name = "ArgsEscaped") + var argsEscaped: kotlin.Boolean? = false, + // An object mapping mount point paths inside the container to empty objects. + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableMap? = null, + // The working directory for commands to run in. + @Json(name = "WorkingDir") + var workingDir: kotlin.String? = null, + // The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList? = null, + // `ONBUILD` metadata that were defined in the image's `Dockerfile`. + @Json(name = "OnBuild") + var onBuild: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Signal to stop a container as a string or unsigned integer. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = null, + // Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. + @Json(name = "Shell") + var shell: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt new file mode 100644 index 00000000..138be462 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param untagged The image ID of an image that was untagged + * @param deleted The image ID of an image that was deleted + */ +@JsonClass(generateAdapter = true) +data class ImageDeleteResponseItem( + // The image ID of an image that was untagged + @Json(name = "Untagged") + var untagged: kotlin.String? = null, + // The image ID of an image that was deleted + @Json(name = "Deleted") + var deleted: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt new file mode 100644 index 00000000..395b6ed5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Image ID or Digest + * + * @param ID + */ +@JsonClass(generateAdapter = true) +data class ImageID( + @Json(name = "ID") + var ID: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt new file mode 100644 index 00000000..c39ac93a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt @@ -0,0 +1,90 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about an image in the local image cache. + * + * @param id ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + * @param descriptor + * @param manifests Manifests is a list of image manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. Only available if the daemon provides a multi-platform image store and the `manifests` option is set in the inspect request. WARNING: This is experimental and may change at any time without any backward compatibility. + * @param repoTags List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + * @param repoDigests List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + * @param comment Optional message that was set when committing or importing the image. + * @param created Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. + * @param author Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. + * @param config + * @param architecture Hardware CPU architecture that the image runs on. + * @param variant CPU architecture variant (presently ARM-only). + * @param os Operating System the image is built to run on. + * @param osVersion Operating System version the image is built to run on (especially for Windows). + * @param propertySize Total size of the image including all layers it is composed of. + * @param graphDriver + * @param rootFS + * @param metadata + */ +@JsonClass(generateAdapter = true) +data class ImageInspect( + // ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + @Json(name = "Id") + var id: kotlin.String? = null, + @Json(name = "Descriptor") + var descriptor: OCIDescriptor? = null, + // Manifests is a list of image manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. Only available if the daemon provides a multi-platform image store and the `manifests` option is set in the inspect request. WARNING: This is experimental and may change at any time without any backward compatibility. + @Json(name = "Manifests") + var manifests: kotlin.collections.MutableList? = null, + // List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + @Json(name = "RepoTags") + var repoTags: kotlin.collections.MutableList? = null, + // List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + @Json(name = "RepoDigests") + var repoDigests: kotlin.collections.MutableList? = null, + // Optional message that was set when committing or importing the image. + @Json(name = "Comment") + var comment: kotlin.String? = null, + // Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. + @Json(name = "Created") + var created: kotlin.String? = null, + // Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. + @Json(name = "Author") + var author: kotlin.String? = null, + @Json(name = "Config") + var config: ImageConfig? = null, + // Hardware CPU architecture that the image runs on. + @Json(name = "Architecture") + var architecture: kotlin.String? = null, + // CPU architecture variant (presently ARM-only). + @Json(name = "Variant") + var variant: kotlin.String? = null, + // Operating System the image is built to run on. + @Json(name = "Os") + var os: kotlin.String? = null, + // Operating System version the image is built to run on (especially for Windows). + @Json(name = "OsVersion") + var osVersion: kotlin.String? = null, + // Total size of the image including all layers it is composed of. + @Json(name = "Size") + var propertySize: kotlin.Long? = null, + @Json(name = "GraphDriver") + var graphDriver: DriverData? = null, + @Json(name = "RootFS") + var rootFS: ImageInspectRootFS? = null, + @Json(name = "Metadata") + var metadata: ImageInspectMetadata? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt new file mode 100644 index 00000000..51c0d93e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself. + * + * @param lastTagTime Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. + */ +@JsonClass(generateAdapter = true) +data class ImageInspectMetadata( + // Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. + @Json(name = "LastTagTime") + var lastTagTime: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt new file mode 100644 index 00000000..23515fd8 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the image's RootFS, including the layer IDs. + * + * @param type + * @param layers + */ +@JsonClass(generateAdapter = true) +data class ImageInspectRootFS( + @Json(name = "Type") + var type: kotlin.String, + @Json(name = "Layers") + var layers: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummary.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummary.kt new file mode 100644 index 00000000..6bc78552 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummary.kt @@ -0,0 +1,68 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ImageManifestSummary represents a summary of an image manifest. + * + * @param ID ID is the content-addressable ID of an image and is the same as the digest of the image manifest. + * @param descriptor + * @param available Indicates whether all the child content (image config, layers) is fully available locally. + * @param propertySize + * @param kind The kind of the manifest. kind | description -------------|----------------------------------------------------------- image | Image manifest that can be used to start a container. attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. + * @param imageData + * @param attestationData + */ +@JsonClass(generateAdapter = true) +data class ImageManifestSummary( + // ID is the content-addressable ID of an image and is the same as the digest of the image manifest. + @Json(name = "ID") + var ID: kotlin.String, + @Json(name = "Descriptor") + var descriptor: OCIDescriptor, + // Indicates whether all the child content (image config, layers) is fully available locally. + @Json(name = "Available") + var available: kotlin.Boolean, + @Json(name = "Size") + var propertySize: ImageManifestSummarySize, + // The kind of the manifest. kind | description -------------|----------------------------------------------------------- image | Image manifest that can be used to start a container. attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. + @Json(name = "Kind") + var kind: ImageManifestSummary.Kind, + @Json(name = "ImageData") + var imageData: ImageManifestSummaryImageData? = null, + @Json(name = "AttestationData") + var attestationData: ImageManifestSummaryAttestationData? = null, +) { + /** + * The kind of the manifest. kind | description -------------|----------------------------------------------------------- image | Image manifest that can be used to start a container. attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. + * + * Values: Image,Attestation,Unknown + */ + @JsonClass(generateAdapter = false) + enum class Kind(val value: kotlin.String) { + @Json(name = "image") + Image("image"), + + @Json(name = "attestation") + Attestation("attestation"), + + @Json(name = "unknown") + Unknown("unknown"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryAttestationData.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryAttestationData.kt new file mode 100644 index 00000000..979f08dc --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryAttestationData.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The image data for the attestation manifest. This field is only populated when Kind is \"attestation\". + * + * @param `for` The digest of the image manifest that this attestation is for. + */ +@JsonClass(generateAdapter = true) +data class ImageManifestSummaryAttestationData( + // The digest of the image manifest that this attestation is for. + @Json(name = "For") + var `for`: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageData.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageData.kt new file mode 100644 index 00000000..ca19cda6 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageData.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The image data for the image manifest. This field is only populated when Kind is \"image\". + * + * @param platform + * @param containers The IDs of the containers that are using this image. + * @param propertySize + */ +@JsonClass(generateAdapter = true) +data class ImageManifestSummaryImageData( + @Json(name = "Platform") + var platform: OCIPlatform?, + // The IDs of the containers that are using this image. + @Json(name = "Containers") + var containers: kotlin.collections.MutableList, + @Json(name = "Size") + var propertySize: ImageManifestSummaryImageDataSize, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageDataSize.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageDataSize.kt new file mode 100644 index 00000000..eba40298 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummaryImageDataSize.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param unpacked Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image content that's directly usable by the containers running this image. It's independent of the distributable content - e.g. the image might still have an unpacked data that's still used by some container even when the distributable/compressed content is already gone. + */ +@JsonClass(generateAdapter = true) +data class ImageManifestSummaryImageDataSize( + // Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image content that's directly usable by the containers running this image. It's independent of the distributable content - e.g. the image might still have an unpacked data that's still used by some container even when the distributable/compressed content is already gone. + @Json(name = "Unpacked") + var unpacked: kotlin.Long, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummarySize.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummarySize.kt new file mode 100644 index 00000000..f867765e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageManifestSummarySize.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param total Total is the total size (in bytes) of all the locally present data (both distributable and non-distributable) that's related to this manifest and its children. This equal to the sum of [Content] size AND all the sizes in the [Size] struct present in the Kind-specific data struct. For example, for an image kind (Kind == \"image\") this would include the size of the image content and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]). + * @param content Content is the size (in bytes) of all the locally present content in the content store (e.g. image config, layers) referenced by this manifest and its children. This only includes blobs in the content store. + */ +@JsonClass(generateAdapter = true) +data class ImageManifestSummarySize( + // Total is the total size (in bytes) of all the locally present data (both distributable and non-distributable) that's related to this manifest and its children. This equal to the sum of [Content] size AND all the sizes in the [Size] struct present in the Kind-specific data struct. For example, for an image kind (Kind == \"image\") this would include the size of the image content and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]). + @Json(name = "Total") + var total: kotlin.Long, + // Content is the size (in bytes) of all the locally present content in the content store (e.g. image config, layers) referenced by this manifest and its children. This only includes blobs in the content store. + @Json(name = "Content") + var content: kotlin.Long, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt new file mode 100644 index 00000000..b551f8d0 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param imagesDeleted Images that were deleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class ImagePruneResponse( + // Images that were deleted + @Json(name = "ImagesDeleted") + var imagesDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt new file mode 100644 index 00000000..40298c7f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param description + * @param official + * @param automated Whether this repository has automated builds enabled.


> **Deprecated**: This field is deprecated and will always be \"false\". + * @param name + * @param starCount + */ +@JsonClass(generateAdapter = true) +data class ImageSearchResponseItem( + @Json(name = "description") + var description: kotlin.String? = null, + @Json(name = "is_official") + var official: kotlin.Boolean? = null, + // Whether this repository has automated builds enabled.


> **Deprecated**: This field is deprecated and will always be \"false\". + @Json(name = "is_automated") + var automated: kotlin.Boolean? = null, + @Json(name = "name") + var name: kotlin.String? = null, + @Json(name = "star_count") + var starCount: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt new file mode 100644 index 00000000..1aac7ab7 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt @@ -0,0 +1,70 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param id ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + * @param parentId ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. + * @param created Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). + * @param propertySize Total size of the image including all layers it is composed of. + * @param sharedSize Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. + * @param containers Number of containers using this image. Includes both stopped and running containers. `-1` indicates that the value has not been set / calculated. + * @param repoTags List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + * @param repoDigests List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + * @param labels User-defined key/value metadata. + * @param manifests Manifests is a list of manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. WARNING: This is experimental and may change at any time without any backward compatibility. + * @param descriptor + */ +@JsonClass(generateAdapter = true) +data class ImageSummary( + // ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. + @Json(name = "Id") + var id: kotlin.String, + // ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry. + @Json(name = "ParentId") + var parentId: kotlin.String, + // Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). + @Json(name = "Created") + var created: kotlin.Int, + // Total size of the image including all layers it is composed of. + @Json(name = "Size") + var propertySize: kotlin.Long, + // Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. + @Json(name = "SharedSize") + var sharedSize: kotlin.Long, + // Number of containers using this image. Includes both stopped and running containers. `-1` indicates that the value has not been set / calculated. + @Json(name = "Containers") + var containers: kotlin.Int, + // List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID. + @Json(name = "RepoTags") + var repoTags: kotlin.collections.MutableList? = null, + // List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated. + @Json(name = "RepoDigests") + var repoDigests: kotlin.collections.MutableList? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Manifests is a list of manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. WARNING: This is experimental and may change at any time without any backward compatibility. + @Json(name = "Manifests") + var manifests: kotlin.collections.MutableList? = null, + @Json(name = "Descriptor") + var descriptor: OCIDescriptor? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImagesDiskUsage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImagesDiskUsage.kt new file mode 100644 index 00000000..cb797966 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ImagesDiskUsage.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents system data usage for image resources. + * + * @param activeCount Count of active images. + * @param totalCount Count of all images. + * @param reclaimable Disk space that can be reclaimed by removing unused images. + * @param totalSize Disk space in use by images. + * @param items List of image summaries. + */ +@JsonClass(generateAdapter = true) +data class ImagesDiskUsage( + // Count of active images. + @Json(name = "ActiveCount") + var activeCount: kotlin.Long? = null, + // Count of all images. + @Json(name = "TotalCount") + var totalCount: kotlin.Long? = null, + // Disk space that can be reclaimed by removing unused images. + @Json(name = "Reclaimable") + var reclaimable: kotlin.Long? = null, + // Disk space in use by images. + @Json(name = "TotalSize") + var totalSize: kotlin.Long? = null, + // List of image summaries. + @Json(name = "Items") + var items: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt new file mode 100644 index 00000000..946c5434 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * IndexInfo contains information about a registry. + * + * @param name Name of the registry, such as \"docker.io\". + * @param mirrors List of mirrors, expressed as URIs. + * @param secure Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. + * @param official Indicates whether this is an official registry (i.e., Docker Hub / docker.io) + */ +@JsonClass(generateAdapter = true) +data class IndexInfo( + // Name of the registry, such as \"docker.io\". + @Json(name = "Name") + var name: kotlin.String? = null, + // List of mirrors, expressed as URIs. + @Json(name = "Mirrors") + var mirrors: kotlin.collections.MutableList? = null, + // Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. > **Warning**: Insecure registries can be useful when running a local > registry. However, because its use creates security vulnerabilities > it should ONLY be enabled for testing purposes. For increased > security, users should add their CA to their system's list of > trusted CAs instead of enabling this option. + @Json(name = "Secure") + var secure: kotlin.Boolean? = null, + // Indicates whether this is an official registry (i.e., Docker Hub / docker.io) + @Json(name = "Official") + var official: kotlin.Boolean? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt new file mode 100644 index 00000000..c86f24ed --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * JoinTokens contains the tokens workers and managers need to join the swarm. + * + * @param worker The token workers can use to join the swarm. + * @param manager The token managers can use to join the swarm. + */ +@JsonClass(generateAdapter = true) +data class JoinTokens( + // The token workers can use to join the swarm. + @Json(name = "Worker") + var worker: kotlin.String? = null, + // The token managers can use to join the swarm. + @Json(name = "Manager") + var manager: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt new file mode 100644 index 00000000..032c6749 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * An object describing a limit on resources which can be requested by a task. + * + * @param nanoCPUs + * @param memoryBytes + * @param pids Limits the maximum number of PIDs in the container. Set `0` for unlimited. + */ +@JsonClass(generateAdapter = true) +data class Limit( + @Json(name = "NanoCPUs") + var nanoCPUs: kotlin.Long? = null, + @Json(name = "MemoryBytes") + var memoryBytes: kotlin.Long? = null, + // Limits the maximum number of PIDs in the container. Set `0` for unlimited. + @Json(name = "Pids") + var pids: kotlin.Long? = 0L, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt new file mode 100644 index 00000000..98d513f8 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt @@ -0,0 +1,74 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Current local status of this node. + * + * Values: EMPTY,Inactive,Pending,Active,Error,Locked + */ + +@JsonClass(generateAdapter = false) +enum class LocalNodeState(val value: kotlin.String) { + @Json(name = "") + EMPTY(""), + + @Json(name = "inactive") + Inactive("inactive"), + + @Json(name = "pending") + Pending("pending"), + + @Json(name = "active") + Active("active"), + + @Json(name = "error") + Error("error"), + + @Json(name = "locked") + Locked("locked"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is LocalNodeState) "$data" else null + + /** + * Returns a valid [LocalNodeState] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): LocalNodeState? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt new file mode 100644 index 00000000..43ddd780 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * ManagerStatus represents the status of a manager. It provides the current status of a node's manager component, if the node is a manager. + * + * @param leader + * @param reachability + * @param addr The IP address and port at which the manager is reachable. + */ +@JsonClass(generateAdapter = true) +data class ManagerStatus( + @Json(name = "Leader") + var leader: kotlin.Boolean? = false, + @Json(name = "Reachability") + var reachability: Reachability? = null, + // The IP address and port at which the manager is reachable. + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt new file mode 100644 index 00000000..66da3b08 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt @@ -0,0 +1,85 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param target Container path. + * @param source Mount source (e.g. a volume name, a host path). + * @param type The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `image` Mounts an image. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume + * @param readOnly Whether the mount should be read-only. + * @param consistency The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. + * @param bindOptions + * @param volumeOptions + * @param imageOptions + * @param tmpfsOptions + */ +@JsonClass(generateAdapter = true) +data class Mount( + // Container path. + @Json(name = "Target") + var target: kotlin.String? = null, + // Mount source (e.g. a volume name, a host path). + @Json(name = "Source") + var source: kotlin.String? = null, + // The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `image` Mounts an image. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume + @Json(name = "Type") + var type: Mount.Type? = null, + // Whether the mount should be read-only. + @Json(name = "ReadOnly") + var readOnly: kotlin.Boolean? = null, + // The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. + @Json(name = "Consistency") + var consistency: kotlin.String? = null, + @Json(name = "BindOptions") + var bindOptions: MountBindOptions? = null, + @Json(name = "VolumeOptions") + var volumeOptions: MountVolumeOptions? = null, + @Json(name = "ImageOptions") + var imageOptions: MountImageOptions? = null, + @Json(name = "TmpfsOptions") + var tmpfsOptions: MountTmpfsOptions? = null, +) { + /** + * The mount type. Available types: - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `image` Mounts an image. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container. - `cluster` a Swarm cluster volume + * + * Values: Bind,Volume,Image,Tmpfs,Npipe,Cluster + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "bind") + Bind("bind"), + + @Json(name = "volume") + Volume("volume"), + + @Json(name = "image") + Image("image"), + + @Json(name = "tmpfs") + Tmpfs("tmpfs"), + + @Json(name = "npipe") + Npipe("npipe"), + + @Json(name = "cluster") + Cluster("cluster"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt new file mode 100644 index 00000000..52fbece9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt @@ -0,0 +1,73 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `bind` type. + * + * @param propagation A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + * @param nonRecursive Disable recursive bind mount. + * @param createMountpoint Create mount point on host if missing + * @param readOnlyNonRecursive Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to `true` in conjunction). Added in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to `true` for clients on versions prior to v1.44. + * @param readOnlyForceRecursive Raise an error if the mount cannot be made recursively read-only. + */ +@JsonClass(generateAdapter = true) +data class MountBindOptions( + // A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + @Json(name = "Propagation") + var propagation: MountBindOptions.Propagation? = null, + // Disable recursive bind mount. + @Json(name = "NonRecursive") + var nonRecursive: kotlin.Boolean? = false, + // Create mount point on host if missing + @Json(name = "CreateMountpoint") + var createMountpoint: kotlin.Boolean? = false, + // Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to `true` in conjunction). Added in v1.44, before that version all read-only mounts were non-recursive by default. To match the previous behaviour this will default to `true` for clients on versions prior to v1.44. + @Json(name = "ReadOnlyNonRecursive") + var readOnlyNonRecursive: kotlin.Boolean? = false, + // Raise an error if the mount cannot be made recursively read-only. + @Json(name = "ReadOnlyForceRecursive") + var readOnlyForceRecursive: kotlin.Boolean? = false, +) { + /** + * A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + * + * Values: Private,Rprivate,Shared,Rshared,Slave,Rslave + */ + @JsonClass(generateAdapter = false) + enum class Propagation(val value: kotlin.String) { + @Json(name = "private") + Private("private"), + + @Json(name = "rprivate") + Rprivate("rprivate"), + + @Json(name = "shared") + Shared("shared"), + + @Json(name = "rshared") + Rshared("rshared"), + + @Json(name = "slave") + Slave("slave"), + + @Json(name = "rslave") + Rslave("rslave"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountImageOptions.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountImageOptions.kt new file mode 100644 index 00000000..47af860b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountImageOptions.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `image` type. + * + * @param subpath Source path inside the image. Must be relative without any back traversals. + */ +@JsonClass(generateAdapter = true) +data class MountImageOptions( + // Source path inside the image. Must be relative without any back traversals. + @Json(name = "Subpath") + var subpath: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt new file mode 100644 index 00000000..1e89dcc4 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt @@ -0,0 +1,85 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container. + * + * @param type The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `image` a docker image - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume + * @param name Name is the name reference to the underlying data defined by `Source` e.g., the volume name. + * @param source Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. + * @param destination Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. + * @param driver Driver is the volume driver used to create the volume (if it is a volume). + * @param mode Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). + * @param RW Whether the mount is mounted writable (read-write). + * @param propagation Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. + */ +@JsonClass(generateAdapter = true) +data class MountPoint( + // The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `image` a docker image - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume + @Json(name = "Type") + var type: MountPoint.Type? = null, + // Name is the name reference to the underlying data defined by `Source` e.g., the volume name. + @Json(name = "Name") + var name: kotlin.String? = null, + // Source location of the mount. For volumes, this contains the storage location of the volume (within `/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains the source (host) part of the bind-mount. For `tmpfs` mount points, this field is empty. + @Json(name = "Source") + var source: kotlin.String? = null, + // Destination is the path relative to the container root (`/`) where the `Source` is mounted inside the container. + @Json(name = "Destination") + var destination: kotlin.String? = null, + // Driver is the volume driver used to create the volume (if it is a volume). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific (`\"z\"` on Linux, empty on Windows). + @Json(name = "Mode") + var mode: kotlin.String? = null, + // Whether the mount is mounted writable (read-write). + @Json(name = "RW") + var RW: kotlin.Boolean? = null, + // Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. + @Json(name = "Propagation") + var propagation: kotlin.String? = null, +) { + /** + * The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `image` a docker image - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. - `cluster` a Swarm cluster volume + * + * Values: Bind,Volume,Image,Tmpfs,Npipe,Cluster + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "bind") + Bind("bind"), + + @Json(name = "volume") + Volume("volume"), + + @Json(name = "image") + Image("image"), + + @Json(name = "tmpfs") + Tmpfs("tmpfs"), + + @Json(name = "npipe") + Npipe("npipe"), + + @Json(name = "cluster") + Cluster("cluster"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt new file mode 100644 index 00000000..b0dadaad --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `tmpfs` type. + * + * @param sizeBytes The size for the tmpfs mount in bytes. + * @param mode The permission mode for the tmpfs mount in an integer. + * @param options The options to be passed to the tmpfs mount. An array of arrays. Flag options should be provided as 1-length arrays. Other types should be provided as as 2-length arrays, where the first item is the key and the second the value. + */ +@JsonClass(generateAdapter = true) +data class MountTmpfsOptions( + // The size for the tmpfs mount in bytes. + @Json(name = "SizeBytes") + var sizeBytes: kotlin.Long? = null, + // The permission mode for the tmpfs mount in an integer. + @Json(name = "Mode") + var mode: kotlin.Int? = null, + // The options to be passed to the tmpfs mount. An array of arrays. Flag options should be provided as 1-length arrays. Other types should be provided as as 2-length arrays, where the first item is the key and the second the value. + @Json(name = "Options") + var options: kotlin.collections.MutableList>? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt new file mode 100644 index 00000000..3ecc157c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Optional configuration for the `volume` type. + * + * @param noCopy Populate volume with data from the target. + * @param labels User-defined key/value metadata. + * @param driverConfig + * @param subpath Source path inside the volume. Must be relative without any back traversals. + */ +@JsonClass(generateAdapter = true) +data class MountVolumeOptions( + // Populate volume with data from the target. + @Json(name = "NoCopy") + var noCopy: kotlin.Boolean? = false, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "DriverConfig") + var driverConfig: MountVolumeOptionsDriverConfig? = null, + // Source path inside the volume. Must be relative without any back traversals. + @Json(name = "Subpath") + var subpath: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt new file mode 100644 index 00000000..3b8d0ab9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Map of driver specific options + * + * @param name Name of the driver to use to create the volume. + * @param options key/value map of driver specific options. + */ +@JsonClass(generateAdapter = true) +data class MountVolumeOptionsDriverConfig( + // Name of the driver to use to create the volume. + @Json(name = "Name") + var name: kotlin.String? = null, + // key/value map of driver specific options. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt new file mode 100644 index 00000000..9faec361 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt @@ -0,0 +1,89 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the network. + * @param id ID that uniquely identifies a network on a single machine. + * @param created Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param scope The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + * @param driver The name of the driver used to create the network (e.g. `bridge`, `overlay`). + * @param enableIPv4 Whether the network was created with IPv4 enabled. + * @param enableIPv6 Whether the network was created with IPv6 enabled. + * @param IPAM + * @param `internal` Whether the network is created to only allow internal networking connectivity. + * @param attachable Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + * @param ingress Whether the network is providing the routing-mesh for the swarm cluster. + * @param configFrom + * @param configOnly Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + * @param options Network-specific options uses when creating the network. + * @param labels Metadata specific to the network being created. + * @param peers List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + */ +@JsonClass(generateAdapter = true) +data class Network( + // Name of the network. + @Json(name = "Name") + var name: kotlin.String? = null, + // ID that uniquely identifies a network on a single machine. + @Json(name = "Id") + var id: kotlin.String? = null, + // Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Created") + var created: kotlin.String? = null, + // The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + @Json(name = "Scope") + var scope: kotlin.String? = null, + // The name of the driver used to create the network (e.g. `bridge`, `overlay`). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Whether the network was created with IPv4 enabled. + @Json(name = "EnableIPv4") + var enableIPv4: kotlin.Boolean? = null, + // Whether the network was created with IPv6 enabled. + @Json(name = "EnableIPv6") + var enableIPv6: kotlin.Boolean? = null, + @Json(name = "IPAM") + var IPAM: IPAM? = null, + // Whether the network is created to only allow internal networking connectivity. + @Json(name = "Internal") + var `internal`: kotlin.Boolean? = false, + // Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + @Json(name = "Attachable") + var attachable: kotlin.Boolean? = false, + // Whether the network is providing the routing-mesh for the swarm cluster. + @Json(name = "Ingress") + var ingress: kotlin.Boolean? = false, + @Json(name = "ConfigFrom") + var configFrom: ConfigReference? = null, + // Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + @Json(name = "ConfigOnly") + var configOnly: kotlin.Boolean? = false, + // Network-specific options uses when creating the network. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // Metadata specific to the network being created. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + @Json(name = "Peers") + var peers: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt new file mode 100644 index 00000000..fcfeecbf --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specifies how a service should be attached to a particular network. + * + * @param target The target network for attachment. Must be a network name or ID. + * @param aliases Discoverable alternate names for the service on this network. + * @param driverOpts Driver attachment options for the network target. + */ +@JsonClass(generateAdapter = true) +data class NetworkAttachmentConfig( + // The target network for attachment. Must be a network name or ID. + @Json(name = "Target") + var target: kotlin.String? = null, + // Discoverable alternate names for the service on this network. + @Json(name = "Aliases") + var aliases: kotlin.collections.MutableList? = null, + // Driver attachment options for the network target. + @Json(name = "DriverOpts") + var driverOpts: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt new file mode 100644 index 00000000..2753400c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NetworkConnectRequest represents the data to be used to connect a container to a network. + * + * @param container The ID or name of the container to connect to the network. + * @param endpointConfig + */ +@JsonClass(generateAdapter = true) +data class NetworkConnectRequest( + // The ID or name of the container to connect to the network. + @Json(name = "Container") + var container: kotlin.String, + @Json(name = "EndpointConfig") + var endpointConfig: EndpointSettings? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt new file mode 100644 index 00000000..2afecb3d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt @@ -0,0 +1,77 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name The network's name. + * @param driver Name of the network driver plugin to use. + * @param scope The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level). + * @param `internal` Restrict external access to the network. + * @param attachable Globally scoped network is manually attachable by regular containers from workers in swarm mode. + * @param ingress Ingress network is the network which provides the routing-mesh in swarm mode. + * @param configOnly Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + * @param configFrom + * @param IPAM + * @param enableIPv4 Enable IPv4 on the network. + * @param enableIPv6 Enable IPv6 on the network. + * @param options Network specific options to be used by the drivers. + * @param labels User-defined key/value metadata. + */ +@JsonClass(generateAdapter = true) +data class NetworkCreateRequest( + // The network's name. + @Json(name = "Name") + var name: kotlin.String, + // Name of the network driver plugin to use. + @Json(name = "Driver") + var driver: kotlin.String? = "bridge", + // The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level). + @Json(name = "Scope") + var scope: kotlin.String? = null, + // Restrict external access to the network. + @Json(name = "Internal") + var `internal`: kotlin.Boolean? = null, + // Globally scoped network is manually attachable by regular containers from workers in swarm mode. + @Json(name = "Attachable") + var attachable: kotlin.Boolean? = null, + // Ingress network is the network which provides the routing-mesh in swarm mode. + @Json(name = "Ingress") + var ingress: kotlin.Boolean? = null, + // Creates a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + @Json(name = "ConfigOnly") + var configOnly: kotlin.Boolean? = false, + @Json(name = "ConfigFrom") + var configFrom: ConfigReference? = null, + @Json(name = "IPAM") + var IPAM: IPAM? = null, + // Enable IPv4 on the network. + @Json(name = "EnableIPv4") + var enableIPv4: kotlin.Boolean? = null, + // Enable IPv6 on the network. + @Json(name = "EnableIPv6") + var enableIPv6: kotlin.Boolean? = null, + // Network specific options to be used by the drivers. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt new file mode 100644 index 00000000..9df3c1cd --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * OK response to NetworkCreate operation + * + * @param id The ID of the created network. + * @param warning Warnings encountered when creating the container + */ +@JsonClass(generateAdapter = true) +data class NetworkCreateResponse( + // The ID of the created network. + @Json(name = "Id") + var id: kotlin.String, + // Warnings encountered when creating the container + @Json(name = "Warning") + var warning: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt new file mode 100644 index 00000000..69e72c04 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NetworkDisconnectRequest represents the data to be used to disconnect a container from a network. + * + * @param container The ID or name of the container to disconnect from the network. + * @param force Force the container to disconnect from the network. + */ +@JsonClass(generateAdapter = true) +data class NetworkDisconnectRequest( + // The ID or name of the container to disconnect from the network. + @Json(name = "Container") + var container: kotlin.String, + // Force the container to disconnect from the network. + @Json(name = "Force") + var force: kotlin.Boolean? = false, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkInspect.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkInspect.kt new file mode 100644 index 00000000..257c0be3 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkInspect.kt @@ -0,0 +1,100 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the network. + * @param id ID that uniquely identifies a network on a single machine. + * @param created Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param scope The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + * @param driver The name of the driver used to create the network (e.g. `bridge`, `overlay`). + * @param enableIPv4 Whether the network was created with IPv4 enabled. + * @param enableIPv6 Whether the network was created with IPv6 enabled. + * @param IPAM + * @param `internal` Whether the network is created to only allow internal networking connectivity. + * @param attachable Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + * @param ingress Whether the network is providing the routing-mesh for the swarm cluster. + * @param configFrom + * @param configOnly Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + * @param options Network-specific options uses when creating the network. + * @param labels Metadata specific to the network being created. + * @param peers List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + * @param containers Contains endpoints attached to the network. + * @param services List of services using the network. This field is only present for swarm scope networks, and omitted for local scope networks. + * @param status + */ +@JsonClass(generateAdapter = true) +data class NetworkInspect( + // Name of the network. + @Json(name = "Name") + var name: kotlin.String? = null, + // ID that uniquely identifies a network on a single machine. + @Json(name = "Id") + var id: kotlin.String? = null, + // Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Created") + var created: kotlin.String? = null, + // The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + @Json(name = "Scope") + var scope: kotlin.String? = null, + // The name of the driver used to create the network (e.g. `bridge`, `overlay`). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Whether the network was created with IPv4 enabled. + @Json(name = "EnableIPv4") + var enableIPv4: kotlin.Boolean? = null, + // Whether the network was created with IPv6 enabled. + @Json(name = "EnableIPv6") + var enableIPv6: kotlin.Boolean? = null, + @Json(name = "IPAM") + var IPAM: IPAM? = null, + // Whether the network is created to only allow internal networking connectivity. + @Json(name = "Internal") + var `internal`: kotlin.Boolean? = false, + // Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + @Json(name = "Attachable") + var attachable: kotlin.Boolean? = false, + // Whether the network is providing the routing-mesh for the swarm cluster. + @Json(name = "Ingress") + var ingress: kotlin.Boolean? = false, + @Json(name = "ConfigFrom") + var configFrom: ConfigReference? = null, + // Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + @Json(name = "ConfigOnly") + var configOnly: kotlin.Boolean? = false, + // Network-specific options uses when creating the network. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // Metadata specific to the network being created. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + @Json(name = "Peers") + var peers: kotlin.collections.MutableList? = null, + // Contains endpoints attached to the network. + @Json(name = "Containers") + var containers: kotlin.collections.MutableMap? = null, + // List of services using the network. This field is only present for swarm scope networks, and omitted for local scope networks. + @Json(name = "Services") + var services: kotlin.collections.MutableMap? = null, + @Json(name = "Status") + var status: NetworkStatus? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt new file mode 100644 index 00000000..5d84de59 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param networksDeleted Networks that were deleted + */ +@JsonClass(generateAdapter = true) +data class NetworkPruneResponse( + // Networks that were deleted + @Json(name = "NetworksDeleted") + var networksDeleted: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt new file mode 100644 index 00000000..0933b798 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NetworkSettings exposes the network settings in the API + * + * @param sandboxID SandboxID uniquely represents a container's network stack. + * @param sandboxKey SandboxKey is the full path of the netns handle + * @param ports PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + * @param networks Information about all networks that the container is connected to. + */ +@JsonClass(generateAdapter = true) +data class NetworkSettings( + // SandboxID uniquely represents a container's network stack. + @Json(name = "SandboxID") + var sandboxID: kotlin.String? = null, + // SandboxKey is the full path of the netns handle + @Json(name = "SandboxKey") + var sandboxKey: kotlin.String? = null, + // PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `/`, for example, `80/udp`. If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. + @Json(name = "Ports") + var ports: kotlin.collections.MutableMap>? = null, + // Information about all networks that the container is connected to. + @Json(name = "Networks") + var networks: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkStatus.kt new file mode 100644 index 00000000..af4cdb56 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkStatus.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * provides runtime information about the network such as the number of allocated IPs. + * + * @param IPAM + */ +@JsonClass(generateAdapter = true) +data class NetworkStatus( + @Json(name = "IPAM") + var IPAM: IPAMStatus? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSummary.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSummary.kt new file mode 100644 index 00000000..b5753ee9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSummary.kt @@ -0,0 +1,89 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Network list response item + * + * @param name Name of the network. + * @param id ID that uniquely identifies a network on a single machine. + * @param created Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param scope The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + * @param driver The name of the driver used to create the network (e.g. `bridge`, `overlay`). + * @param enableIPv4 Whether the network was created with IPv4 enabled. + * @param enableIPv6 Whether the network was created with IPv6 enabled. + * @param IPAM + * @param `internal` Whether the network is created to only allow internal networking connectivity. + * @param attachable Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + * @param ingress Whether the network is providing the routing-mesh for the swarm cluster. + * @param configFrom + * @param configOnly Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + * @param options Network-specific options uses when creating the network. + * @param labels Metadata specific to the network being created. + * @param peers List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + */ +@JsonClass(generateAdapter = true) +data class NetworkSummary( + // Name of the network. + @Json(name = "Name") + var name: kotlin.String? = null, + // ID that uniquely identifies a network on a single machine. + @Json(name = "Id") + var id: kotlin.String? = null, + // Date and time at which the network was created in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "Created") + var created: kotlin.String? = null, + // The level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level) + @Json(name = "Scope") + var scope: kotlin.String? = null, + // The name of the driver used to create the network (e.g. `bridge`, `overlay`). + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Whether the network was created with IPv4 enabled. + @Json(name = "EnableIPv4") + var enableIPv4: kotlin.Boolean? = null, + // Whether the network was created with IPv6 enabled. + @Json(name = "EnableIPv6") + var enableIPv6: kotlin.Boolean? = null, + @Json(name = "IPAM") + var IPAM: IPAM? = null, + // Whether the network is created to only allow internal networking connectivity. + @Json(name = "Internal") + var `internal`: kotlin.Boolean? = false, + // Whether a global / swarm scope network is manually attachable by regular containers from workers in swarm mode. + @Json(name = "Attachable") + var attachable: kotlin.Boolean? = false, + // Whether the network is providing the routing-mesh for the swarm cluster. + @Json(name = "Ingress") + var ingress: kotlin.Boolean? = false, + @Json(name = "ConfigFrom") + var configFrom: ConfigReference? = null, + // Whether the network is a config-only network. Config-only networks are placeholder networks for network configurations to be used by other networks. Config-only networks cannot be used directly to run containers or services. + @Json(name = "ConfigOnly") + var configOnly: kotlin.Boolean? = false, + // Network-specific options uses when creating the network. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // Metadata specific to the network being created. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // List of peer nodes for an overlay network. This field is only present for overlay networks, and omitted for other network types. + @Json(name = "Peers") + var peers: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkTaskInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkTaskInfo.kt new file mode 100644 index 00000000..b92b2315 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkTaskInfo.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * carries the information about one backend task + * + * @param name + * @param endpointID + * @param endpointIP + * @param info + */ +@JsonClass(generateAdapter = true) +data class NetworkTaskInfo( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "EndpointID") + var endpointID: kotlin.String? = null, + @Json(name = "EndpointIP") + var endpointIP: kotlin.String? = null, + @Json(name = "Info") + var info: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt new file mode 100644 index 00000000..0d210e17 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the `docker create` and `docker network connect` commands. + * + * @param endpointsConfig A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. + */ +@JsonClass(generateAdapter = true) +data class NetworkingConfig( + // A mapping of network name to endpoint configuration for that network. The endpoint configuration can be left empty to connect to that network with no particular endpoint configuration. + @Json(name = "EndpointsConfig") + var endpointsConfig: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt new file mode 100644 index 00000000..53f96c24 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt @@ -0,0 +1,53 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param updatedAt Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param spec + * @param description + * @param status + * @param managerStatus + */ +@JsonClass(generateAdapter = true) +data class Node( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + // Date and time at which the node was added to the swarm in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the node was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: NodeSpec? = null, + @Json(name = "Description") + var description: NodeDescription? = null, + @Json(name = "Status") + var status: NodeStatus? = null, + @Json(name = "ManagerStatus") + var managerStatus: ManagerStatus? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt new file mode 100644 index 00000000..4b776f52 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NodeDescription encapsulates the properties of the Node as reported by the agent. + * + * @param hostname + * @param platform + * @param resources + * @param engine + * @param tlSInfo + */ +@JsonClass(generateAdapter = true) +data class NodeDescription( + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + @Json(name = "Platform") + var platform: Platform? = null, + @Json(name = "Resources") + var resources: ResourceObject? = null, + @Json(name = "Engine") + var engine: EngineDescription? = null, + @Json(name = "TLSInfo") + var tlSInfo: TLSInfo? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt new file mode 100644 index 00000000..fd067316 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt @@ -0,0 +1,74 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name for the node. + * @param labels User-defined key/value metadata. + * @param role Role of the node. + * @param availability Availability of the node. + */ +@JsonClass(generateAdapter = true) +data class NodeSpec( + // Name for the node. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Role of the node. + @Json(name = "Role") + var role: NodeSpec.Role? = null, + // Availability of the node. + @Json(name = "Availability") + var availability: NodeSpec.Availability? = null, +) { + /** + * Role of the node. + * + * Values: Worker,Manager + */ + @JsonClass(generateAdapter = false) + enum class Role(val value: kotlin.String) { + @Json(name = "worker") + Worker("worker"), + + @Json(name = "manager") + Manager("manager"), + } + + /** + * Availability of the node. + * + * Values: Active,Pause,Drain + */ + @JsonClass(generateAdapter = false) + enum class Availability(val value: kotlin.String) { + @Json(name = "active") + Active("active"), + + @Json(name = "pause") + Pause("pause"), + + @Json(name = "drain") + Drain("drain"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt new file mode 100644 index 00000000..f3d578e6 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt @@ -0,0 +1,68 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NodeState represents the state of a node. + * + * Values: Unknown,Down,Ready,Disconnected + */ + +@JsonClass(generateAdapter = false) +enum class NodeState(val value: kotlin.String) { + @Json(name = "unknown") + Unknown("unknown"), + + @Json(name = "down") + Down("down"), + + @Json(name = "ready") + Ready("ready"), + + @Json(name = "disconnected") + Disconnected("disconnected"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is NodeState) "$data" else null + + /** + * Returns a valid [NodeState] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): NodeState? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt new file mode 100644 index 00000000..ec24fa70 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * NodeStatus represents the status of a node. It provides the current status of the node, as seen by the manager. + * + * @param state + * @param message + * @param addr IP address of the node. + */ +@JsonClass(generateAdapter = true) +data class NodeStatus( + @Json(name = "State") + var state: NodeState? = null, + @Json(name = "Message") + var message: kotlin.String? = null, + // IP address of the node. + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt new file mode 100644 index 00000000..178f7ba8 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt @@ -0,0 +1,58 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * 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 propertySize The size in bytes of the blob. + * @param urls List of URLs from which this object MAY be downloaded. + * @param annotations Arbitrary metadata relating to the targeted content. + * @param `data` Data is an embedding of the targeted content. This is encoded as a base64 string when marshalled to JSON (automatically, by encoding/json). If present, Data can be used directly to avoid fetching the targeted content. + * @param platform + * @param artifactType ArtifactType is the IANA media type of this artifact. + */ +@JsonClass(generateAdapter = true) +data class OCIDescriptor( + // The media type of the object this schema refers to. + @Json(name = "mediaType") + var mediaType: kotlin.String? = null, + // The digest of the targeted content. + @Json(name = "digest") + var digest: kotlin.String? = null, + // The size in bytes of the blob. + @Json(name = "size") + var propertySize: kotlin.Long? = null, + // List of URLs from which this object MAY be downloaded. + @Json(name = "urls") + var urls: kotlin.collections.MutableList? = null, + // Arbitrary metadata relating to the targeted content. + @Json(name = "annotations") + var annotations: kotlin.collections.MutableMap? = null, + // Data is an embedding of the targeted content. This is encoded as a base64 string when marshalled to JSON (automatically, by encoding/json). If present, Data can be used directly to avoid fetching the targeted content. + @Json(name = "data") + var `data`: kotlin.String? = null, + @Json(name = "platform") + var platform: OCIPlatform? = null, + // ArtifactType is the IANA media type of this artifact. + @Json(name = "artifactType") + var artifactType: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt new file mode 100644 index 00000000..4cccb7dc --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * 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 OCIPlatform( + // The CPU architecture, for example `amd64` or `ppc64`. + @Json(name = "architecture") + var architecture: kotlin.String? = null, + // The operating system, for example `linux` or `windows`. + @Json(name = "os") + var os: kotlin.String? = null, + // Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. + @Json(name = "os.version") + var osVersion: kotlin.String? = null, + // Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). + @Json(name = "os.features") + var osFeatures: kotlin.collections.MutableList? = null, + // Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. + @Json(name = "variant") + var variant: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt new file mode 100644 index 00000000..bb53783f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other. + * + * @param index + */ +@JsonClass(generateAdapter = true) +data class ObjectVersion( + @Json(name = "Index") + var index: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt new file mode 100644 index 00000000..df943de5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PeerInfo.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents one peer of an overlay network. + * + * @param name ID of the peer-node in the Swarm cluster. + * @param IP IP-address of the peer-node in the Swarm cluster. + */ +@JsonClass(generateAdapter = true) +data class PeerInfo( + // ID of the peer-node in the Swarm cluster. + @Json(name = "Name") + var name: kotlin.String? = null, + // IP-address of the peer-node in the Swarm cluster. + @Json(name = "IP") + var IP: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt new file mode 100644 index 00000000..58ce4588 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Represents a peer-node in the swarm + * + * @param nodeID Unique identifier of for this node in the swarm. + * @param addr IP address and ports at which this node can be reached. + */ +@JsonClass(generateAdapter = true) +data class PeerNode( + // Unique identifier of for this node in the swarm. + @Json(name = "NodeID") + var nodeID: kotlin.String? = null, + // IP address and ports at which this node can be reached. + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt new file mode 100644 index 00000000..b52d4bab --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Platform represents the platform (Arch/OS). + * + * @param architecture Architecture represents the hardware architecture (for example, `x86_64`). + * @param OS OS represents the Operating System (for example, `linux` or `windows`). + */ +@JsonClass(generateAdapter = true) +data class Platform( + // Architecture represents the hardware architecture (for example, `x86_64`). + @Json(name = "Architecture") + var architecture: kotlin.String? = null, + // OS represents the Operating System (for example, `linux` or `windows`). + @Json(name = "OS") + var OS: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt new file mode 100644 index 00000000..575ddd27 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A plugin for the Engine API + * + * @param name + * @param enabled True if the plugin is running. False if the plugin is not running, only installed. + * @param settings + * @param config + * @param id + * @param pluginReference plugin remote reference used to push/pull the plugin + */ +@JsonClass(generateAdapter = true) +data class Plugin( + @Json(name = "Name") + var name: kotlin.String, + // True if the plugin is running. False if the plugin is not running, only installed. + @Json(name = "Enabled") + var enabled: kotlin.Boolean, + @Json(name = "Settings") + var settings: PluginSettings, + @Json(name = "Config") + var config: PluginConfig, + @Json(name = "Id") + var id: kotlin.String? = null, + // plugin remote reference used to push/pull the plugin + @Json(name = "PluginReference") + var pluginReference: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt new file mode 100644 index 00000000..1e686c78 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt @@ -0,0 +1,72 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The config of a plugin. + * + * @param description + * @param documentation + * @param `interface` + * @param entrypoint + * @param workDir + * @param network + * @param linux + * @param propagatedMount + * @param ipcHost + * @param pidHost + * @param mounts + * @param env + * @param args + * @param user + * @param rootfs + */ +@JsonClass(generateAdapter = true) +data class PluginConfig( + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Documentation") + var documentation: kotlin.String, + @Json(name = "Interface") + var `interface`: PluginConfigInterface, + @Json(name = "Entrypoint") + var entrypoint: kotlin.collections.MutableList, + @Json(name = "WorkDir") + var workDir: kotlin.String, + @Json(name = "Network") + var network: PluginConfigNetwork, + @Json(name = "Linux") + var linux: PluginConfigLinux, + @Json(name = "PropagatedMount") + var propagatedMount: kotlin.String, + @Json(name = "IpcHost") + var ipcHost: kotlin.Boolean, + @Json(name = "PidHost") + var pidHost: kotlin.Boolean, + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList, + @Json(name = "Env") + var env: kotlin.collections.MutableList, + @Json(name = "Args") + var args: PluginConfigArgs, + @Json(name = "User") + var user: PluginConfigUser? = null, + @Json(name = "rootfs") + var rootfs: PluginConfigRootfs? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt new file mode 100644 index 00000000..706830ad --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class PluginConfigArgs( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Value") + var `value`: kotlin.collections.MutableList, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt new file mode 100644 index 00000000..8ca95a80 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The interface between Docker and the plugin + * + * @param types + * @param socket + * @param protocolScheme Protocol to use for clients connecting to the plugin. + */ +@JsonClass(generateAdapter = true) +data class PluginConfigInterface( + @Json(name = "Types") + var types: kotlin.collections.MutableList, + @Json(name = "Socket") + var socket: kotlin.String, + // Protocol to use for clients connecting to the plugin. + @Json(name = "ProtocolScheme") + var protocolScheme: PluginConfigInterface.ProtocolScheme? = null, +) { + /** + * Protocol to use for clients connecting to the plugin. + * + * Values: EMPTY,MobyPeriodPluginsPeriodHttpSlashV1 + */ + @JsonClass(generateAdapter = false) + enum class ProtocolScheme(val value: kotlin.String) { + @Json(name = "") + EMPTY(""), + + @Json(name = "moby.plugins.http/v1") + MobyPeriodPluginsPeriodHttpSlashV1("moby.plugins.http/v1"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt new file mode 100644 index 00000000..9fb7723d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param capabilities + * @param allowAllDevices + * @param devices + */ +@JsonClass(generateAdapter = true) +data class PluginConfigLinux( + @Json(name = "Capabilities") + var capabilities: kotlin.collections.MutableList, + @Json(name = "AllowAllDevices") + var allowAllDevices: kotlin.Boolean, + @Json(name = "Devices") + var devices: kotlin.collections.MutableList, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt new file mode 100644 index 00000000..bcb6ee9d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param type + */ +@JsonClass(generateAdapter = true) +data class PluginConfigNetwork( + @Json(name = "Type") + var type: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt new file mode 100644 index 00000000..702b9d31 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param type + * @param diffIds + */ +@JsonClass(generateAdapter = true) +data class PluginConfigRootfs( + @Json(name = "type") + var type: kotlin.String? = null, + @Json(name = "diff_ids") + var diffIds: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt new file mode 100644 index 00000000..214dab67 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param UID + * @param GID + */ +@JsonClass(generateAdapter = true) +data class PluginConfigUser( + @Json(name = "UID") + var UID: kotlin.Int? = null, + @Json(name = "GID") + var GID: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt new file mode 100644 index 00000000..81fd97e5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param path + */ +@JsonClass(generateAdapter = true) +data class PluginDevice( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Path") + var path: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt new file mode 100644 index 00000000..d7eb7339 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class PluginEnv( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Value") + var `value`: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt new file mode 100644 index 00000000..e48cde1d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt @@ -0,0 +1,48 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + * @param description + * @param settable + * @param source + * @param destination + * @param type + * @param options + */ +@JsonClass(generateAdapter = true) +data class PluginMount( + @Json(name = "Name") + var name: kotlin.String, + @Json(name = "Description") + var description: kotlin.String, + @Json(name = "Settable") + var settable: kotlin.collections.MutableList, + @Json(name = "Source") + var source: kotlin.String, + @Json(name = "Destination") + var destination: kotlin.String, + @Json(name = "Type") + var type: kotlin.String, + @Json(name = "Options") + var options: kotlin.collections.MutableList, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt new file mode 100644 index 00000000..79ee4629 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Describes a permission the user has to accept upon installing the plugin. + * + * @param name + * @param description + * @param `value` + */ +@JsonClass(generateAdapter = true) +data class PluginPrivilege( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "Description") + var description: kotlin.String? = null, + @Json(name = "Value") + var `value`: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt new file mode 100644 index 00000000..1dc612b1 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * user-configurable settings for the plugin. + * + * @param mounts + * @param env + * @param args + * @param devices + */ +@JsonClass(generateAdapter = true) +data class PluginSettings( + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList, + @Json(name = "Env") + var env: kotlin.collections.MutableList, + @Json(name = "Args") + var args: kotlin.collections.MutableList, + @Json(name = "Devices") + var devices: kotlin.collections.MutableList, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt new file mode 100644 index 00000000..fc28f877 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Available plugins per type.


> **Note**: Only unmanaged (V1) plugins are included in this list. > V1 plugins are \"lazily\" loaded, and are not returned in this list > if there is no resource using the plugin. + * + * @param volume Names of available volume-drivers, and network-driver plugins. + * @param network Names of available network-drivers, and network-driver plugins. + * @param authorization Names of available authorization plugins. + * @param log Names of available logging-drivers, and logging-driver plugins. + */ +@JsonClass(generateAdapter = true) +data class PluginsInfo( + // Names of available volume-drivers, and network-driver plugins. + @Json(name = "Volume") + var volume: kotlin.collections.MutableList? = null, + // Names of available network-drivers, and network-driver plugins. + @Json(name = "Network") + var network: kotlin.collections.MutableList? = null, + // Names of available authorization plugins. + @Json(name = "Authorization") + var authorization: kotlin.collections.MutableList? = null, + // Names of available logging-drivers, and logging-driver plugins. + @Json(name = "Log") + var log: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt new file mode 100644 index 00000000..52f217a3 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * PortBinding represents a binding between a host IP address and a host port. + * + * @param hostIp Host IP address that the container's port is mapped to. + * @param hostPort Host port number that the container's port is mapped to. + */ +@JsonClass(generateAdapter = true) +data class PortBinding( + // Host IP address that the container's port is mapped to. + @Json(name = "HostIp") + var hostIp: kotlin.String? = null, + // Host port number that the container's port is mapped to. + @Json(name = "HostPort") + var hostPort: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt new file mode 100644 index 00000000..10c1cb5d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortStatus.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents the port status of a task's host ports whose service has published host ports + * + * @param ports + */ +@JsonClass(generateAdapter = true) +data class PortStatus( + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortSummary.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortSummary.kt new file mode 100644 index 00000000..25ac12c4 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PortSummary.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Describes a port-mapping between the container and the host. + * + * @param privatePort Port on the container + * @param type + * @param IP Host IP address that the container's port is mapped to + * @param publicPort Port exposed on the host + */ +@JsonClass(generateAdapter = true) +data class PortSummary( + // Port on the container + @Json(name = "PrivatePort") + var privatePort: kotlin.Int, + @Json(name = "Type") + var type: PortSummary.Type, + // Host IP address that the container's port is mapped to + @Json(name = "IP") + var IP: kotlin.String? = null, + // Port exposed on the host + @Json(name = "PublicPort") + var publicPort: kotlin.Int? = null, +) { + /** + * + * + * Values: Tcp,Udp,Sctp + */ + @JsonClass(generateAdapter = false) + enum class Type(val value: kotlin.String) { + @Json(name = "tcp") + Tcp("tcp"), + + @Json(name = "udp") + Udp("udp"), + + @Json(name = "sctp") + Sctp("sctp"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt new file mode 100644 index 00000000..9ed2b6a5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param privileged + * @param user + * @param tty + * @param entrypoint + * @param arguments + */ +@JsonClass(generateAdapter = true) +data class ProcessConfig( + @Json(name = "privileged") + var privileged: kotlin.Boolean? = null, + @Json(name = "user") + var user: kotlin.String? = null, + @Json(name = "tty") + var tty: kotlin.Boolean? = null, + @Json(name = "entrypoint") + var entrypoint: kotlin.String? = null, + @Json(name = "arguments") + var arguments: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt new file mode 100644 index 00000000..86795046 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param current + * @param total + */ +@JsonClass(generateAdapter = true) +data class ProgressDetail( + @Json(name = "current") + var current: kotlin.Int? = null, + @Json(name = "total") + var total: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt new file mode 100644 index 00000000..83ca0216 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param errorDetail + * @param status + * @param progressDetail + */ +@JsonClass(generateAdapter = true) +data class PushImageInfo( + @Json(name = "errorDetail") + var errorDetail: ErrorDetail? = null, + @Json(name = "status") + var status: kotlin.String? = null, + @Json(name = "progressDetail") + var progressDetail: ProgressDetail? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt new file mode 100644 index 00000000..d0a61bd8 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt @@ -0,0 +1,65 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Reachability represents the reachability of a node. + * + * Values: Unknown,Unreachable,Reachable + */ + +@JsonClass(generateAdapter = false) +enum class Reachability(val value: kotlin.String) { + @Json(name = "unknown") + Unknown("unknown"), + + @Json(name = "unreachable") + Unreachable("unreachable"), + + @Json(name = "reachable") + Reachable("reachable"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is Reachability) "$data" else null + + /** + * Returns a valid [Reachability] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): Reachability? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt new file mode 100644 index 00000000..2506be18 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt @@ -0,0 +1,38 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * RegistryServiceConfig stores daemon registry services configuration. + * + * @param insecureRegistryCIDRs List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`::1/128` and `127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. + * @param indexConfigs + * @param mirrors List of registry URLs that act as a mirror for the official (`docker.io`) registry. + */ +@JsonClass(generateAdapter = true) +data class RegistryServiceConfig( + // List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`::1/128` and `127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`. > **Warning**: Using this option can be useful when running a local > registry, but introduces security vulnerabilities. This option > should therefore ONLY be used for testing purposes. For increased > security, users should add their CA to their system's list of trusted > CAs instead of enabling this option. + @Json(name = "InsecureRegistryCIDRs") + var insecureRegistryCIDRs: kotlin.collections.MutableList? = null, + @Json(name = "IndexConfigs") + var indexConfigs: kotlin.collections.MutableMap? = null, + // List of registry URLs that act as a mirror for the official (`docker.io`) registry. + @Json(name = "Mirrors") + var mirrors: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt new file mode 100644 index 00000000..78b6426d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt @@ -0,0 +1,37 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * An object describing the resources which can be advertised by a node and requested by a task. + * + * @param nanoCPUs + * @param memoryBytes + * @param genericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + */ +@JsonClass(generateAdapter = true) +data class ResourceObject( + @Json(name = "NanoCPUs") + var nanoCPUs: kotlin.Long? = null, + @Json(name = "MemoryBytes") + var memoryBytes: kotlin.Long? = null, + // User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + @Json(name = "GenericResources") + var genericResources: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt new file mode 100644 index 00000000..52fdc408 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt @@ -0,0 +1,147 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A container's resources (cgroups config, ulimits, etc) + * + * @param cpuShares An integer value representing this container's relative CPU weight versus other containers. + * @param memory Memory limit in bytes. + * @param cgroupParent Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + * @param blkioWeight Block IO weight (relative weight). + * @param blkioWeightDevice Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + * @param blkioDeviceReadBps Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteBps Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceReadIOps Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param blkioDeviceWriteIOps Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + * @param cpuPeriod The length of a CPU period in microseconds. + * @param cpuQuota Microseconds of CPU time that the container can get in a CPU period. + * @param cpuRealtimePeriod The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpuRealtimeRuntime The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + * @param cpusetCpus CPUs in which to allow execution (e.g., `0-3`, `0,1`). + * @param cpusetMems Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + * @param devices A list of devices to add to the container. + * @param deviceCgroupRules a list of cgroup rules to apply to the container + * @param deviceRequests A list of requests for devices to be sent to device drivers. + * @param memoryReservation Memory soft limit in bytes. + * @param memorySwap Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + * @param memorySwappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + * @param nanoCpus CPU quota in units of 10-9 CPUs. + * @param oomKillDisable Disable OOM Killer for the container. + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param pidsLimit Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + * @param ulimits A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + * @param cpuCount The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param cpuPercent The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + * @param ioMaximumIOps Maximum IOps for the container system drive (Windows only) + * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). + */ +@JsonClass(generateAdapter = true) +data class Resources( + // An integer value representing this container's relative CPU weight versus other containers. + @Json(name = "CpuShares") + var cpuShares: kotlin.Int? = null, + // Memory limit in bytes. + @Json(name = "Memory") + var memory: kotlin.Long? = 0L, + // Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist. + @Json(name = "CgroupParent") + var cgroupParent: kotlin.String? = null, + // Block IO weight (relative weight). + @Json(name = "BlkioWeight") + var blkioWeight: kotlin.Int? = null, + // Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` + @Json(name = "BlkioWeightDevice") + var blkioWeightDevice: kotlin.collections.MutableList? = null, + // Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadBps") + var blkioDeviceReadBps: kotlin.collections.MutableList? = null, + // Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteBps") + var blkioDeviceWriteBps: kotlin.collections.MutableList? = null, + // Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceReadIOps") + var blkioDeviceReadIOps: kotlin.collections.MutableList? = null, + // Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` + @Json(name = "BlkioDeviceWriteIOps") + var blkioDeviceWriteIOps: kotlin.collections.MutableList? = null, + // The length of a CPU period in microseconds. + @Json(name = "CpuPeriod") + var cpuPeriod: kotlin.Long? = null, + // Microseconds of CPU time that the container can get in a CPU period. + @Json(name = "CpuQuota") + var cpuQuota: kotlin.Long? = null, + // The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimePeriod") + var cpuRealtimePeriod: kotlin.Long? = null, + // The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. + @Json(name = "CpuRealtimeRuntime") + var cpuRealtimeRuntime: kotlin.Long? = null, + // CPUs in which to allow execution (e.g., `0-3`, `0,1`). + @Json(name = "CpusetCpus") + var cpusetCpus: kotlin.String? = null, + // Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. + @Json(name = "CpusetMems") + var cpusetMems: kotlin.String? = null, + // A list of devices to add to the container. + @Json(name = "Devices") + var devices: kotlin.collections.MutableList? = null, + // a list of cgroup rules to apply to the container + @Json(name = "DeviceCgroupRules") + var deviceCgroupRules: kotlin.collections.MutableList? = null, + // A list of requests for devices to be sent to device drivers. + @Json(name = "DeviceRequests") + var deviceRequests: kotlin.collections.MutableList? = null, + // Memory soft limit in bytes. + @Json(name = "MemoryReservation") + var memoryReservation: kotlin.Long? = null, + // Total memory limit (memory + swap). Set as `-1` to enable unlimited swap. + @Json(name = "MemorySwap") + var memorySwap: kotlin.Long? = null, + // Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, + // CPU quota in units of 10-9 CPUs. + @Json(name = "NanoCpus") + var nanoCpus: kotlin.Long? = null, + // Disable OOM Killer for the container. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not change. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Long? = null, + // A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, + // The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuCount") + var cpuCount: kotlin.Long? = null, + // The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and `CPUPercent` last. + @Json(name = "CpuPercent") + var cpuPercent: kotlin.Long? = null, + // Maximum IOps for the container system drive (Windows only) + @Json(name = "IOMaximumIOps") + var ioMaximumIOps: kotlin.Long? = null, + // Maximum IO in bytes per second for the container system drive (Windows only). + @Json(name = "IOMaximumBandwidth") + var ioMaximumBandwidth: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt new file mode 100644 index 00000000..007f3f33 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param path + * @param weight + */ +@JsonClass(generateAdapter = true) +data class ResourcesBlkioWeightDeviceInner( + @Json(name = "Path") + var path: kotlin.String? = null, + @Json(name = "Weight") + var weight: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt new file mode 100644 index 00000000..b2c427a1 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of ulimit + * @param soft Soft limit + * @param hard Hard limit + */ +@JsonClass(generateAdapter = true) +data class ResourcesUlimitsInner( + // Name of ulimit + @Json(name = "Name") + var name: kotlin.String? = null, + // Soft limit + @Json(name = "Soft") + var soft: kotlin.Int? = null, + // Hard limit + @Json(name = "Hard") + var hard: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt new file mode 100644 index 00000000..2101db69 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt @@ -0,0 +1,58 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +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 - `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 - `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") + var name: RestartPolicy.Name? = null, + // If `on-failure` is used, the number of times to retry before giving up. + @Json(name = "MaximumRetryCount") + var maximumRetryCount: kotlin.Int? = null, +) { + /** + * - 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,UnlessStopped,OnFailure + */ + @JsonClass(generateAdapter = false) + enum class Name(val value: kotlin.String) { + @Json(name = "") + EMPTY(""), + + @Json(name = "no") + No("no"), + + @Json(name = "always") + Always("always"), + + @Json(name = "unless-stopped") + UnlessStopped("unless-stopped"), + + @Json(name = "on-failure") + OnFailure("on-failure"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorage.kt new file mode 100644 index 00000000..3c9764da --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorage.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the storage used for the container's root filesystem. + * + * @param snapshot + */ +@JsonClass(generateAdapter = true) +data class RootFSStorage( + @Json(name = "Snapshot") + var snapshot: RootFSStorageSnapshot? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorageSnapshot.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorageSnapshot.kt new file mode 100644 index 00000000..e2387a9a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/RootFSStorageSnapshot.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about a snapshot backend of the container's root filesystem. + * + * @param name Name of the snapshotter. + */ +@JsonClass(generateAdapter = true) +data class RootFSStorageSnapshot( + // Name of the snapshotter. + @Json(name = "Name") + var name: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt new file mode 100644 index 00000000..8ba7ba52 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime. The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux. + * + * @param path Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + * @param runtimeArgs List of command-line arguments to pass to the runtime when invoked. + * @param status Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + */ +@JsonClass(generateAdapter = true) +data class Runtime( + // Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + @Json(name = "path") + var path: kotlin.String? = null, + // List of command-line arguments to pass to the runtime when invoked. + @Json(name = "runtimeArgs") + var runtimeArgs: kotlin.collections.MutableList? = null, + // Information specific to the runtime. While this API specification does not define data provided by runtimes, the following well-known properties may be provided by runtimes: `org.opencontainers.runtime-spec.features`: features structure as defined in the [OCI Runtime Specification](https://github.com/opencontainers/runtime-spec/blob/main/features.md), in a JSON string representation.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + @Json(name = "status") + var status: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt new file mode 100644 index 00000000..2a4c8cf9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt + * @param updatedAt + * @param spec + */ +@JsonClass(generateAdapter = true) +data class Secret( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: SecretSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt new file mode 100644 index 00000000..5d90b996 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the secret. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + * @param driver + * @param templating + */ +@JsonClass(generateAdapter = true) +data class SecretCreateRequest( + // User-defined name of the secret. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Driver") + var driver: Driver? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt new file mode 100644 index 00000000..bd21501a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name User-defined name of the secret. + * @param labels User-defined key/value metadata. + * @param `data` Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + * @param driver + * @param templating + */ +@JsonClass(generateAdapter = true) +data class SecretSpec( + // User-defined name of the secret. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // Data is the data to store as a secret, formatted as a Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) string. It must be empty if the Driver field is set, in which case the data is loaded from an external secret store. The maximum allowed size is 500KB, as defined in [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2@v2.0.0/api/validation#MaxSecretSize). This field is only used to _create_ a secret, and is not returned by other endpoints. + @Json(name = "Data") + var `data`: kotlin.String? = null, + @Json(name = "Driver") + var driver: Driver? = null, + @Json(name = "Templating") + var templating: Driver? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt new file mode 100644 index 00000000..0e09952c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID + * @param version + * @param createdAt + * @param updatedAt + * @param spec + * @param endpoint + * @param updateStatus + * @param serviceStatus + * @param jobStatus + */ +@JsonClass(generateAdapter = true) +data class Service( + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: ServiceSpec? = null, + @Json(name = "Endpoint") + var endpoint: ServiceEndpoint? = null, + @Json(name = "UpdateStatus") + var updateStatus: ServiceUpdateStatus? = null, + @Json(name = "ServiceStatus") + var serviceStatus: ServiceServiceStatus? = null, + @Json(name = "JobStatus") + var jobStatus: ServiceJobStatus? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt new file mode 100644 index 00000000..ce0b2158 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the service. + * @param labels User-defined key/value metadata. + * @param taskTemplate + * @param mode + * @param updateConfig + * @param rollbackConfig + * @param networks Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + * @param endpointSpec + */ +@JsonClass(generateAdapter = true) +data class ServiceCreateRequest( + // Name of the service. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "TaskTemplate") + var taskTemplate: TaskSpec? = null, + @Json(name = "Mode") + var mode: ServiceSpecMode? = null, + @Json(name = "UpdateConfig") + var updateConfig: ServiceSpecUpdateConfig? = null, + @Json(name = "RollbackConfig") + var rollbackConfig: ServiceSpecRollbackConfig? = null, + // Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") + var endpointSpec: EndpointSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt new file mode 100644 index 00000000..97f46e77 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * contains the information returned to a client on the creation of a new service. + * + * @param ID The ID of the created service. + * @param warnings Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. + */ +@JsonClass(generateAdapter = true) +data class ServiceCreateResponse( + // The ID of the created service. + @Json(name = "ID") + var ID: kotlin.String? = null, + // Optional warning message. FIXME(thaJeztah): this should have \"omitempty\" in the generated type. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt new file mode 100644 index 00000000..e092e803 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt @@ -0,0 +1,36 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param spec + * @param ports + * @param virtualIPs + */ +@JsonClass(generateAdapter = true) +data class ServiceEndpoint( + @Json(name = "Spec") + var spec: EndpointSpec? = null, + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, + @Json(name = "VirtualIPs") + var virtualIPs: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt new file mode 100644 index 00000000..44dff832 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param networkID + * @param addr + */ +@JsonClass(generateAdapter = true) +data class ServiceEndpointVirtualIPsInner( + @Json(name = "NetworkID") + var networkID: kotlin.String? = null, + @Json(name = "Addr") + var addr: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceInfo.kt new file mode 100644 index 00000000..34485d9c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceInfo.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents service parameters with the list of service's tasks + * + * @param VIP + * @param ports + * @param localLBIndex + * @param tasks + */ +@JsonClass(generateAdapter = true) +data class ServiceInfo( + @Json(name = "VIP") + var VIP: kotlin.String? = null, + @Json(name = "Ports") + var ports: kotlin.collections.MutableList? = null, + @Json(name = "LocalLBIndex") + var localLBIndex: kotlin.Int? = null, + @Json(name = "Tasks") + var tasks: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt new file mode 100644 index 00000000..32f0dc3a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt @@ -0,0 +1,34 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service's version, does not need to be sent with an update request. + * + * @param jobIteration + * @param lastExecution The last time, as observed by the server, that this job was started. + */ +@JsonClass(generateAdapter = true) +data class ServiceJobStatus( + @Json(name = "JobIteration") + var jobIteration: ObjectVersion? = null, + // The last time, as observed by the server, that this job was started. + @Json(name = "LastExecution") + var lastExecution: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt new file mode 100644 index 00000000..05dc0d8b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The status of the service's tasks. Provided only when requested as part of a ServiceList operation. + * + * @param runningTasks The number of tasks for the service currently in the Running state. + * @param desiredTasks The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. + * @param completedTasks The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. + */ +@JsonClass(generateAdapter = true) +data class ServiceServiceStatus( + // The number of tasks for the service currently in the Running state. + @Json(name = "RunningTasks") + var runningTasks: kotlin.Int? = null, + // The number of tasks for the service desired to be running. For replicated services, this is the replica count from the service spec. For global services, this is computed by taking count of all tasks for the service with a Desired State other than Shutdown. + @Json(name = "DesiredTasks") + var desiredTasks: kotlin.Int? = null, + // The number of tasks for a job that are in the Completed state. This field must be cross-referenced with the service type, as the value of 0 may mean the service is not in a job mode, or it may mean the job-mode service has no tasks yet Completed. + @Json(name = "CompletedTasks") + var completedTasks: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt new file mode 100644 index 00000000..7d4a5e3a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * User modifiable configuration for a service. + * + * @param name Name of the service. + * @param labels User-defined key/value metadata. + * @param taskTemplate + * @param mode + * @param updateConfig + * @param rollbackConfig + * @param networks Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + * @param endpointSpec + */ +@JsonClass(generateAdapter = true) +data class ServiceSpec( + // Name of the service. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "TaskTemplate") + var taskTemplate: TaskSpec? = null, + @Json(name = "Mode") + var mode: ServiceSpecMode? = null, + @Json(name = "UpdateConfig") + var updateConfig: ServiceSpecUpdateConfig? = null, + @Json(name = "RollbackConfig") + var rollbackConfig: ServiceSpecRollbackConfig? = null, + // Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") + var endpointSpec: EndpointSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt new file mode 100644 index 00000000..cf729aa0 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt @@ -0,0 +1,40 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Scheduling mode for the service. + * + * @param replicated + * @param global + * @param replicatedJob + * @param globalJob The mode used for services which run a task to the completed state on each valid node. + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecMode( + @Json(name = "Replicated") + var replicated: ServiceSpecModeReplicated? = null, + @Json(name = "Global") + var global: kotlin.Any? = null, + @Json(name = "ReplicatedJob") + var replicatedJob: ServiceSpecModeReplicatedJob? = null, + // The mode used for services which run a task to the completed state on each valid node. + @Json(name = "GlobalJob") + var globalJob: kotlin.Any? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt new file mode 100644 index 00000000..ea25e561 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param replicas + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecModeReplicated( + @Json(name = "Replicas") + var replicas: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt new file mode 100644 index 00000000..d4f3427d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The mode used for services with a finite number of tasks that run to a completed state. + * + * @param maxConcurrent The maximum number of replicas to run simultaneously. + * @param totalCompletions The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecModeReplicatedJob( + // The maximum number of replicas to run simultaneously. + @Json(name = "MaxConcurrent") + var maxConcurrent: kotlin.Long? = 1L, + // The total number of replicas desired to reach the Completed state. If unset, will default to the value of `MaxConcurrent` + @Json(name = "TotalCompletions") + var totalCompletions: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt new file mode 100644 index 00000000..7bed7f83 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt @@ -0,0 +1,79 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for the rollback strategy of the service. + * + * @param parallelism Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). + * @param delay Amount of time between rollback iterations, in nanoseconds. + * @param failureAction Action to take if an rolled back task fails to run, or stops running during the rollback. + * @param monitor Amount of time to monitor each rolled back task for failures, in nanoseconds. + * @param maxFailureRatio The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. + * @param order The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecRollbackConfig( + // Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). + @Json(name = "Parallelism") + var parallelism: kotlin.Long? = null, + // Amount of time between rollback iterations, in nanoseconds. + @Json(name = "Delay") + var delay: kotlin.Long? = null, + // Action to take if an rolled back task fails to run, or stops running during the rollback. + @Json(name = "FailureAction") + var failureAction: ServiceSpecRollbackConfig.FailureAction? = null, + // Amount of time to monitor each rolled back task for failures, in nanoseconds. + @Json(name = "Monitor") + var monitor: kotlin.Long? = null, + // The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. + @Json(name = "MaxFailureRatio") + var maxFailureRatio: java.math.BigDecimal? = null, + // The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + @Json(name = "Order") + var order: ServiceSpecRollbackConfig.Order? = null, +) { + /** + * Action to take if an rolled back task fails to run, or stops running during the rollback. + * + * Values: Continue,Pause + */ + @JsonClass(generateAdapter = false) + enum class FailureAction(val value: kotlin.String) { + @Json(name = "continue") + Continue("continue"), + + @Json(name = "pause") + Pause("pause"), + } + + /** + * The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + * + * Values: StopFirst,StartFirst + */ + @JsonClass(generateAdapter = false) + enum class Order(val value: kotlin.String) { + @Json(name = "stop-first") + StopFirst("stop-first"), + + @Json(name = "start-first") + StartFirst("start-first"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt new file mode 100644 index 00000000..45539520 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt @@ -0,0 +1,82 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for the update strategy of the service. + * + * @param parallelism Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). + * @param delay Amount of time between updates, in nanoseconds. + * @param failureAction Action to take if an updated task fails to run, or stops running during the update. + * @param monitor Amount of time to monitor each updated task for failures, in nanoseconds. + * @param maxFailureRatio The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. + * @param order The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + */ +@JsonClass(generateAdapter = true) +data class ServiceSpecUpdateConfig( + // Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). + @Json(name = "Parallelism") + var parallelism: kotlin.Long? = null, + // Amount of time between updates, in nanoseconds. + @Json(name = "Delay") + var delay: kotlin.Long? = null, + // Action to take if an updated task fails to run, or stops running during the update. + @Json(name = "FailureAction") + var failureAction: ServiceSpecUpdateConfig.FailureAction? = null, + // Amount of time to monitor each updated task for failures, in nanoseconds. + @Json(name = "Monitor") + var monitor: kotlin.Long? = null, + // The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. + @Json(name = "MaxFailureRatio") + var maxFailureRatio: java.math.BigDecimal? = null, + // The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + @Json(name = "Order") + var order: ServiceSpecUpdateConfig.Order? = null, +) { + /** + * Action to take if an updated task fails to run, or stops running during the update. + * + * Values: Continue,Pause,Rollback + */ + @JsonClass(generateAdapter = false) + enum class FailureAction(val value: kotlin.String) { + @Json(name = "continue") + Continue("continue"), + + @Json(name = "pause") + Pause("pause"), + + @Json(name = "rollback") + Rollback("rollback"), + } + + /** + * The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. + * + * Values: StopFirst,StartFirst + */ + @JsonClass(generateAdapter = false) + enum class Order(val value: kotlin.String) { + @Json(name = "stop-first") + StopFirst("stop-first"), + + @Json(name = "start-first") + StartFirst("start-first"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt new file mode 100644 index 00000000..e03dc048 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the service. + * @param labels User-defined key/value metadata. + * @param taskTemplate + * @param mode + * @param updateConfig + * @param rollbackConfig + * @param networks Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + * @param endpointSpec + */ +@JsonClass(generateAdapter = true) +data class ServiceUpdateRequest( + // Name of the service. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "TaskTemplate") + var taskTemplate: TaskSpec? = null, + @Json(name = "Mode") + var mode: ServiceSpecMode? = null, + @Json(name = "UpdateConfig") + var updateConfig: ServiceSpecUpdateConfig? = null, + @Json(name = "RollbackConfig") + var rollbackConfig: ServiceSpecRollbackConfig? = null, + // Specifies which networks the service should attach to. Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") + var endpointSpec: EndpointSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt new file mode 100644 index 00000000..338d2a20 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param warnings Optional warning messages + */ +@JsonClass(generateAdapter = true) +data class ServiceUpdateResponse( + // Optional warning messages + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt new file mode 100644 index 00000000..feaf2d12 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt @@ -0,0 +1,56 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The status of a service update. + * + * @param state + * @param startedAt + * @param completedAt + * @param message + */ +@JsonClass(generateAdapter = true) +data class ServiceUpdateStatus( + @Json(name = "State") + var state: ServiceUpdateStatus.State? = null, + @Json(name = "StartedAt") + var startedAt: kotlin.String? = null, + @Json(name = "CompletedAt") + var completedAt: kotlin.String? = null, + @Json(name = "Message") + var message: kotlin.String? = null, +) { + /** + * + * + * Values: Updating,Paused,Completed + */ + @JsonClass(generateAdapter = false) + enum class State(val value: kotlin.String) { + @Json(name = "updating") + Updating("updating"), + + @Json(name = "paused") + Paused("paused"), + + @Json(name = "completed") + Completed("completed"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Storage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Storage.kt new file mode 100644 index 00000000..b1407787 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Storage.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the storage used by the container. + * + * @param rootFS + */ +@JsonClass(generateAdapter = true) +data class Storage( + @Json(name = "RootFS") + var rootFS: RootFSStorage? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SubnetStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SubnetStatus.kt new file mode 100644 index 00000000..f9101988 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SubnetStatus.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ipsInUse Number of IP addresses in the subnet that are in use or reserved and are therefore unavailable for allocation, saturating at 264 - 1. + * @param dynamicIPsAvailable Number of IP addresses within the network's IPRange for the subnet that are available for allocation, saturating at 264 - 1. + */ +@JsonClass(generateAdapter = true) +data class SubnetStatus( + // Number of IP addresses in the subnet that are in use or reserved and are therefore unavailable for allocation, saturating at 264 - 1. + @Json(name = "IPsInUse") + var ipsInUse: kotlin.Int? = null, + // Number of IP addresses within the network's IPRange for the subnet that are available for allocation, saturating at 264 - 1. + @Json(name = "DynamicIPsAvailable") + var dynamicIPsAvailable: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt new file mode 100644 index 00000000..0340ecad --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt @@ -0,0 +1,67 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID The ID of the swarm. + * @param version + * @param createdAt Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param updatedAt Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param spec + * @param tlSInfo + * @param rootRotationInProgress Whether there is currently a root CA rotation in progress for the swarm + * @param dataPathPort 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, the default port (4789) is used. + * @param defaultAddrPool Default Address Pool specifies default subnet pools for global scope networks. + * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. + * @param joinTokens + */ +@JsonClass(generateAdapter = true) +data class Swarm( + // The ID of the swarm. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + // Date and time at which the swarm was initialised in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Date and time at which the swarm was last updated in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + @Json(name = "Spec") + var spec: SwarmSpec? = null, + @Json(name = "TLSInfo") + var tlSInfo: TLSInfo? = null, + // Whether there is currently a root CA rotation in progress for the swarm + @Json(name = "RootRotationInProgress") + var rootRotationInProgress: kotlin.Boolean? = null, + // 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, the default port (4789) is used. + @Json(name = "DataPathPort") + var dataPathPort: kotlin.Int? = null, + // Default Address Pool specifies default subnet pools for global scope networks. + @Json(name = "DefaultAddrPool") + var defaultAddrPool: kotlin.collections.MutableList? = null, + // SubnetSize specifies the subnet size of the networks created from the default subnet pool. + @Json(name = "SubnetSize") + var subnetSize: kotlin.Int? = null, + @Json(name = "JoinTokens") + var joinTokens: JoinTokens? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt new file mode 100644 index 00000000..4404fe93 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt @@ -0,0 +1,59 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Represents generic information about swarm. + * + * @param nodeID Unique identifier of for this node in the swarm. + * @param nodeAddr IP address at which this node can be reached by other nodes in the swarm. + * @param localNodeState + * @param controlAvailable + * @param error + * @param remoteManagers List of ID's and addresses of other managers in the swarm. + * @param nodes Total number of nodes in the swarm. + * @param managers Total number of managers in the swarm. + * @param cluster + */ +@JsonClass(generateAdapter = true) +data class SwarmInfo( + // Unique identifier of for this node in the swarm. + @Json(name = "NodeID") + var nodeID: kotlin.String? = "", + // IP address at which this node can be reached by other nodes in the swarm. + @Json(name = "NodeAddr") + var nodeAddr: kotlin.String? = "", + @Json(name = "LocalNodeState") + var localNodeState: LocalNodeState? = LocalNodeState.EMPTY, + @Json(name = "ControlAvailable") + var controlAvailable: kotlin.Boolean? = false, + @Json(name = "Error") + var error: kotlin.String? = "", + // List of ID's and addresses of other managers in the swarm. + @Json(name = "RemoteManagers") + var remoteManagers: kotlin.collections.MutableList? = null, + // Total number of nodes in the swarm. + @Json(name = "Nodes") + var nodes: kotlin.Int? = null, + // Total number of managers in the swarm. + @Json(name = "Managers") + var managers: kotlin.Int? = null, + @Json(name = "Cluster") + var cluster: ClusterInfo? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt new file mode 100644 index 00000000..d3fc924d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt @@ -0,0 +1,58 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param listenAddr 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. + * @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 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 dataPathPort 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. + * @param defaultAddrPool Default Address Pool specifies default subnet pools for global scope networks. + * @param forceNewCluster Force creation of a new swarm. + * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. + * @param spec + */ +@JsonClass(generateAdapter = true) +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") + var 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") + var 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 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") + var dataPathAddr: kotlin.String? = null, + // 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. + @Json(name = "DataPathPort") + var dataPathPort: kotlin.Int? = null, + // Default Address Pool specifies default subnet pools for global scope networks. + @Json(name = "DefaultAddrPool") + var defaultAddrPool: kotlin.collections.MutableList? = null, + // Force creation of a new swarm. + @Json(name = "ForceNewCluster") + var forceNewCluster: kotlin.Boolean? = null, + // SubnetSize specifies the subnet size of the networks created from the default subnet pool. + @Json(name = "SubnetSize") + var subnetSize: kotlin.Int? = null, + @Json(name = "Spec") + var spec: SwarmSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt new file mode 100644 index 00000000..a8b67cd2 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +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 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 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") + var 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") + var 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 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") + var dataPathAddr: kotlin.String? = null, + // Addresses of manager nodes already participating in the swarm. + @Json(name = "RemoteAddrs") + var remoteAddrs: kotlin.collections.MutableList? = null, + // Secret token for joining this swarm. + @Json(name = "JoinToken") + var joinToken: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt new file mode 100644 index 00000000..e7611d04 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt @@ -0,0 +1,53 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * User modifiable swarm configuration. + * + * @param name Name of the swarm. + * @param labels User-defined key/value metadata. + * @param orchestration + * @param raft + * @param dispatcher + * @param caConfig + * @param encryptionConfig + * @param taskDefaults + */ +@JsonClass(generateAdapter = true) +data class SwarmSpec( + // Name of the swarm. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Orchestration") + var orchestration: SwarmSpecOrchestration? = null, + @Json(name = "Raft") + var raft: SwarmSpecRaft? = null, + @Json(name = "Dispatcher") + var dispatcher: SwarmSpecDispatcher? = null, + @Json(name = "CAConfig") + var caConfig: SwarmSpecCAConfig? = null, + @Json(name = "EncryptionConfig") + var encryptionConfig: SwarmSpecEncryptionConfig? = null, + @Json(name = "TaskDefaults") + var taskDefaults: SwarmSpecTaskDefaults? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt new file mode 100644 index 00000000..997c7d54 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * CA configuration. + * + * @param nodeCertExpiry The duration node certificates are issued for. + * @param externalCAs Configuration for forwarding signing requests to an external certificate authority. + * @param signingCACert The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. + * @param signingCAKey The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. + * @param forceRotate An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecCAConfig( + // The duration node certificates are issued for. + @Json(name = "NodeCertExpiry") + var nodeCertExpiry: kotlin.Long? = null, + // Configuration for forwarding signing requests to an external certificate authority. + @Json(name = "ExternalCAs") + var externalCAs: kotlin.collections.MutableList? = null, + // The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. + @Json(name = "SigningCACert") + var signingCACert: kotlin.String? = null, + // The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. + @Json(name = "SigningCAKey") + var signingCAKey: kotlin.String? = null, + // An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` + @Json(name = "ForceRotate") + var forceRotate: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt new file mode 100644 index 00000000..8b89b67c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt @@ -0,0 +1,54 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param protocol Protocol for communication with the external CA (currently only `cfssl` is supported). + * @param URL URL where certificate signing requests should be sent. + * @param options An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. + * @param caCert The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecCAConfigExternalCAsInner( + // Protocol for communication with the external CA (currently only `cfssl` is supported). + @Json(name = "Protocol") + var protocol: SwarmSpecCAConfigExternalCAsInner.Protocol? = Protocol.Cfssl, + // URL where certificate signing requests should be sent. + @Json(name = "URL") + var URL: kotlin.String? = null, + // An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, + // The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). + @Json(name = "CACert") + var caCert: kotlin.String? = null, +) { + /** + * Protocol for communication with the external CA (currently only `cfssl` is supported). + * + * Values: Cfssl + */ + @JsonClass(generateAdapter = false) + enum class Protocol(val value: kotlin.String) { + @Json(name = "cfssl") + Cfssl("cfssl"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt new file mode 100644 index 00000000..f61ca41e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Dispatcher configuration. + * + * @param heartbeatPeriod The delay for an agent to send a heartbeat to the dispatcher. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecDispatcher( + // The delay for an agent to send a heartbeat to the dispatcher. + @Json(name = "HeartbeatPeriod") + var heartbeatPeriod: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt new file mode 100644 index 00000000..a47b3291 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Parameters related to encryption-at-rest. + * + * @param autoLockManagers If set, generate a key and use it to lock data stored on the managers. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecEncryptionConfig( + // If set, generate a key and use it to lock data stored on the managers. + @Json(name = "AutoLockManagers") + var autoLockManagers: kotlin.Boolean? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt new file mode 100644 index 00000000..6150ccf4 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Orchestration configuration. + * + * @param taskHistoryRetentionLimit The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecOrchestration( + // The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks. + @Json(name = "TaskHistoryRetentionLimit") + var taskHistoryRetentionLimit: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt new file mode 100644 index 00000000..3a632d48 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Raft configuration. + * + * @param snapshotInterval The number of log entries between snapshots. + * @param keepOldSnapshots The number of snapshots to keep beyond the current snapshot. + * @param logEntriesForSlowFollowers The number of log entries to keep around to sync up slow followers after a snapshot is created. + * @param electionTick The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + * @param heartbeatTick The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecRaft( + // The number of log entries between snapshots. + @Json(name = "SnapshotInterval") + var snapshotInterval: kotlin.Int? = null, + // The number of snapshots to keep beyond the current snapshot. + @Json(name = "KeepOldSnapshots") + var keepOldSnapshots: kotlin.Int? = null, + // The number of log entries to keep around to sync up slow followers after a snapshot is created. + @Json(name = "LogEntriesForSlowFollowers") + var logEntriesForSlowFollowers: kotlin.Int? = null, + // The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. `ElectionTick` must be greater than `HeartbeatTick`. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + @Json(name = "ElectionTick") + var electionTick: kotlin.Int? = null, + // The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. + @Json(name = "HeartbeatTick") + var heartbeatTick: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt new file mode 100644 index 00000000..13ee5598 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Defaults for creating tasks in this cluster. + * + * @param logDriver + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecTaskDefaults( + @Json(name = "LogDriver") + var logDriver: SwarmSpecTaskDefaultsLogDriver? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt new file mode 100644 index 00000000..bd44aa93 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * The log driver to use for tasks created in the orchestrator if unspecified by a service. Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated. + * + * @param name The log driver to use as a default for new tasks. + * @param options Driver-specific options for the selected log driver, specified as key/value pairs. + */ +@JsonClass(generateAdapter = true) +data class SwarmSpecTaskDefaultsLogDriver( + // The log driver to use as a default for new tasks. + @Json(name = "Name") + var name: kotlin.String? = null, + // Driver-specific options for the selected log driver, specified as key/value pairs. + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt new file mode 100644 index 00000000..5252c113 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param unlockKey The swarm's unlock key. + */ +@JsonClass(generateAdapter = true) +data class SwarmUnlockRequest( + // The swarm's unlock key. + @Json(name = "UnlockKey") + var unlockKey: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt new file mode 100644 index 00000000..713f3b32 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param imagesDiskUsage + * @param containersDiskUsage + * @param volumesDiskUsage + * @param buildCacheDiskUsage + */ +@JsonClass(generateAdapter = true) +data class SystemDataUsageResponse( + @Json(name = "ImagesDiskUsage") + var imagesDiskUsage: ImagesDiskUsage? = null, + @Json(name = "ContainersDiskUsage") + var containersDiskUsage: ContainersDiskUsage? = null, + @Json(name = "VolumesDiskUsage") + var volumesDiskUsage: VolumesDiskUsage? = null, + @Json(name = "BuildCacheDiskUsage") + var buildCacheDiskUsage: BuildCacheDiskUsage? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt new file mode 100644 index 00000000..1326afe5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt @@ -0,0 +1,314 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID Unique identifier of the daemon.


> **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. + * @param containers Total number of containers on the host. + * @param containersRunning Number of containers with status `\"running\"`. + * @param containersPaused Number of containers with status `\"paused\"`. + * @param containersStopped Number of containers with status `\"stopped\"`. + * @param images Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. + * @param driver Name of the storage driver in use. + * @param driverStatus Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + * @param dockerRootDir Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. + * @param plugins + * @param memoryLimit Indicates if the host has memory limit support enabled. + * @param swapLimit Indicates if the host has memory swap limit support enabled. + * @param cpuCfsPeriod Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. + * @param cpuCfsQuota Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. + * @param cpUShares Indicates if CPU Shares limiting is supported by the host. + * @param cpUSet Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) + * @param pidsLimit Indicates if the host kernel has PID limit support enabled. + * @param oomKillDisable Indicates if OOM killer disable is supported on the host. + * @param ipv4Forwarding Indicates IPv4 forwarding is enabled. + * @param debug Indicates if the daemon is running in debug-mode / with debug-level logging enabled. + * @param nfd The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. + * @param ngoroutines The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. + * @param systemTime Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + * @param loggingDriver The logging driver to use as a default for new containers. + * @param cgroupDriver The driver to use for managing cgroups. + * @param cgroupVersion The version of the cgroup. + * @param neventsListener Number of event listeners subscribed. + * @param kernelVersion Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\ registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. + * @param operatingSystem Name of the host's operating system, for example: \"Ubuntu 24.04 LTS\" or \"Windows Server 2016 Datacenter\" + * @param osVersion Version of the host's operating system


> **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. + * @param osType Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + * @param architecture Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + * @param NCPU The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. + * @param memTotal Total amount of physical memory available on the host, in bytes. + * @param indexServerAddress Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. + * @param registryConfig + * @param genericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + * @param httpProxy HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + * @param httpsProxy HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + * @param noProxy Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. + * @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. + * @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. + * @param defaultRuntime Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. + * @param swarm + * @param liveRestoreEnabled Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. + * @param isolation Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. + * @param initBinary Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + * @param containerdCommit + * @param runcCommit + * @param initCommit + * @param securityOptions List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. + * @param productLicense Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. + * @param defaultAddressPools List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. + * @param firewallBackend + * @param discoveredDevices List of devices discovered by device drivers. Each device includes information about its source driver, kind, name, and additional driver-specific attributes. + * @param warnings List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. + * @param cdISpecDirs List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. + * @param containerd + */ +@JsonClass(generateAdapter = true) +data class SystemInfo( + // Unique identifier of the daemon.


> **Note**: The format of the ID itself is not part of the API, and > should not be considered stable. + @Json(name = "ID") + var ID: kotlin.String? = null, + // Total number of containers on the host. + @Json(name = "Containers") + var containers: kotlin.Int? = null, + // Number of containers with status `\"running\"`. + @Json(name = "ContainersRunning") + var containersRunning: kotlin.Int? = null, + // Number of containers with status `\"paused\"`. + @Json(name = "ContainersPaused") + var containersPaused: kotlin.Int? = null, + // Number of containers with status `\"stopped\"`. + @Json(name = "ContainersStopped") + var containersStopped: kotlin.Int? = null, + // Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted. + @Json(name = "Images") + var images: kotlin.Int? = null, + // Name of the storage driver in use. + @Json(name = "Driver") + var driver: kotlin.String? = null, + // Information specific to the storage driver, provided as \"label\" / \"value\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.


> **Note**: The information returned in this field, including the > formatting of values and labels, should not be considered stable, > and may change without notice. + @Json(name = "DriverStatus") + var driverStatus: kotlin.collections.MutableList>? = null, + // Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker` on Windows. + @Json(name = "DockerRootDir") + var dockerRootDir: kotlin.String? = null, + @Json(name = "Plugins") + var plugins: PluginsInfo? = null, + // Indicates if the host has memory limit support enabled. + @Json(name = "MemoryLimit") + var memoryLimit: kotlin.Boolean? = null, + // Indicates if the host has memory swap limit support enabled. + @Json(name = "SwapLimit") + var swapLimit: kotlin.Boolean? = null, + // Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. + @Json(name = "CpuCfsPeriod") + var cpuCfsPeriod: kotlin.Boolean? = null, + // Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. + @Json(name = "CpuCfsQuota") + var cpuCfsQuota: kotlin.Boolean? = null, + // Indicates if CPU Shares limiting is supported by the host. + @Json(name = "CPUShares") + var cpUShares: kotlin.Boolean? = null, + // Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt) + @Json(name = "CPUSet") + var cpUSet: kotlin.Boolean? = null, + // Indicates if the host kernel has PID limit support enabled. + @Json(name = "PidsLimit") + var pidsLimit: kotlin.Boolean? = null, + // Indicates if OOM killer disable is supported on the host. + @Json(name = "OomKillDisable") + var oomKillDisable: kotlin.Boolean? = null, + // Indicates IPv4 forwarding is enabled. + @Json(name = "IPv4Forwarding") + var ipv4Forwarding: kotlin.Boolean? = null, + // Indicates if the daemon is running in debug-mode / with debug-level logging enabled. + @Json(name = "Debug") + var debug: kotlin.Boolean? = null, + // The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. + @Json(name = "NFd") + var nfd: kotlin.Int? = null, + // The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. + @Json(name = "NGoroutines") + var ngoroutines: kotlin.Int? = null, + // Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. + @Json(name = "SystemTime") + var systemTime: kotlin.String? = null, + // The logging driver to use as a default for new containers. + @Json(name = "LoggingDriver") + var loggingDriver: kotlin.String? = null, + // The driver to use for managing cgroups. + @Json(name = "CgroupDriver") + var cgroupDriver: SystemInfo.CgroupDriver? = CgroupDriver.Cgroupfs, + // The version of the cgroup. + @Json(name = "CgroupVersion") + var cgroupVersion: SystemInfo.CgroupVersion? = CgroupVersion.V1, + // Number of event listeners subscribed. + @Json(name = "NEventsListener") + var neventsListener: kotlin.Int? = null, + // Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\ registry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_. + @Json(name = "KernelVersion") + var kernelVersion: kotlin.String? = null, + // Name of the host's operating system, for example: \"Ubuntu 24.04 LTS\" or \"Windows Server 2016 Datacenter\" + @Json(name = "OperatingSystem") + var operatingSystem: kotlin.String? = null, + // Version of the host's operating system


> **Note**: The information returned in this field, including its > very existence, and the formatting of values, should not be considered > stable, and may change without notice. + @Json(name = "OSVersion") + var osVersion: kotlin.String? = null, + // Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \"linux\" and \"windows\". A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + @Json(name = "OSType") + var osType: kotlin.String? = null, + // Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://go.dev/doc/install/source#environment). + @Json(name = "Architecture") + var architecture: kotlin.String? = null, + // The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. + @Json(name = "NCPU") + var NCPU: kotlin.Int? = null, + // Total amount of physical memory available on the host, in bytes. + @Json(name = "MemTotal") + var memTotal: kotlin.Long? = null, + // Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. + @Json(name = "IndexServerAddress") + var indexServerAddress: kotlin.String? = "https://index.docker.io/v1/", + @Json(name = "RegistryConfig") + var registryConfig: RegistryServiceConfig? = null, + // User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + @Json(name = "GenericResources") + var genericResources: kotlin.collections.MutableList? = null, + // HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + @Json(name = "HttpProxy") + var httpProxy: kotlin.String? = null, + // HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration. + @Json(name = "HttpsProxy") + var httpsProxy: kotlin.String? = null, + // Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration. + @Json(name = "NoProxy") + var noProxy: kotlin.String? = null, + // Hostname of the host. + @Json(name = "Name") + var name: kotlin.String? = null, + // 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. + @Json(name = "Labels") + var labels: kotlin.collections.MutableList? = null, + // Indicates if experimental features are enabled on the daemon. + @Json(name = "ExperimentalBuild") + var experimentalBuild: kotlin.Boolean? = null, + // Version string of the daemon. + @Json(name = "ServerVersion") + var serverVersion: kotlin.String? = null, + // 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. + @Json(name = "Runtimes") + var runtimes: kotlin.collections.MutableMap? = null, + // Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. + @Json(name = "DefaultRuntime") + var defaultRuntime: kotlin.String? = "runc", + @Json(name = "Swarm") + var swarm: SwarmInfo? = null, + // Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. + @Json(name = "LiveRestoreEnabled") + var liveRestoreEnabled: kotlin.Boolean? = false, + // Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. + @Json(name = "Isolation") + var isolation: SystemInfo.Isolation? = Isolation.Default, + // Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result. + @Json(name = "InitBinary") + var initBinary: kotlin.String? = null, + @Json(name = "ContainerdCommit") + var containerdCommit: Commit? = null, + @Json(name = "RuncCommit") + var runcCommit: Commit? = null, + @Json(name = "InitCommit") + var initCommit: Commit? = null, + // List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. + @Json(name = "SecurityOptions") + var securityOptions: kotlin.collections.MutableList? = null, + // Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. + @Json(name = "ProductLicense") + var productLicense: kotlin.String? = null, + // List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. + @Json(name = "DefaultAddressPools") + var defaultAddressPools: kotlin.collections.MutableList? = null, + @Json(name = "FirewallBackend") + var firewallBackend: FirewallInfo? = null, + // List of devices discovered by device drivers. Each device includes information about its source driver, kind, name, and additional driver-specific attributes. + @Json(name = "DiscoveredDevices") + var discoveredDevices: kotlin.collections.MutableList? = null, + // List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, + // List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. + @Json(name = "CDISpecDirs") + var cdISpecDirs: kotlin.collections.MutableList? = null, + @Json(name = "Containerd") + var containerd: ContainerdInfo? = null, +) { + /** + * The driver to use for managing cgroups. + * + * Values: Cgroupfs,Systemd,None + */ + @JsonClass(generateAdapter = false) + enum class CgroupDriver(val value: kotlin.String) { + @Json(name = "cgroupfs") + Cgroupfs("cgroupfs"), + + @Json(name = "systemd") + Systemd("systemd"), + + @Json(name = "none") + None("none"), + } + + /** + * The version of the cgroup. + * + * Values: V1,V2 + */ + @JsonClass(generateAdapter = false) + enum class CgroupVersion(val value: kotlin.String) { + @Json(name = "1") + V1("1"), + + @Json(name = "2") + V2("2"), + } + + /** + * Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms. + * + * Values: Default,Hyperv,Process,EMPTY + */ + @JsonClass(generateAdapter = false) + enum class Isolation(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "hyperv") + Hyperv("hyperv"), + + @Json(name = "process") + Process("process"), + + @Json(name = "") + EMPTY(""), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt new file mode 100644 index 00000000..020a6ee8 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param base The network address in CIDR format + * @param propertySize The network pool size + */ +@JsonClass(generateAdapter = true) +data class SystemInfoDefaultAddressPoolsInner( + // The network address in CIDR format + @Json(name = "Base") + var base: kotlin.String? = null, + // The network pool size + @Json(name = "Size") + var propertySize: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt new file mode 100644 index 00000000..4625f802 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt @@ -0,0 +1,74 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Response of Engine API: GET \"/version\" + * + * @param platform + * @param components Information about system components + * @param version The version of the daemon + * @param apiVersion The default (and highest) API version that is supported by the daemon + * @param minAPIVersion The minimum API version that is supported by the daemon + * @param gitCommit The Git commit of the source code that was used to build the daemon + * @param goVersion The version Go used to compile the daemon, and the version of the Go runtime in use. + * @param os The operating system that the daemon is running on (\"linux\" or \"windows\") + * @param arch The architecture that the daemon is running on + * @param kernelVersion The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. + * @param experimental Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. + * @param buildTime The date and time that the daemon was compiled. + */ +@JsonClass(generateAdapter = true) +data class SystemVersion( + @Json(name = "Platform") + var platform: SystemVersionPlatform? = null, + // Information about system components + @Json(name = "Components") + var components: kotlin.collections.MutableList? = null, + // The version of the daemon + @Json(name = "Version") + var version: kotlin.String? = null, + // The default (and highest) API version that is supported by the daemon + @Json(name = "ApiVersion") + var apiVersion: kotlin.String? = null, + // The minimum API version that is supported by the daemon + @Json(name = "MinAPIVersion") + var minAPIVersion: kotlin.String? = null, + // The Git commit of the source code that was used to build the daemon + @Json(name = "GitCommit") + var gitCommit: kotlin.String? = null, + // The version Go used to compile the daemon, and the version of the Go runtime in use. + @Json(name = "GoVersion") + var goVersion: kotlin.String? = null, + // The operating system that the daemon is running on (\"linux\" or \"windows\") + @Json(name = "Os") + var os: kotlin.String? = null, + // The architecture that the daemon is running on + @Json(name = "Arch") + var arch: kotlin.String? = null, + // The kernel version (`uname -r`) that the daemon is running on. This field is omitted when empty. + @Json(name = "KernelVersion") + var kernelVersion: kotlin.String? = null, + // Indicates if the daemon is started with experimental features enabled. This field is omitted when empty / false. + @Json(name = "Experimental") + var experimental: kotlin.Boolean? = null, + // The date and time that the daemon was compiled. + @Json(name = "BuildTime") + var buildTime: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt new file mode 100644 index 00000000..3b69fcd9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the component + * @param version Version of the component + * @param details Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. + */ +@JsonClass(generateAdapter = true) +data class SystemVersionComponentsInner( + // Name of the component + @Json(name = "Name") + var name: kotlin.String, + // Version of the component + @Json(name = "Version") + var version: kotlin.String, + // Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. + @Json(name = "Details") + var details: kotlin.Any? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt new file mode 100644 index 00000000..3f4e6037 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name + */ +@JsonClass(generateAdapter = true) +data class SystemVersionPlatform( + @Json(name = "Name") + var name: kotlin.String, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt new file mode 100644 index 00000000..01248c68 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Information about the issuer of leaf TLS certificates and the trusted root CA certificate. + * + * @param trustRoot The root CA certificate(s) that are used to validate leaf TLS certificates. + * @param certIssuerSubject The base64-url-safe-encoded raw subject bytes of the issuer. + * @param certIssuerPublicKey The base64-url-safe-encoded raw public key bytes of the issuer. + */ +@JsonClass(generateAdapter = true) +data class TLSInfo( + // The root CA certificate(s) that are used to validate leaf TLS certificates. + @Json(name = "TrustRoot") + var trustRoot: kotlin.String? = null, + // The base64-url-safe-encoded raw subject bytes of the issuer. + @Json(name = "CertIssuerSubject") + var certIssuerSubject: kotlin.String? = null, + // The base64-url-safe-encoded raw public key bytes of the issuer. + @Json(name = "CertIssuerPublicKey") + var certIssuerPublicKey: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt new file mode 100644 index 00000000..61d83a42 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt @@ -0,0 +1,75 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param ID The ID of the task. + * @param version + * @param createdAt + * @param updatedAt + * @param name Name of the task. + * @param labels User-defined key/value metadata. + * @param spec + * @param serviceID The ID of the service this task is part of. + * @param slot + * @param nodeID The ID of the node that this task is on. + * @param assignedGenericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + * @param status + * @param desiredState + * @param jobIteration + */ +@JsonClass(generateAdapter = true) +data class Task( + // The ID of the task. + @Json(name = "ID") + var ID: kotlin.String? = null, + @Json(name = "Version") + var version: ObjectVersion? = null, + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + @Json(name = "UpdatedAt") + var updatedAt: kotlin.String? = null, + // Name of the task. + @Json(name = "Name") + var name: kotlin.String? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Spec") + var spec: TaskSpec? = null, + // The ID of the service this task is part of. + @Json(name = "ServiceID") + var serviceID: kotlin.String? = null, + @Json(name = "Slot") + var slot: kotlin.Int? = null, + // The ID of the node that this task is on. + @Json(name = "NodeID") + var nodeID: kotlin.String? = null, + // User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). + @Json(name = "AssignedGenericResources") + var assignedGenericResources: kotlin.collections.MutableList? = null, + @Json(name = "Status") + var status: TaskStatus? = null, + @Json(name = "DesiredState") + var desiredState: TaskState? = null, + @Json(name = "JobIteration") + var jobIteration: ObjectVersion? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt new file mode 100644 index 00000000..2596a359 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt @@ -0,0 +1,60 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * User modifiable task configuration. + * + * @param pluginSpec + * @param containerSpec + * @param networkAttachmentSpec + * @param resources + * @param restartPolicy + * @param placement + * @param forceUpdate A counter that triggers an update even if no relevant parameters have been changed. + * @param runtime Runtime is the type of runtime specified for the task executor. + * @param networks Specifies which networks the service should attach to. + * @param logDriver + */ +@JsonClass(generateAdapter = true) +data class TaskSpec( + @Json(name = "PluginSpec") + var pluginSpec: TaskSpecPluginSpec? = null, + @Json(name = "ContainerSpec") + var containerSpec: TaskSpecContainerSpec? = null, + @Json(name = "NetworkAttachmentSpec") + var networkAttachmentSpec: TaskSpecNetworkAttachmentSpec? = null, + @Json(name = "Resources") + var resources: TaskSpecResources? = null, + @Json(name = "RestartPolicy") + var restartPolicy: TaskSpecRestartPolicy? = null, + @Json(name = "Placement") + var placement: TaskSpecPlacement? = null, + // A counter that triggers an update even if no relevant parameters have been changed. + @Json(name = "ForceUpdate") + var forceUpdate: kotlin.Int? = null, + // Runtime is the type of runtime specified for the task executor. + @Json(name = "Runtime") + var runtime: kotlin.String? = null, + // Specifies which networks the service should attach to. + @Json(name = "Networks") + var networks: kotlin.collections.MutableList? = null, + @Json(name = "LogDriver") + var logDriver: TaskSpecLogDriver? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt new file mode 100644 index 00000000..a80f6849 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt @@ -0,0 +1,156 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Container spec for the service.


> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`. + * + * @param image The image name to use for the container + * @param labels User-defined key/value data. + * @param command The command to be run in the image. + * @param args Arguments to the command. + * @param hostname The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. + * @param env A list of environment variables in the form `VAR=value`. + * @param dir The working directory for commands to run in. + * @param user The user inside the container. + * @param groups A list of additional groups that the container process will run as. + * @param privileges + * @param TTY Whether a pseudo-TTY should be allocated. + * @param openStdin Open `stdin` + * @param readOnly Mount the container's root filesystem as read only. + * @param mounts Specification for mounts to be added to containers created as part of the service. + * @param stopSignal Signal to stop the container. + * @param stopGracePeriod Amount of time to wait for the container to terminate before forcefully killing it. + * @param healthCheck + * @param hosts A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] + * @param dnSConfig + * @param secrets Secrets contains references to zero or more secrets that will be exposed to the service. + * @param oomScoreAdj An integer value containing the score given to the container in order to tune OOM killer preferences. + * @param configs Configs contains references to zero or more configs that will be exposed to the service. + * @param isolation Isolation technology of the containers running the service. (Windows only) + * @param `init` Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + * @param sysctls Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. + * @param capabilityAdd A list of kernel capabilities to add to the default set for the container. + * @param capabilityDrop A list of kernel capabilities to drop from the default set for the container. + * @param ulimits A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpec( + // The image name to use for the container + @Json(name = "Image") + var image: kotlin.String? = null, + // User-defined key/value data. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // The command to be run in the image. + @Json(name = "Command") + var command: kotlin.collections.MutableList? = null, + // Arguments to the command. + @Json(name = "Args") + var args: kotlin.collections.MutableList? = null, + // The hostname to use for the container, as a valid [RFC 1123](https://tools.ietf.org/html/rfc1123) hostname. + @Json(name = "Hostname") + var hostname: kotlin.String? = null, + // A list of environment variables in the form `VAR=value`. + @Json(name = "Env") + var env: kotlin.collections.MutableList? = null, + // The working directory for commands to run in. + @Json(name = "Dir") + var dir: kotlin.String? = null, + // The user inside the container. + @Json(name = "User") + var user: kotlin.String? = null, + // A list of additional groups that the container process will run as. + @Json(name = "Groups") + var groups: kotlin.collections.MutableList? = null, + @Json(name = "Privileges") + var privileges: TaskSpecContainerSpecPrivileges? = null, + // Whether a pseudo-TTY should be allocated. + @Json(name = "TTY") + var TTY: kotlin.Boolean? = null, + // Open `stdin` + @Json(name = "OpenStdin") + var openStdin: kotlin.Boolean? = null, + // Mount the container's root filesystem as read only. + @Json(name = "ReadOnly") + var readOnly: kotlin.Boolean? = null, + // Specification for mounts to be added to containers created as part of the service. + @Json(name = "Mounts") + var mounts: kotlin.collections.MutableList? = null, + // Signal to stop the container. + @Json(name = "StopSignal") + var stopSignal: kotlin.String? = null, + // Amount of time to wait for the container to terminate before forcefully killing it. + @Json(name = "StopGracePeriod") + var stopGracePeriod: kotlin.Long? = null, + @Json(name = "HealthCheck") + var healthCheck: HealthConfig? = null, + // A list of hostname/IP mappings to add to the container's `hosts` file. The format of extra hosts is specified in the [hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html) man page: IP_address canonical_hostname [aliases] + @Json(name = "Hosts") + var hosts: kotlin.collections.MutableList? = null, + @Json(name = "DNSConfig") + var dnSConfig: TaskSpecContainerSpecDNSConfig? = null, + // Secrets contains references to zero or more secrets that will be exposed to the service. + @Json(name = "Secrets") + var secrets: kotlin.collections.MutableList? = null, + // An integer value containing the score given to the container in order to tune OOM killer preferences. + @Json(name = "OomScoreAdj") + var oomScoreAdj: kotlin.Long? = null, + // Configs contains references to zero or more configs that will be exposed to the service. + @Json(name = "Configs") + var configs: kotlin.collections.MutableList? = null, + // Isolation technology of the containers running the service. (Windows only) + @Json(name = "Isolation") + var isolation: TaskSpecContainerSpec.Isolation? = null, + // Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. + @Json(name = "Init") + var `init`: kotlin.Boolean? = null, + // Set kernel namedspaced parameters (sysctls) in the container. The Sysctls option on services accepts the same sysctls as the are supported on containers. Note that while the same sysctls are supported, no guarantees or checks are made about their suitability for a clustered environment, and it's up to the user to determine whether a given sysctl will work properly in a Service. + @Json(name = "Sysctls") + var sysctls: kotlin.collections.MutableMap? = null, + // A list of kernel capabilities to add to the default set for the container. + @Json(name = "CapabilityAdd") + var capabilityAdd: kotlin.collections.MutableList? = null, + // A list of kernel capabilities to drop from the default set for the container. + @Json(name = "CapabilityDrop") + var capabilityDrop: kotlin.collections.MutableList? = null, + // A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" + @Json(name = "Ulimits") + var ulimits: kotlin.collections.MutableList? = null, +) { + /** + * Isolation technology of the containers running the service. (Windows only) + * + * Values: Default,Process,Hyperv,EMPTY + */ + @JsonClass(generateAdapter = false) + enum class Isolation(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "process") + Process("process"), + + @Json(name = "hyperv") + Hyperv("hyperv"), + + @Json(name = "") + EMPTY(""), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt new file mode 100644 index 00000000..52cf4da7 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param file + * @param runtime Runtime represents a target that is not mounted into the container but is used by the task


> **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive + * @param configID ConfigID represents the ID of the specific config that we're referencing. + * @param configName ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecConfigsInner( + @Json(name = "File") + var file: TaskSpecContainerSpecConfigsInnerFile? = null, + // Runtime represents a target that is not mounted into the container but is used by the task


> **Note**: `Configs.File` and `Configs.Runtime` are mutually > exclusive + @Json(name = "Runtime") + var runtime: kotlin.Any? = null, + // ConfigID represents the ID of the specific config that we're referencing. + @Json(name = "ConfigID") + var configID: kotlin.String? = null, + // ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. + @Json(name = "ConfigName") + var configName: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt new file mode 100644 index 00000000..c57c6547 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * File represents a specific target that is backed by a file.


> **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive + * + * @param name Name represents the final filename in the filesystem. + * @param UID UID represents the file UID. + * @param GID GID represents the file GID. + * @param mode Mode represents the FileMode of the file. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecConfigsInnerFile( + // Name represents the final filename in the filesystem. + @Json(name = "Name") + var name: kotlin.String? = null, + // UID represents the file UID. + @Json(name = "UID") + var UID: kotlin.String? = null, + // GID represents the file GID. + @Json(name = "GID") + var GID: kotlin.String? = null, + // Mode represents the FileMode of the file. + @Json(name = "Mode") + var mode: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt new file mode 100644 index 00000000..48dfb94f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for DNS related configurations in resolver configuration file (`resolv.conf`). + * + * @param nameservers The IP addresses of the name servers. + * @param search A search list for host-name lookup. + * @param options A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecDNSConfig( + // The IP addresses of the name servers. + @Json(name = "Nameservers") + var nameservers: kotlin.collections.MutableList? = null, + // A search list for host-name lookup. + @Json(name = "Search") + var search: kotlin.collections.MutableList? = null, + // A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). + @Json(name = "Options") + var options: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt new file mode 100644 index 00000000..75f7f6b5 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Security options for the container + * + * @param credentialSpec + * @param seLinuxContext + * @param seccomp + * @param appArmor + * @param noNewPrivileges Configuration of the no_new_privs bit in the container + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivileges( + @Json(name = "CredentialSpec") + var credentialSpec: TaskSpecContainerSpecPrivilegesCredentialSpec? = null, + @Json(name = "SELinuxContext") + var seLinuxContext: TaskSpecContainerSpecPrivilegesSELinuxContext? = null, + @Json(name = "Seccomp") + var seccomp: TaskSpecContainerSpecPrivilegesSeccomp? = null, + @Json(name = "AppArmor") + var appArmor: TaskSpecContainerSpecPrivilegesAppArmor? = null, + // Configuration of the no_new_privs bit in the container + @Json(name = "NoNewPrivileges") + var noNewPrivileges: kotlin.Boolean? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt new file mode 100644 index 00000000..c0abe9d9 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesAppArmor.kt @@ -0,0 +1,44 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Options for configuring AppArmor on the container + * + * @param mode + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesAppArmor( + @Json(name = "Mode") + var mode: TaskSpecContainerSpecPrivilegesAppArmor.Mode? = null, +) { + /** + * + * + * Values: Default,Disabled + */ + @JsonClass(generateAdapter = false) + enum class Mode(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "disabled") + Disabled("disabled"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt new file mode 100644 index 00000000..3f3ddb8b --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt @@ -0,0 +1,39 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * CredentialSpec for managed service account (Windows only) + * + * @param config Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + * @param file Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + * @param registry Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs`


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesCredentialSpec( + // Load credential spec from a Swarm Config with the given ID. The specified config must also be present in the Configs field with the Runtime property set.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + @Json(name = "Config") + var config: kotlin.String? = null, + // Load credential spec from this file. The file is read by the daemon, and must be present in the `CredentialSpecs` subdirectory in the docker data directory, which defaults to `C:\\ProgramData\\Docker\\` on Windows. For example, specifying `spec.json` loads `C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`.


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + @Json(name = "File") + var file: kotlin.String? = null, + // Load credential spec from this value in the Windows registry. The specified registry value must be located in: `HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs`


> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`, > and `CredentialSpec.Config` are mutually exclusive. + @Json(name = "Registry") + var registry: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt new file mode 100644 index 00000000..4d1bc6e3 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * SELinux labels of the container + * + * @param disable Disable SELinux + * @param user SELinux user label + * @param role SELinux role label + * @param type SELinux type label + * @param level SELinux level label + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesSELinuxContext( + // Disable SELinux + @Json(name = "Disable") + var disable: kotlin.Boolean? = null, + // SELinux user label + @Json(name = "User") + var user: kotlin.String? = null, + // SELinux role label + @Json(name = "Role") + var role: kotlin.String? = null, + // SELinux type label + @Json(name = "Type") + var type: kotlin.String? = null, + // SELinux level label + @Json(name = "Level") + var level: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt new file mode 100644 index 00000000..1e97933d --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSeccomp.kt @@ -0,0 +1,51 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Options for configuring seccomp on the container + * + * @param mode + * @param profile The custom seccomp profile as a json object + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecPrivilegesSeccomp( + @Json(name = "Mode") + var mode: TaskSpecContainerSpecPrivilegesSeccomp.Mode? = null, + // The custom seccomp profile as a json object + @Json(name = "Profile") + var profile: kotlin.String? = null, +) { + /** + * + * + * Values: Default,Unconfined,Custom + */ + @JsonClass(generateAdapter = false) + enum class Mode(val value: kotlin.String) { + @Json(name = "default") + Default("default"), + + @Json(name = "unconfined") + Unconfined("unconfined"), + + @Json(name = "custom") + Custom("custom"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt new file mode 100644 index 00000000..9610bf14 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt @@ -0,0 +1,38 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param file + * @param secretID SecretID represents the ID of the specific secret that we're referencing. + * @param secretName SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecSecretsInner( + @Json(name = "File") + var file: TaskSpecContainerSpecSecretsInnerFile? = null, + // SecretID represents the ID of the specific secret that we're referencing. + @Json(name = "SecretID") + var secretID: kotlin.String? = null, + // SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. + @Json(name = "SecretName") + var secretName: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt new file mode 100644 index 00000000..d826a4a1 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * File represents a specific target that is backed by a file. + * + * @param name Name represents the final filename in the filesystem. + * @param UID UID represents the file UID. + * @param GID GID represents the file GID. + * @param mode Mode represents the FileMode of the file. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecContainerSpecSecretsInnerFile( + // Name represents the final filename in the filesystem. + @Json(name = "Name") + var name: kotlin.String? = null, + // UID represents the file UID. + @Json(name = "UID") + var UID: kotlin.String? = null, + // GID represents the file GID. + @Json(name = "GID") + var GID: kotlin.String? = null, + // Mode represents the FileMode of the file. + @Json(name = "Mode") + var mode: kotlin.Int? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt new file mode 100644 index 00000000..d2da8e5e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt @@ -0,0 +1,33 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified. + * + * @param name + * @param options + */ +@JsonClass(generateAdapter = true) +data class TaskSpecLogDriver( + @Json(name = "Name") + var name: kotlin.String? = null, + @Json(name = "Options") + var options: kotlin.collections.MutableMap? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt new file mode 100644 index 00000000..9da84bd1 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Read-only spec type for non-swarm containers attached to swarm overlay networks.


> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`. + * + * @param containerID ID of the container represented by this task + */ +@JsonClass(generateAdapter = true) +data class TaskSpecNetworkAttachmentSpec( + // ID of the container represented by this task + @Json(name = "ContainerID") + var containerID: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt new file mode 100644 index 00000000..3927a634 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt @@ -0,0 +1,43 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param constraints An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-24.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). + * @param preferences Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. + * @param maxReplicas Maximum number of replicas for per node (default value is 0, which is unlimited) + * @param platforms Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPlacement( + // An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-24.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). + @Json(name = "Constraints") + var constraints: kotlin.collections.MutableList? = null, + // Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence. + @Json(name = "Preferences") + var preferences: kotlin.collections.MutableList? = null, + // Maximum number of replicas for per node (default value is 0, which is unlimited) + @Json(name = "MaxReplicas") + var maxReplicas: kotlin.Long? = 0L, + // Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. + @Json(name = "Platforms") + var platforms: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt new file mode 100644 index 00000000..153c8988 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param spread + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPlacementPreferencesInner( + @Json(name = "Spread") + var spread: TaskSpecPlacementPreferencesInnerSpread? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt new file mode 100644 index 00000000..14dec45c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param spreadDescriptor label descriptor, such as `engine.labels.az`. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPlacementPreferencesInnerSpread( + // label descriptor, such as `engine.labels.az`. + @Json(name = "SpreadDescriptor") + var spreadDescriptor: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt new file mode 100644 index 00000000..c67c19fc --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt @@ -0,0 +1,42 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Plugin spec for the service. *(Experimental release only.)*


> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to `plugin`. NetworkAttachmentSpec is used when the Runtime > field is set to `attachment`. + * + * @param name The name or 'alias' to use for the plugin. + * @param remote The plugin image reference to use. + * @param disabled Disable the plugin once scheduled. + * @param pluginPrivilege + */ +@JsonClass(generateAdapter = true) +data class TaskSpecPluginSpec( + // The name or 'alias' to use for the plugin. + @Json(name = "Name") + var name: kotlin.String? = null, + // The plugin image reference to use. + @Json(name = "Remote") + var remote: kotlin.String? = null, + // Disable the plugin once scheduled. + @Json(name = "Disabled") + var disabled: kotlin.Boolean? = null, + @Json(name = "PluginPrivilege") + var pluginPrivilege: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt new file mode 100644 index 00000000..5e857a0f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt @@ -0,0 +1,41 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Resource requirements which apply to each individual container created as part of the service. + * + * @param limits + * @param reservations + * @param swapBytes Amount of swap in bytes - can only be used together with a memory limit. If not specified, the default behaviour is to grant a swap space twice as big as the memory limit. Set to -1 to enable unlimited swap. + * @param memorySwappiness Tune the service's containers' memory swappiness (0 to 100). If not specified, defaults to the containers' OS' default, generally 60, or whatever value was predefined in the image. Set to -1 to unset a previously set value. + */ +@JsonClass(generateAdapter = true) +data class TaskSpecResources( + @Json(name = "Limits") + var limits: Limit? = null, + @Json(name = "Reservations") + var reservations: ResourceObject? = null, + // Amount of swap in bytes - can only be used together with a memory limit. If not specified, the default behaviour is to grant a swap space twice as big as the memory limit. Set to -1 to enable unlimited swap. + @Json(name = "SwapBytes") + var swapBytes: kotlin.Long? = null, + // Tune the service's containers' memory swappiness (0 to 100). If not specified, defaults to the containers' OS' default, generally 60, or whatever value was predefined in the image. Set to -1 to unset a previously set value. + @Json(name = "MemorySwappiness") + var memorySwappiness: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt new file mode 100644 index 00000000..2c4b496a --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt @@ -0,0 +1,60 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Specification for the restart policy which applies to containers created as part of this service. + * + * @param condition Condition for restart. + * @param delay Delay between restart attempts. + * @param maxAttempts Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). + * @param window Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). + */ +@JsonClass(generateAdapter = true) +data class TaskSpecRestartPolicy( + // Condition for restart. + @Json(name = "Condition") + var condition: TaskSpecRestartPolicy.Condition? = null, + // Delay between restart attempts. + @Json(name = "Delay") + var delay: kotlin.Long? = null, + // Maximum attempts to restart a given container before giving up (default value is 0, which is ignored). + @Json(name = "MaxAttempts") + var maxAttempts: kotlin.Long? = 0L, + // Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). + @Json(name = "Window") + var window: kotlin.Long? = 0L, +) { + /** + * Condition for restart. + * + * Values: None,OnFailure,Any + */ + @JsonClass(generateAdapter = false) + enum class Condition(val value: kotlin.String) { + @Json(name = "none") + None("none"), + + @Json(name = "on-failure") + OnFailure("on-failure"), + + @Json(name = "any") + Any("any"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt new file mode 100644 index 00000000..cda67294 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt @@ -0,0 +1,101 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * Values: New,Allocated,Pending,Assigned,Accepted,Preparing,Ready,Starting,Running,Complete,Shutdown,Failed,Rejected,Remove,Orphaned + */ + +@JsonClass(generateAdapter = false) +enum class TaskState(val value: kotlin.String) { + @Json(name = "new") + New("new"), + + @Json(name = "allocated") + Allocated("allocated"), + + @Json(name = "pending") + Pending("pending"), + + @Json(name = "assigned") + Assigned("assigned"), + + @Json(name = "accepted") + Accepted("accepted"), + + @Json(name = "preparing") + Preparing("preparing"), + + @Json(name = "ready") + Ready("ready"), + + @Json(name = "starting") + Starting("starting"), + + @Json(name = "running") + Running("running"), + + @Json(name = "complete") + Complete("complete"), + + @Json(name = "shutdown") + Shutdown("shutdown"), + + @Json(name = "failed") + Failed("failed"), + + @Json(name = "rejected") + Rejected("rejected"), + + @Json(name = "remove") + Remove("remove"), + + @Json(name = "orphaned") + Orphaned("orphaned"), + ; + + /** + * Override [toString()] to avoid using the enum variable name as the value, and instead use + * the actual value defined in the API spec file. + * + * This solves a problem when the variable name and its value are different, and ensures that + * the client sends the correct enum values to the server always. + */ + override fun toString(): kotlin.String = value + + companion object { + /** + * Converts the provided [data] to a [String] on success, null otherwise. + */ + fun encode(data: kotlin.Any?): kotlin.String? = if (data is TaskState) "$data" else null + + /** + * Returns a valid [TaskState] for [data], null otherwise. + */ + fun decode(data: kotlin.Any?): TaskState? = + data?.let { + val normalizedData = "$it".lowercase() + values().firstOrNull { value -> + it == value || normalizedData == "$value".lowercase() + } + } + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt new file mode 100644 index 00000000..58b067ab --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt @@ -0,0 +1,45 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents the status of a task. + * + * @param timestamp + * @param state + * @param message + * @param err + * @param containerStatus + * @param portStatus + */ +@JsonClass(generateAdapter = true) +data class TaskStatus( + @Json(name = "Timestamp") + var timestamp: kotlin.String? = null, + @Json(name = "State") + var state: TaskState? = null, + @Json(name = "Message") + var message: kotlin.String? = null, + @Json(name = "Err") + var err: kotlin.String? = null, + @Json(name = "ContainerStatus") + var containerStatus: ContainerStatus? = null, + @Json(name = "PortStatus") + var portStatus: PortStatus? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt new file mode 100644 index 00000000..b5a9f291 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param path Device path + * @param rate Rate + */ +@JsonClass(generateAdapter = true) +data class ThrottleDevice( + // Device path + @Json(name = "Path") + var path: kotlin.String? = null, + // Rate + @Json(name = "Rate") + var rate: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt new file mode 100644 index 00000000..7252fe84 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt @@ -0,0 +1,31 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param unlockKey The swarm's unlock key. + */ +@JsonClass(generateAdapter = true) +data class UnlockKeyResponse( + // The swarm's unlock key. + @Json(name = "UnlockKey") + var unlockKey: kotlin.String? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt new file mode 100644 index 00000000..c986185c --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt @@ -0,0 +1,79 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param name Name of the volume. + * @param driver Name of the volume driver used by the volume. + * @param mountpoint Mount path of the volume on the host. + * @param options The driver specific options used when creating the volume. + * @param createdAt Date/Time the volume was created. + * @param status Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. + * @param labels User-defined key/value metadata. + * @param scope The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. + * @param clusterVolume + * @param usageData + */ +@JsonClass(generateAdapter = true) +data class Volume( + // Name of the volume. + @Json(name = "Name") + var name: kotlin.String, + // Name of the volume driver used by the volume. + @Json(name = "Driver") + var driver: kotlin.String, + // Mount path of the volume on the host. + @Json(name = "Mountpoint") + var mountpoint: kotlin.String, + // The driver specific options used when creating the volume. + @Json(name = "Options") + var options: kotlin.collections.MutableMap?, + // Date/Time the volume was created. + @Json(name = "CreatedAt") + var createdAt: kotlin.String? = null, + // Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`. The `Status` field is optional, and is omitted if the volume driver does not support this feature. + @Json(name = "Status") + var status: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + // The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. + @Json(name = "Scope") + var scope: Volume.Scope? = Scope.Local, + @Json(name = "ClusterVolume") + var clusterVolume: ClusterVolume? = null, + @Json(name = "UsageData") + var usageData: VolumeUsageData? = null, +) { + /** + * The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. + * + * Values: Local,Global + */ + @JsonClass(generateAdapter = false) + enum class Scope(val value: kotlin.String) { + @Json(name = "local") + Local("local"), + + @Json(name = "global") + Global("global"), + } +} diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateRequest.kt new file mode 100644 index 00000000..18dea4eb --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateRequest.kt @@ -0,0 +1,46 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Volume configuration + * + * @param name The new volume's name. If not specified, Docker generates a name. + * @param driver Name of the volume driver to use. + * @param driverOpts A mapping of driver options and values. These options are passed directly to the driver and are driver specific. + * @param labels User-defined key/value metadata. + * @param clusterVolumeSpec + */ +@JsonClass(generateAdapter = true) +data class VolumeCreateRequest( + // The new volume's name. If not specified, Docker generates a name. + @Json(name = "Name") + var name: kotlin.String? = null, + // Name of the volume driver to use. + @Json(name = "Driver") + var driver: kotlin.String? = "local", + // A mapping of driver options and values. These options are passed directly to the driver and are driver specific. + @Json(name = "DriverOpts") + var driverOpts: kotlin.collections.MutableMap? = null, + // User-defined key/value metadata. + @Json(name = "Labels") + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "ClusterVolumeSpec") + var clusterVolumeSpec: ClusterVolumeSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt new file mode 100644 index 00000000..0292cf47 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Volume list response + * + * @param volumes List of volumes + * @param warnings Warnings that occurred when fetching the list of volumes. + */ +@JsonClass(generateAdapter = true) +data class VolumeListResponse( + // List of volumes + @Json(name = "Volumes") + var volumes: kotlin.collections.MutableList? = null, + // Warnings that occurred when fetching the list of volumes. + @Json(name = "Warnings") + var warnings: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt new file mode 100644 index 00000000..b5c37a0f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * + * + * @param volumesDeleted Volumes that were deleted + * @param spaceReclaimed Disk space reclaimed in bytes + */ +@JsonClass(generateAdapter = true) +data class VolumePruneResponse( + // Volumes that were deleted + @Json(name = "VolumesDeleted") + var volumesDeleted: kotlin.collections.MutableList? = null, + // Disk space reclaimed in bytes + @Json(name = "SpaceReclaimed") + var spaceReclaimed: kotlin.Long? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt new file mode 100644 index 00000000..0c94e57f --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUpdateRequest.kt @@ -0,0 +1,30 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Volume configuration + * + * @param spec + */ +@JsonClass(generateAdapter = true) +data class VolumeUpdateRequest( + @Json(name = "Spec") + var spec: ClusterVolumeSpec? = null, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt new file mode 100644 index 00000000..b9fee8d7 --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt @@ -0,0 +1,35 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints. + * + * @param propertySize Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") + * @param refCount The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. + */ +@JsonClass(generateAdapter = true) +data class VolumeUsageData( + // Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the `\"local\"` volume driver. For volumes created with other volume drivers, this field is set to `-1` (\"not available\") + @Json(name = "Size") + var propertySize: kotlin.Long = -1L, + // The number of containers referencing this volume. This field is set to `-1` if the reference-count is not available. + @Json(name = "RefCount") + var refCount: kotlin.Long = -1L, +) diff --git a/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumesDiskUsage.kt b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumesDiskUsage.kt new file mode 100644 index 00000000..3c6ae93e --- /dev/null +++ b/api-model-v1-52/src/main/kotlin/de/gesellix/docker/remote/api/VolumesDiskUsage.kt @@ -0,0 +1,47 @@ +/** + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + * + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport", +) + +package de.gesellix.docker.remote.api + +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * represents system data usage for volume resources. + * + * @param activeCount Count of active volumes. + * @param totalCount Count of all volumes. + * @param reclaimable Disk space that can be reclaimed by removing inactive volumes. + * @param totalSize Disk space in use by volumes. + * @param items List of volumes. + */ +@JsonClass(generateAdapter = true) +data class VolumesDiskUsage( + // Count of active volumes. + @Json(name = "ActiveCount") + var activeCount: kotlin.Long? = null, + // Count of all volumes. + @Json(name = "TotalCount") + var totalCount: kotlin.Long? = null, + // Disk space that can be reclaimed by removing inactive volumes. + @Json(name = "Reclaimable") + var reclaimable: kotlin.Long? = null, + // Disk space in use by volumes. + @Json(name = "TotalSize") + var totalSize: kotlin.Long? = null, + // List of volumes. + @Json(name = "Items") + var items: kotlin.collections.MutableList? = null, +) diff --git a/api-model-v1-52/src/test/java/de/gesellix/docker/remote/api/ContainerCreateRequestTest.java b/api-model-v1-52/src/test/java/de/gesellix/docker/remote/api/ContainerCreateRequestTest.java new file mode 100644 index 00000000..d7ba2c18 --- /dev/null +++ b/api-model-v1-52/src/test/java/de/gesellix/docker/remote/api/ContainerCreateRequestTest.java @@ -0,0 +1,21 @@ +package de.gesellix.docker.remote.api; + +import org.junit.jupiter.api.Test; + +import java.lang.reflect.Field; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ContainerCreateRequestTest { + + @Test + public void ensureContainerCreateRequestFields() { + Field[] containerConfigFields = ContainerConfig.class.getDeclaredFields(); + + Field[] containerCreateRequestFields = ContainerCreateRequest.class.getDeclaredFields(); + + assertEquals( + containerConfigFields.length + 1 /* HostConfig */ + 1 /* NetworkingConfig */, + containerCreateRequestFields.length); + } +} diff --git a/api-model-v1-52/src/test/java/de/gesellix/docker/remote/api/ContainerUpdateRequestTest.java b/api-model-v1-52/src/test/java/de/gesellix/docker/remote/api/ContainerUpdateRequestTest.java new file mode 100644 index 00000000..aa055322 --- /dev/null +++ b/api-model-v1-52/src/test/java/de/gesellix/docker/remote/api/ContainerUpdateRequestTest.java @@ -0,0 +1,21 @@ +package de.gesellix.docker.remote.api; + +import org.junit.jupiter.api.Test; + +import java.lang.reflect.Field; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ContainerUpdateRequestTest { + + @Test + public void ensureContainerUpdateRequestFields() { + Field[] resourcesFields = Resources.class.getDeclaredFields(); + + Field[] containerUpdateRequestFields = ContainerUpdateRequest.class.getDeclaredFields(); + + assertEquals( + resourcesFields.length + 1 /* RestartPolicy */, + containerUpdateRequestFields.length); + } +} diff --git a/settings.gradle.kts b/settings.gradle.kts index 6cf340bc..318af44a 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,6 +1,7 @@ rootProject.name = "docker-remote-api" include("api-model-v1-41") -include("api-model-v1-45") +include("api-model-v1-44") +include("api-model-v1-52") // https://docs.gradle.org/current/userguide/toolchains.html#sub:download_repositories plugins {