diff --git a/api-model-v1-41/.openapi-generator/VERSION b/api-model-v1-41/.openapi-generator/VERSION index 7cbea073..1e20ec35 100644 --- a/api-model-v1-41/.openapi-generator/VERSION +++ b/api-model-v1-41/.openapi-generator/VERSION @@ -1 +1 @@ -5.2.0 \ No newline at end of file +5.4.0 \ No newline at end of file diff --git a/api-model-v1-41/docs/BuildCache.md b/api-model-v1-41/docs/BuildCache.md index 2d4281b6..ec03cd7e 100644 --- a/api-model-v1-41/docs/BuildCache.md +++ b/api-model-v1-41/docs/BuildCache.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **description** | **kotlin.String** | | [optional] **inUse** | **kotlin.Boolean** | | [optional] **shared** | **kotlin.Boolean** | | [optional] -**size** | **kotlin.Int** | Amount of disk space used by the build cache (in bytes). | [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] diff --git a/api-model-v1-41/docs/BuildPruneResponse.md b/api-model-v1-41/docs/BuildPruneResponse.md index 574fe37b..34efd422 100644 --- a/api-model-v1-41/docs/BuildPruneResponse.md +++ b/api-model-v1-41/docs/BuildPruneResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cachesDeleted** | **kotlin.collections.List<kotlin.String>** | | [optional] +**cachesDeleted** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] **spaceReclaimed** | **kotlin.Long** | Disk space reclaimed in bytes | [optional] diff --git a/api-model-v1-41/docs/ClusterInfo.md b/api-model-v1-41/docs/ClusterInfo.md index db76e932..1f70cac7 100644 --- a/api-model-v1-41/docs/ClusterInfo.md +++ b/api-model-v1-41/docs/ClusterInfo.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **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.List<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [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-41/docs/ConfigSpec.md b/api-model-v1-41/docs/ConfigSpec.md index 24e9fed2..2def499f 100644 --- a/api-model-v1-41/docs/ConfigSpec.md +++ b/api-model-v1-41/docs/ConfigSpec.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | User-defined name of the config. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**data** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] +**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. | [optional] **templating** | [**Driver**](Driver.md) | | [optional] diff --git a/api-model-v1-41/docs/ContainerConfig.md b/api-model-v1-41/docs/ContainerConfig.md index e3429493..2f902beb 100644 --- a/api-model-v1-41/docs/ContainerConfig.md +++ b/api-model-v1-41/docs/ContainerConfig.md @@ -10,25 +10,25 @@ Name | Type | Description | Notes **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.Map<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping ports to an empty object in the form: `{\"<port>/<tcp|udp|sctp>\": {}}` | [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.List<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.List<kotlin.String>** | Command to run specified as a string or an array of strings. | [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 of the image to use when creating the container/ | [optional] -**volumes** | [**kotlin.collections.Map<kotlin.String, kotlin.Any>**](kotlin.Any.md) | An object mapping mount point paths inside the container to empty objects. | [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.List<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] +**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. | [optional] -**onBuild** | **kotlin.collections.List<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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.List<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] +**shell** | **kotlin.collections.MutableList<kotlin.String>** | Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. | [optional] diff --git a/api-model-v1-41/docs/ContainerCreateResponse.md b/api-model-v1-41/docs/ContainerCreateResponse.md index e76efa84..bc1c1779 100644 --- a/api-model-v1-41/docs/ContainerCreateResponse.md +++ b/api-model-v1-41/docs/ContainerCreateResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **kotlin.String** | The ID of the created container | -**warnings** | **kotlin.collections.List<kotlin.String>** | Warnings encountered when creating the container | +**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings encountered when creating the container | diff --git a/api-model-v1-41/docs/ContainerInspectResponse.md b/api-model-v1-41/docs/ContainerInspectResponse.md index ec562191..69344bc7 100644 --- a/api-model-v1-41/docs/ContainerInspectResponse.md +++ b/api-model-v1-41/docs/ContainerInspectResponse.md @@ -7,7 +7,7 @@ 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.List<kotlin.String>** | The arguments 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] @@ -21,12 +21,12 @@ Name | Type | Description | Notes **mountLabel** | **kotlin.String** | | [optional] **processLabel** | **kotlin.String** | | [optional] **appArmorProfile** | **kotlin.String** | | [optional] -**execIDs** | **kotlin.collections.List<kotlin.String>** | IDs of exec instances that are running in 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** | [**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.List<MountPoint>**](MountPoint.md) | | [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-41/docs/ContainerPruneResponse.md b/api-model-v1-41/docs/ContainerPruneResponse.md index cabfc62d..6b259d16 100644 --- a/api-model-v1-41/docs/ContainerPruneResponse.md +++ b/api-model-v1-41/docs/ContainerPruneResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**containersDeleted** | **kotlin.collections.List<kotlin.String>** | Container IDs that were deleted | [optional] +**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-41/docs/ContainerState.md b/api-model-v1-41/docs/ContainerState.md index 391f5a31..77c1be69 100644 --- a/api-model-v1-41/docs/ContainerState.md +++ b/api-model-v1-41/docs/ContainerState.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | [**inline**](#StatusEnum) | String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". | [optional] +**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] @@ -18,7 +18,7 @@ Name | Type | Description | Notes **health** | [**Health**](Health.md) | | [optional] - + ## Enum: Status Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/ContainerSummary.md b/api-model-v1-41/docs/ContainerSummary.md index 29c72c4b..3f885bc7 100644 --- a/api-model-v1-41/docs/ContainerSummary.md +++ b/api-model-v1-41/docs/ContainerSummary.md @@ -5,20 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **kotlin.String** | The ID of this container | [optional] -**names** | **kotlin.collections.List<kotlin.String>** | The names that this container has been given | [optional] +**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.List<Port>**](Port.md) | The ports exposed by this container | [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.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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.List<Mount>**](Mount.md) | | [optional] +**mounts** | [**kotlin.collections.MutableList<Mount>**](Mount.md) | | [optional] diff --git a/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md b/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md index 0daa70bc..acb7fec6 100644 --- a/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md +++ b/api-model-v1-41/docs/ContainerSummaryNetworkSettings.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**networks** | [**kotlin.collections.Map<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] +**networks** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | | [optional] diff --git a/api-model-v1-41/docs/ContainerTopResponse.md b/api-model-v1-41/docs/ContainerTopResponse.md index b3b22f9a..ef42e8be 100644 --- a/api-model-v1-41/docs/ContainerTopResponse.md +++ b/api-model-v1-41/docs/ContainerTopResponse.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**titles** | **kotlin.collections.List<kotlin.String>** | The ps column titles | [optional] -**processes** | **kotlin.collections.List<kotlin.collections.List<kotlin.String>>** | Each process running in the container, where each is process is an array of values corresponding to the titles. | [optional] +**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-41/docs/ContainerUpdateResponse.md b/api-model-v1-41/docs/ContainerUpdateResponse.md index 4d078bbe..067f8a6f 100644 --- a/api-model-v1-41/docs/ContainerUpdateResponse.md +++ b/api-model-v1-41/docs/ContainerUpdateResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**warnings** | **kotlin.collections.List<kotlin.String>** | | [optional] +**warnings** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/DeviceRequest.md b/api-model-v1-41/docs/DeviceRequest.md index 21e98554..d481fa41 100644 --- a/api-model-v1-41/docs/DeviceRequest.md +++ b/api-model-v1-41/docs/DeviceRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **driver** | **kotlin.String** | | [optional] **count** | **kotlin.Int** | | [optional] -**deviceIDs** | **kotlin.collections.List<kotlin.String>** | | [optional] -**capabilities** | **kotlin.collections.List<kotlin.collections.List<kotlin.String>>** | A list of capabilities; an OR list of AND lists of capabilities. | [optional] -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | [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-41/docs/DistributionInspect.md b/api-model-v1-41/docs/DistributionInspect.md index 68df0183..15df91fd 100644 --- a/api-model-v1-41/docs/DistributionInspect.md +++ b/api-model-v1-41/docs/DistributionInspect.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **descriptor** | [**OCIDescriptor**](OCIDescriptor.md) | | -**platforms** | [**kotlin.collections.List<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | +**platforms** | [**kotlin.collections.MutableList<OCIPlatform>**](OCIPlatform.md) | An array containing all platforms supported by the image. | diff --git a/api-model-v1-41/docs/Driver.md b/api-model-v1-41/docs/Driver.md index 9952f8b0..51c7a732 100644 --- a/api-model-v1-41/docs/Driver.md +++ b/api-model-v1-41/docs/Driver.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | Name of the driver. | -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] +**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Key/value map of driver-specific options. | [optional] diff --git a/api-model-v1-41/docs/EndpointIPAMConfig.md b/api-model-v1-41/docs/EndpointIPAMConfig.md index 4620f064..f3a57409 100644 --- a/api-model-v1-41/docs/EndpointIPAMConfig.md +++ b/api-model-v1-41/docs/EndpointIPAMConfig.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ipv4Address** | **kotlin.String** | | [optional] **ipv6Address** | **kotlin.String** | | [optional] -**linkLocalIPs** | **kotlin.collections.List<kotlin.String>** | | [optional] +**linkLocalIPs** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/EndpointPortConfig.md b/api-model-v1-41/docs/EndpointPortConfig.md index 20037489..1ff630d6 100644 --- a/api-model-v1-41/docs/EndpointPortConfig.md +++ b/api-model-v1-41/docs/EndpointPortConfig.md @@ -5,20 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | [optional] -**protocol** | [**inline**](#ProtocolEnum) | | [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**](#PublishModeEnum) | 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] +**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 ---- | ----- diff --git a/api-model-v1-41/docs/EndpointSettings.md b/api-model-v1-41/docs/EndpointSettings.md index 16720546..2dd094f5 100644 --- a/api-model-v1-41/docs/EndpointSettings.md +++ b/api-model-v1-41/docs/EndpointSettings.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ipAMConfig** | [**EndpointIPAMConfig**](EndpointIPAMConfig.md) | | [optional] -**links** | **kotlin.collections.List<kotlin.String>** | | [optional] -**aliases** | **kotlin.collections.List<kotlin.String>** | | [optional] +**links** | **kotlin.collections.MutableList<kotlin.String>** | | [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] @@ -16,7 +16,7 @@ Name | Type | Description | Notes **globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional] **globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional] **macAddress** | **kotlin.String** | MAC address for the endpoint on this network. | [optional] -**driverOpts** | **kotlin.collections.Map<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] +**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] diff --git a/api-model-v1-41/docs/EndpointSpec.md b/api-model-v1-41/docs/EndpointSpec.md index 7b60df5e..a8fa32e2 100644 --- a/api-model-v1-41/docs/EndpointSpec.md +++ b/api-model-v1-41/docs/EndpointSpec.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | [**inline**](#ModeEnum) | The mode of resolution to use for internal load balancing between tasks. | [optional] -**ports** | [**kotlin.collections.List<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] +**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 ---- | ----- diff --git a/api-model-v1-41/docs/EngineDescription.md b/api-model-v1-41/docs/EngineDescription.md index d0463070..6e35d480 100644 --- a/api-model-v1-41/docs/EngineDescription.md +++ b/api-model-v1-41/docs/EngineDescription.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **engineVersion** | **kotlin.String** | | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | [optional] -**plugins** | [**kotlin.collections.List<EngineDescriptionPlugins>**](EngineDescriptionPlugins.md) | | [optional] +**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +**plugins** | [**kotlin.collections.MutableList<EngineDescriptionPlugins>**](EngineDescriptionPlugins.md) | | [optional] diff --git a/api-model-v1-41/docs/EventActor.md b/api-model-v1-41/docs/EventActor.md index 8e77d488..24e06ef9 100644 --- a/api-model-v1-41/docs/EventActor.md +++ b/api-model-v1-41/docs/EventActor.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ID** | **kotlin.String** | The ID of the object emitting the event | [optional] -**attributes** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Various key/value attributes of the object, depending on its type. | [optional] +**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-41/docs/EventMessage.md b/api-model-v1-41/docs/EventMessage.md index b806694a..0c1b323d 100644 --- a/api-model-v1-41/docs/EventMessage.md +++ b/api-model-v1-41/docs/EventMessage.md @@ -4,22 +4,22 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | [**inline**](#TypeEnum) | The type of object emitting the event | [optional] +**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**](#ScopeEnum) | Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. | [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 ---- | ----- diff --git a/api-model-v1-41/docs/ExecConfig.md b/api-model-v1-41/docs/ExecConfig.md index b82fbd80..97ba3e65 100644 --- a/api-model-v1-41/docs/ExecConfig.md +++ b/api-model-v1-41/docs/ExecConfig.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes **attachStderr** | **kotlin.Boolean** | Attach to `stderr` of the exec command. | [optional] **detachKeys** | **kotlin.String** | Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. | [optional] **tty** | **kotlin.Boolean** | Allocate a pseudo-TTY. | [optional] -**env** | **kotlin.collections.List<kotlin.String>** | A list of environment variables in the form `[\"VAR=value\", ...]`. | [optional] -**cmd** | **kotlin.collections.List<kotlin.String>** | Command to run, as a string or array of strings. | [optional] +**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-41/docs/GraphDriverData.md b/api-model-v1-41/docs/GraphDriverData.md index ea5e1ee2..76ec7193 100644 --- a/api-model-v1-41/docs/GraphDriverData.md +++ b/api-model-v1-41/docs/GraphDriverData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | -**data** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | +**`data`** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | diff --git a/api-model-v1-41/docs/Health.md b/api-model-v1-41/docs/Health.md index 34b54634..bcfcb1f9 100644 --- a/api-model-v1-41/docs/Health.md +++ b/api-model-v1-41/docs/Health.md @@ -4,12 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | [**inline**](#StatusEnum) | 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] +**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.List<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] +**log** | [**kotlin.collections.MutableList<HealthcheckResult>**](HealthcheckResult.md) | Log contains the last few results (oldest first) | [optional] - + ## Enum: Status Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/HealthConfig.md b/api-model-v1-41/docs/HealthConfig.md index ee8857b0..64d67527 100644 --- a/api-model-v1-41/docs/HealthConfig.md +++ b/api-model-v1-41/docs/HealthConfig.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**test** | **kotlin.collections.List<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] +**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.Int** | The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. | [optional] **timeout** | **kotlin.Int** | 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] diff --git a/api-model-v1-41/docs/HistoryResponseItem.md b/api-model-v1-41/docs/HistoryResponseItem.md index 02927c89..20db3fff 100644 --- a/api-model-v1-41/docs/HistoryResponseItem.md +++ b/api-model-v1-41/docs/HistoryResponseItem.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **id** | **kotlin.String** | | **created** | **kotlin.Long** | | **createdBy** | **kotlin.String** | | -**tags** | **kotlin.collections.List<kotlin.String>** | | -**size** | **kotlin.Long** | | +**tags** | **kotlin.collections.MutableList<kotlin.String>** | | +**propertySize** | **kotlin.Long** | | **comment** | **kotlin.String** | | diff --git a/api-model-v1-41/docs/HostConfig.md b/api-model-v1-41/docs/HostConfig.md index 90d59a4a..ace35548 100644 --- a/api-model-v1-41/docs/HostConfig.md +++ b/api-model-v1-41/docs/HostConfig.md @@ -8,20 +8,20 @@ Name | Type | Description | Notes **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.List<ResourcesBlkioWeightDevice>**](ResourcesBlkioWeightDevice.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] +**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDevice>**](ResourcesBlkioWeightDevice.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.List<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.List<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.List<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [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] **kernelMemory** | **kotlin.Long** | Kernel memory limit in bytes. <p><br /></p> > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. | [optional] **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). | [optional] **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] @@ -29,61 +29,61 @@ Name | Type | Description | Notes **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] +**`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.List<ResourcesUlimits>**](ResourcesUlimits.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] +**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimits>**](ResourcesUlimits.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.List<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] +**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.Map<kotlin.String, kotlin.collections.List<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] +**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.List<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] -**mounts** | [**kotlin.collections.List<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] -**capAdd** | **kotlin.collections.List<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] -**capDrop** | **kotlin.collections.List<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] -**cgroupnsMode** | [**inline**](#CgroupnsModeEnum) | 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.List<kotlin.String>** | A list of DNS servers for the container to use. | [optional] -**dnsOptions** | **kotlin.collections.List<kotlin.String>** | A list of DNS options. | [optional] -**dnsSearch** | **kotlin.collections.List<kotlin.String>** | A list of DNS search domains. | [optional] -**extraHosts** | **kotlin.collections.List<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.List<kotlin.String>** | A list of additional groups that the container process will run as. | [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] +**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.List<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [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.List<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] -**storageOpt** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] -**tmpfs** | **kotlin.collections.Map<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] +**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.Int** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] -**sysctls** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [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] -**consoleSize** | **kotlin.collections.List<kotlin.Int>** | Initial console size, as an `[height, width]` array. (Windows only) | [optional] -**isolation** | [**inline**](#IsolationEnum) | Isolation technology of the container. (Windows only) | [optional] -**maskedPaths** | **kotlin.collections.List<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] -**readonlyPaths** | **kotlin.collections.List<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] +**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. (Windows only) | [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 ---- | ----- diff --git a/api-model-v1-41/docs/HostConfigAllOf.md b/api-model-v1-41/docs/HostConfigAllOf.md index d07c01b7..0fca5c44 100644 --- a/api-model-v1-41/docs/HostConfigAllOf.md +++ b/api-model-v1-41/docs/HostConfigAllOf.md @@ -4,54 +4,54 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**binds** | **kotlin.collections.List<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] +**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.Map<kotlin.String, kotlin.collections.List<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] +**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.List<kotlin.String>** | A list of volumes to inherit from another container, specified in the form `<container name>[:<ro|rw>]`. | [optional] -**mounts** | [**kotlin.collections.List<Mount>**](Mount.md) | Specification for mounts to be added to the container. | [optional] -**capAdd** | **kotlin.collections.List<kotlin.String>** | A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | [optional] -**capDrop** | **kotlin.collections.List<kotlin.String>** | A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | [optional] -**cgroupnsMode** | [**inline**](#CgroupnsModeEnum) | 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.List<kotlin.String>** | A list of DNS servers for the container to use. | [optional] -**dnsOptions** | **kotlin.collections.List<kotlin.String>** | A list of DNS options. | [optional] -**dnsSearch** | **kotlin.collections.List<kotlin.String>** | A list of DNS search domains. | [optional] -**extraHosts** | **kotlin.collections.List<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.List<kotlin.String>** | A list of additional groups that the container process will run as. | [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] +**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.List<kotlin.String>** | A list of links for the container in the form `container_name:alias`. | [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.List<kotlin.String>** | A list of string values to customize labels for MLS systems, such as SELinux. | [optional] -**storageOpt** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Storage driver options for this container, in the form `{\"size\": \"120G\"}`. | [optional] -**tmpfs** | **kotlin.collections.Map<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] +**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.Int** | Size of `/dev/shm` in bytes. If omitted, the system uses 64MB. | [optional] -**sysctls** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | A list of kernel parameters (sysctls) to set in the container. For example: ``` {\"net.ipv4.ip_forward\": \"1\"} ``` | [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] -**consoleSize** | **kotlin.collections.List<kotlin.Int>** | Initial console size, as an `[height, width]` array. (Windows only) | [optional] -**isolation** | [**inline**](#IsolationEnum) | Isolation technology of the container. (Windows only) | [optional] -**maskedPaths** | **kotlin.collections.List<kotlin.String>** | The list of paths to be masked inside the container (this overrides the default set of paths). | [optional] -**readonlyPaths** | **kotlin.collections.List<kotlin.String>** | The list of paths to be set as read-only inside the container (this overrides the default set of paths). | [optional] +**consoleSize** | **kotlin.collections.MutableList<kotlin.Int>** | Initial console size, as an `[height, width]` array. (Windows only) | [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 ---- | ----- diff --git a/api-model-v1-41/docs/HostConfigAllOfLogConfig.md b/api-model-v1-41/docs/HostConfigAllOfLogConfig.md index 104143ae..30acf532 100644 --- a/api-model-v1-41/docs/HostConfigAllOfLogConfig.md +++ b/api-model-v1-41/docs/HostConfigAllOfLogConfig.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | [**inline**](#TypeEnum) | | [optional] -**config** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | [optional] +**type** | [**inline**](#Type) | | [optional] +**config** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] - + ## Enum: Type Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/IPAM.md b/api-model-v1-41/docs/IPAM.md index 882e80ca..0b7268b9 100644 --- a/api-model-v1-41/docs/IPAM.md +++ b/api-model-v1-41/docs/IPAM.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **driver** | **kotlin.String** | Name of the IPAM driver to use. | [optional] -**config** | **kotlin.collections.List<kotlin.collections.Map<kotlin.String, kotlin.String>>** | 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.Map<kotlin.String, kotlin.String>** | Driver-specific options, specified as a map. | [optional] +**config** | **kotlin.collections.MutableList<kotlin.collections.MutableMap<kotlin.String, kotlin.String>>** | 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-41/docs/Image.md b/api-model-v1-41/docs/Image.md index 1a5dd841..71c8fd76 100644 --- a/api-model-v1-41/docs/Image.md +++ b/api-model-v1-41/docs/Image.md @@ -13,12 +13,12 @@ Name | Type | Description | Notes **author** | **kotlin.String** | | **architecture** | **kotlin.String** | | **os** | **kotlin.String** | | -**size** | **kotlin.Long** | | +**propertySize** | **kotlin.Long** | | **virtualSize** | **kotlin.Long** | | **graphDriver** | [**GraphDriverData**](GraphDriverData.md) | | **rootFS** | [**ImageRootFS**](ImageRootFS.md) | | -**repoTags** | **kotlin.collections.List<kotlin.String>** | | [optional] -**repoDigests** | **kotlin.collections.List<kotlin.String>** | | [optional] +**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] +**repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] **containerConfig** | [**ContainerConfig**](ContainerConfig.md) | | [optional] **config** | [**ContainerConfig**](ContainerConfig.md) | | [optional] **osVersion** | **kotlin.String** | | [optional] diff --git a/api-model-v1-41/docs/ImagePruneResponse.md b/api-model-v1-41/docs/ImagePruneResponse.md index 78ffbaa8..d041d483 100644 --- a/api-model-v1-41/docs/ImagePruneResponse.md +++ b/api-model-v1-41/docs/ImagePruneResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**imagesDeleted** | [**kotlin.collections.List<ImageDeleteResponseItem>**](ImageDeleteResponseItem.md) | Images that were deleted | [optional] +**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-41/docs/ImageRootFS.md b/api-model-v1-41/docs/ImageRootFS.md index a04d3672..c724cbb1 100644 --- a/api-model-v1-41/docs/ImageRootFS.md +++ b/api-model-v1-41/docs/ImageRootFS.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **kotlin.String** | | -**layers** | **kotlin.collections.List<kotlin.String>** | | [optional] +**layers** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] **baseLayer** | **kotlin.String** | | [optional] diff --git a/api-model-v1-41/docs/ImageSummary.md b/api-model-v1-41/docs/ImageSummary.md index 105ca393..5c6fcebf 100644 --- a/api-model-v1-41/docs/ImageSummary.md +++ b/api-model-v1-41/docs/ImageSummary.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **kotlin.String** | | **parentId** | **kotlin.String** | | -**repoTags** | **kotlin.collections.List<kotlin.String>** | | -**repoDigests** | **kotlin.collections.List<kotlin.String>** | | +**repoTags** | **kotlin.collections.MutableList<kotlin.String>** | | +**repoDigests** | **kotlin.collections.MutableList<kotlin.String>** | | **created** | **kotlin.Int** | | -**size** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | +**propertySize** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | **sharedSize** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | **virtualSize** | [**java.math.BigDecimal**](java.math.BigDecimal.md) | | -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | +**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | **containers** | **kotlin.Int** | | diff --git a/api-model-v1-41/docs/IndexInfo.md b/api-model-v1-41/docs/IndexInfo.md index 3d18e482..7018edfd 100644 --- a/api-model-v1-41/docs/IndexInfo.md +++ b/api-model-v1-41/docs/IndexInfo.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | Name of the registry, such as \"docker.io\". | [optional] -**mirrors** | **kotlin.collections.List<kotlin.String>** | List of mirrors, expressed as URIs. | [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-41/docs/Mount.md b/api-model-v1-41/docs/Mount.md index f091403c..d87a4245 100644 --- a/api-model-v1-41/docs/Mount.md +++ b/api-model-v1-41/docs/Mount.md @@ -6,7 +6,7 @@ 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**](#TypeEnum) | 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. | [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. | [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] @@ -14,7 +14,7 @@ Name | Type | Description | Notes **tmpfsOptions** | [**MountTmpfsOptions**](MountTmpfsOptions.md) | | [optional] - + ## Enum: Type Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/MountBindOptions.md b/api-model-v1-41/docs/MountBindOptions.md index df7a2e84..39f8da54 100644 --- a/api-model-v1-41/docs/MountBindOptions.md +++ b/api-model-v1-41/docs/MountBindOptions.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**propagation** | [**inline**](#PropagationEnum) | A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. | [optional] +**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] - + ## Enum: Propagation Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/MountVolumeOptions.md b/api-model-v1-41/docs/MountVolumeOptions.md index 7fd0d794..2fdfdecf 100644 --- a/api-model-v1-41/docs/MountVolumeOptions.md +++ b/api-model-v1-41/docs/MountVolumeOptions.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **noCopy** | **kotlin.Boolean** | Populate volume with data from the target. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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-41/docs/MountVolumeOptionsDriverConfig.md b/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md index 8e4d278d..084ee2c5 100644 --- a/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md +++ b/api-model-v1-41/docs/MountVolumeOptionsDriverConfig.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | Name of the driver to use to create the volume. | [optional] -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] +**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | key/value map of driver specific options. | [optional] diff --git a/api-model-v1-41/docs/Network.md b/api-model-v1-41/docs/Network.md index 0de7b514..1af62551 100644 --- a/api-model-v1-41/docs/Network.md +++ b/api-model-v1-41/docs/Network.md @@ -14,9 +14,9 @@ Name | Type | Description | Notes **`internal`** | **kotlin.Boolean** | | [optional] **attachable** | **kotlin.Boolean** | | [optional] **ingress** | **kotlin.Boolean** | | [optional] -**containers** | [**kotlin.collections.Map<kotlin.String, NetworkContainer>**](NetworkContainer.md) | | [optional] -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | [optional] +**containers** | [**kotlin.collections.MutableMap<kotlin.String, NetworkContainer>**](NetworkContainer.md) | | [optional] +**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] +**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/NetworkAttachmentConfig.md b/api-model-v1-41/docs/NetworkAttachmentConfig.md index cc959fa3..55eae4cb 100644 --- a/api-model-v1-41/docs/NetworkAttachmentConfig.md +++ b/api-model-v1-41/docs/NetworkAttachmentConfig.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **target** | **kotlin.String** | The target network for attachment. Must be a network name or ID. | [optional] -**aliases** | **kotlin.collections.List<kotlin.String>** | Discoverable alternate names for the service on this network. | [optional] -**driverOpts** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Driver attachment options for the network target. | [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-41/docs/NetworkCreateRequest.md b/api-model-v1-41/docs/NetworkCreateRequest.md index acc23145..ece9d411 100644 --- a/api-model-v1-41/docs/NetworkCreateRequest.md +++ b/api-model-v1-41/docs/NetworkCreateRequest.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **ingress** | **kotlin.Boolean** | Ingress network is the network which provides the routing-mesh in swarm mode. | [optional] **IPAM** | [**IPAM**](IPAM.md) | | [optional] **enableIPv6** | **kotlin.Boolean** | Enable IPv6 on the network. | [optional] -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Network specific options to be used by the drivers. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +**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-41/docs/NetworkPruneResponse.md b/api-model-v1-41/docs/NetworkPruneResponse.md index 4880fb9e..3f4d1a9c 100644 --- a/api-model-v1-41/docs/NetworkPruneResponse.md +++ b/api-model-v1-41/docs/NetworkPruneResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**networksDeleted** | **kotlin.collections.List<kotlin.String>** | Networks that were deleted | [optional] +**networksDeleted** | **kotlin.collections.MutableList<kotlin.String>** | Networks that were deleted | [optional] diff --git a/api-model-v1-41/docs/NetworkSettings.md b/api-model-v1-41/docs/NetworkSettings.md index 4305f380..f8df75d6 100644 --- a/api-model-v1-41/docs/NetworkSettings.md +++ b/api-model-v1-41/docs/NetworkSettings.md @@ -9,10 +9,10 @@ Name | Type | Description | Notes **hairpinMode** | **kotlin.Boolean** | Indicates if hairpin NAT should be enabled on the virtual interface. | [optional] **linkLocalIPv6Address** | **kotlin.String** | IPv6 unicast address using the link-local prefix. | [optional] **linkLocalIPv6PrefixLen** | **kotlin.Int** | Prefix length of the IPv6 unicast address. | [optional] -**ports** | **kotlin.collections.Map<kotlin.String, kotlin.collections.List<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] +**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 identifies the sandbox | [optional] -**secondaryIPAddresses** | [**kotlin.collections.List<Address>**](Address.md) | | [optional] -**secondaryIPv6Addresses** | [**kotlin.collections.List<Address>**](Address.md) | | [optional] +**secondaryIPAddresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | | [optional] +**secondaryIPv6Addresses** | [**kotlin.collections.MutableList<Address>**](Address.md) | | [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] @@ -21,7 +21,7 @@ Name | Type | Description | Notes **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.Map<kotlin.String, EndpointSettings>**](EndpointSettings.md) | Information about all networks that the container is connected to. | [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-41/docs/NetworkingConfig.md b/api-model-v1-41/docs/NetworkingConfig.md index b37627d8..f0d46fa8 100644 --- a/api-model-v1-41/docs/NetworkingConfig.md +++ b/api-model-v1-41/docs/NetworkingConfig.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**endpointsConfig** | [**kotlin.collections.Map<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. | [optional] +**endpointsConfig** | [**kotlin.collections.MutableMap<kotlin.String, EndpointSettings>**](EndpointSettings.md) | A mapping of network name to endpoint configuration for that network. | [optional] diff --git a/api-model-v1-41/docs/NodeSpec.md b/api-model-v1-41/docs/NodeSpec.md index f318edc2..2ff9a542 100644 --- a/api-model-v1-41/docs/NodeSpec.md +++ b/api-model-v1-41/docs/NodeSpec.md @@ -5,19 +5,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | Name for the node. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**role** | [**inline**](#RoleEnum) | Role of the node. | [optional] -**availability** | [**inline**](#AvailabilityEnum) | Availability of 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 ---- | ----- diff --git a/api-model-v1-41/docs/OCIDescriptor.md b/api-model-v1-41/docs/OCIDescriptor.md index 26014af3..f31d04e6 100644 --- a/api-model-v1-41/docs/OCIDescriptor.md +++ b/api-model-v1-41/docs/OCIDescriptor.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mediaType** | **kotlin.String** | The media type of the object this schema refers to. | [optional] **digest** | **kotlin.String** | The digest of the targeted content. | [optional] -**size** | **kotlin.Long** | The size in bytes of the blob. | [optional] +**propertySize** | **kotlin.Long** | The size in bytes of the blob. | [optional] diff --git a/api-model-v1-41/docs/OCIPlatform.md b/api-model-v1-41/docs/OCIPlatform.md index 00be2078..76d3ec98 100644 --- a/api-model-v1-41/docs/OCIPlatform.md +++ b/api-model-v1-41/docs/OCIPlatform.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **architecture** | **kotlin.String** | The CPU architecture, for example `amd64` or `ppc64`. | [optional] **os** | **kotlin.String** | The operating system, for example `linux` or `windows`. | [optional] **osVersion** | **kotlin.String** | Optional field specifying the operating system version, for example on Windows `10.0.19041.1165`. | [optional] -**osFeatures** | **kotlin.collections.List<kotlin.String>** | Optional field specifying an array of strings, each listing a required OS feature (for example on Windows `win32k`). | [optional] +**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-41/docs/PluginConfig.md b/api-model-v1-41/docs/PluginConfig.md index 13e13457..b1c55fba 100644 --- a/api-model-v1-41/docs/PluginConfig.md +++ b/api-model-v1-41/docs/PluginConfig.md @@ -7,15 +7,15 @@ Name | Type | Description | Notes **description** | **kotlin.String** | | **documentation** | **kotlin.String** | | **`interface`** | [**PluginConfigInterface**](PluginConfigInterface.md) | | -**entrypoint** | **kotlin.collections.List<kotlin.String>** | | +**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.List<PluginMount>**](PluginMount.md) | | -**env** | [**kotlin.collections.List<PluginEnv>**](PluginEnv.md) | | +**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] diff --git a/api-model-v1-41/docs/PluginConfigArgs.md b/api-model-v1-41/docs/PluginConfigArgs.md index 85fb163b..d1c4ec86 100644 --- a/api-model-v1-41/docs/PluginConfigArgs.md +++ b/api-model-v1-41/docs/PluginConfigArgs.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | **description** | **kotlin.String** | | -**settable** | **kotlin.collections.List<kotlin.String>** | | -**value** | **kotlin.collections.List<kotlin.String>** | | +**settable** | **kotlin.collections.MutableList<kotlin.String>** | | +**`value`** | **kotlin.collections.MutableList<kotlin.String>** | | diff --git a/api-model-v1-41/docs/PluginConfigInterface.md b/api-model-v1-41/docs/PluginConfigInterface.md index 61fffa76..1dadceb1 100644 --- a/api-model-v1-41/docs/PluginConfigInterface.md +++ b/api-model-v1-41/docs/PluginConfigInterface.md @@ -4,12 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**types** | [**kotlin.collections.List<PluginInterfaceType>**](PluginInterfaceType.md) | | +**types** | [**kotlin.collections.MutableList<PluginInterfaceType>**](PluginInterfaceType.md) | | **socket** | **kotlin.String** | | -**protocolScheme** | [**inline**](#ProtocolSchemeEnum) | Protocol to use for clients connecting to the plugin. | [optional] +**protocolScheme** | [**inline**](#ProtocolScheme) | Protocol to use for clients connecting to the plugin. | [optional] - + ## Enum: ProtocolScheme Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/PluginConfigLinux.md b/api-model-v1-41/docs/PluginConfigLinux.md index c50cd234..a343e2ad 100644 --- a/api-model-v1-41/docs/PluginConfigLinux.md +++ b/api-model-v1-41/docs/PluginConfigLinux.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**capabilities** | **kotlin.collections.List<kotlin.String>** | | +**capabilities** | **kotlin.collections.MutableList<kotlin.String>** | | **allowAllDevices** | **kotlin.Boolean** | | -**devices** | [**kotlin.collections.List<PluginDevice>**](PluginDevice.md) | | +**devices** | [**kotlin.collections.MutableList<PluginDevice>**](PluginDevice.md) | | diff --git a/api-model-v1-41/docs/PluginConfigRootfs.md b/api-model-v1-41/docs/PluginConfigRootfs.md index 72d9b6ea..b216d3e8 100644 --- a/api-model-v1-41/docs/PluginConfigRootfs.md +++ b/api-model-v1-41/docs/PluginConfigRootfs.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **kotlin.String** | | [optional] -**diffIds** | **kotlin.collections.List<kotlin.String>** | | [optional] +**diffIds** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/PluginDevice.md b/api-model-v1-41/docs/PluginDevice.md index 12cdc57d..55c5bc33 100644 --- a/api-model-v1-41/docs/PluginDevice.md +++ b/api-model-v1-41/docs/PluginDevice.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | **description** | **kotlin.String** | | -**settable** | **kotlin.collections.List<kotlin.String>** | | +**settable** | **kotlin.collections.MutableList<kotlin.String>** | | **path** | **kotlin.String** | | diff --git a/api-model-v1-41/docs/PluginEnv.md b/api-model-v1-41/docs/PluginEnv.md index f246900e..49ccca71 100644 --- a/api-model-v1-41/docs/PluginEnv.md +++ b/api-model-v1-41/docs/PluginEnv.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | **description** | **kotlin.String** | | -**settable** | **kotlin.collections.List<kotlin.String>** | | -**value** | **kotlin.String** | | +**settable** | **kotlin.collections.MutableList<kotlin.String>** | | +**`value`** | **kotlin.String** | | diff --git a/api-model-v1-41/docs/PluginMount.md b/api-model-v1-41/docs/PluginMount.md index 0e37972f..c6dff2af 100644 --- a/api-model-v1-41/docs/PluginMount.md +++ b/api-model-v1-41/docs/PluginMount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | **description** | **kotlin.String** | | -**settable** | **kotlin.collections.List<kotlin.String>** | | +**settable** | **kotlin.collections.MutableList<kotlin.String>** | | **source** | **kotlin.String** | | **destination** | **kotlin.String** | | **type** | **kotlin.String** | | -**options** | **kotlin.collections.List<kotlin.String>** | | +**options** | **kotlin.collections.MutableList<kotlin.String>** | | diff --git a/api-model-v1-41/docs/PluginPrivilege.md b/api-model-v1-41/docs/PluginPrivilege.md index 93ab7751..4e580989 100644 --- a/api-model-v1-41/docs/PluginPrivilege.md +++ b/api-model-v1-41/docs/PluginPrivilege.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | [optional] **description** | **kotlin.String** | | [optional] -**value** | **kotlin.collections.List<kotlin.String>** | | [optional] +**`value`** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/PluginSettings.md b/api-model-v1-41/docs/PluginSettings.md index d3e50757..8d1985c2 100644 --- a/api-model-v1-41/docs/PluginSettings.md +++ b/api-model-v1-41/docs/PluginSettings.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mounts** | [**kotlin.collections.List<PluginMount>**](PluginMount.md) | | -**env** | **kotlin.collections.List<kotlin.String>** | | -**args** | **kotlin.collections.List<kotlin.String>** | | -**devices** | [**kotlin.collections.List<PluginDevice>**](PluginDevice.md) | | +**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-41/docs/PluginsInfo.md b/api-model-v1-41/docs/PluginsInfo.md index 15bd737b..233e9342 100644 --- a/api-model-v1-41/docs/PluginsInfo.md +++ b/api-model-v1-41/docs/PluginsInfo.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**volume** | **kotlin.collections.List<kotlin.String>** | Names of available volume-drivers, and network-driver plugins. | [optional] -**network** | **kotlin.collections.List<kotlin.String>** | Names of available network-drivers, and network-driver plugins. | [optional] -**authorization** | **kotlin.collections.List<kotlin.String>** | Names of available authorization plugins. | [optional] -**log** | **kotlin.collections.List<kotlin.String>** | Names of available logging-drivers, and logging-driver plugins. | [optional] +**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-41/docs/Port.md b/api-model-v1-41/docs/Port.md index 3bc6e75f..0b6c8598 100644 --- a/api-model-v1-41/docs/Port.md +++ b/api-model-v1-41/docs/Port.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **privatePort** | **kotlin.Int** | Port on the container | -**type** | [**inline**](#TypeEnum) | | +**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 ---- | ----- diff --git a/api-model-v1-41/docs/ProcessConfig.md b/api-model-v1-41/docs/ProcessConfig.md index a83e844d..5ad4c154 100644 --- a/api-model-v1-41/docs/ProcessConfig.md +++ b/api-model-v1-41/docs/ProcessConfig.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **user** | **kotlin.String** | | [optional] **tty** | **kotlin.Boolean** | | [optional] **entrypoint** | **kotlin.String** | | [optional] -**arguments** | **kotlin.collections.List<kotlin.String>** | | [optional] +**arguments** | **kotlin.collections.MutableList<kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/RegistryServiceConfig.md b/api-model-v1-41/docs/RegistryServiceConfig.md index 302fb7be..052a1274 100644 --- a/api-model-v1-41/docs/RegistryServiceConfig.md +++ b/api-model-v1-41/docs/RegistryServiceConfig.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**allowNondistributableArtifactsCIDRs** | **kotlin.collections.List<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). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] -**allowNondistributableArtifactsHostnames** | **kotlin.collections.List<kotlin.String>** | List of registry hostnames to which nondistributable artifacts can be pushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [optional] -**insecureRegistryCIDRs** | **kotlin.collections.List<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.Map<kotlin.String, IndexInfo>**](IndexInfo.md) | | [optional] -**mirrors** | **kotlin.collections.List<kotlin.String>** | List of registry URLs that act as a mirror for the official (`docker.io`) registry. | [optional] +**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). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [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>]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. | [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-41/docs/ResourceObject.md b/api-model-v1-41/docs/ResourceObject.md index da4e7033..ef6d3b71 100644 --- a/api-model-v1-41/docs/ResourceObject.md +++ b/api-model-v1-41/docs/ResourceObject.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **nanoCPUs** | **kotlin.Long** | | [optional] **memoryBytes** | **kotlin.Long** | | [optional] -**genericResources** | [**kotlin.collections.List<kotlin.Any>**](kotlin.Any.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] +**genericResources** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.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-41/docs/Resources.md b/api-model-v1-41/docs/Resources.md index 4fea9775..3a1a75a3 100644 --- a/api-model-v1-41/docs/Resources.md +++ b/api-model-v1-41/docs/Resources.md @@ -8,20 +8,20 @@ Name | Type | Description | Notes **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.List<ResourcesBlkioWeightDevice>**](ResourcesBlkioWeightDevice.md) | Block IO weight (relative device weight) in the form: ``` [{\"Path\": \"device_path\", \"Weight\": weight}] ``` | [optional] -**blkioDeviceReadBps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (bytes per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteBps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (bytes per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceReadIOps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit read rate (IO per second) from a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] -**blkioDeviceWriteIOps** | [**kotlin.collections.List<ThrottleDevice>**](ThrottleDevice.md) | Limit write rate (IO per second) to a device, in the form: ``` [{\"Path\": \"device_path\", \"Rate\": rate}] ``` | [optional] +**blkioWeightDevice** | [**kotlin.collections.MutableList<ResourcesBlkioWeightDevice>**](ResourcesBlkioWeightDevice.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.List<DeviceMapping>**](DeviceMapping.md) | A list of devices to add to the container. | [optional] -**deviceCgroupRules** | **kotlin.collections.List<kotlin.String>** | a list of cgroup rules to apply to the container | [optional] -**deviceRequests** | [**kotlin.collections.List<DeviceRequest>**](DeviceRequest.md) | A list of requests for devices to be sent to device drivers. | [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] **kernelMemory** | **kotlin.Long** | Kernel memory limit in bytes. <p><br /></p> > **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. | [optional] **kernelMemoryTCP** | **kotlin.Long** | Hard limit for kernel TCP buffer memory (in bytes). | [optional] **memoryReservation** | **kotlin.Long** | Memory soft limit in bytes. | [optional] @@ -29,9 +29,9 @@ Name | Type | Description | Notes **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] +**`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.List<ResourcesUlimits>**](ResourcesUlimits.md) | A list of resource limits to set in the container. For example: ``` {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048} ``` | [optional] +**ulimits** | [**kotlin.collections.MutableList<ResourcesUlimits>**](ResourcesUlimits.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] diff --git a/api-model-v1-41/docs/RestartPolicy.md b/api-model-v1-41/docs/RestartPolicy.md index b0e3950f..175cf3e3 100644 --- a/api-model-v1-41/docs/RestartPolicy.md +++ b/api-model-v1-41/docs/RestartPolicy.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | [**inline**](#NameEnum) | - Empty string means not to restart - `no` Do not automatically restart - `always` Always restart - `unless-stopped` Restart always except when the user has manually stopped the container - `on-failure` Restart only when the container exit code is non-zero | [optional] +**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 ---- | ----- diff --git a/api-model-v1-41/docs/Runtime.md b/api-model-v1-41/docs/Runtime.md index 36487203..2d06eca7 100644 --- a/api-model-v1-41/docs/Runtime.md +++ b/api-model-v1-41/docs/Runtime.md @@ -5,7 +5,7 @@ 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.List<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] +**runtimeArgs** | **kotlin.collections.MutableList<kotlin.String>** | List of command-line arguments to pass to the runtime when invoked. | [optional] diff --git a/api-model-v1-41/docs/SecretSpec.md b/api-model-v1-41/docs/SecretSpec.md index b6116ec3..38118de3 100644 --- a/api-model-v1-41/docs/SecretSpec.md +++ b/api-model-v1-41/docs/SecretSpec.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | User-defined name of the secret. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] -**data** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. | [optional] +**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [optional] +**`data`** | **kotlin.String** | Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. 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-41/docs/ServiceEndpoint.md b/api-model-v1-41/docs/ServiceEndpoint.md index fe0470fe..ca527f64 100644 --- a/api-model-v1-41/docs/ServiceEndpoint.md +++ b/api-model-v1-41/docs/ServiceEndpoint.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **spec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] -**ports** | [**kotlin.collections.List<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] -**virtualIPs** | [**kotlin.collections.List<ServiceEndpointVirtualIPs>**](ServiceEndpointVirtualIPs.md) | | [optional] +**ports** | [**kotlin.collections.MutableList<EndpointPortConfig>**](EndpointPortConfig.md) | | [optional] +**virtualIPs** | [**kotlin.collections.MutableList<ServiceEndpointVirtualIPs>**](ServiceEndpointVirtualIPs.md) | | [optional] diff --git a/api-model-v1-41/docs/ServiceSpec.md b/api-model-v1-41/docs/ServiceSpec.md index 55251900..9b593122 100644 --- a/api-model-v1-41/docs/ServiceSpec.md +++ b/api-model-v1-41/docs/ServiceSpec.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | Name of the service. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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.List<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] +**networks** | [**kotlin.collections.MutableList<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [optional] **endpointSpec** | [**EndpointSpec**](EndpointSpec.md) | | [optional] diff --git a/api-model-v1-41/docs/ServiceSpecRollbackConfig.md b/api-model-v1-41/docs/ServiceSpecRollbackConfig.md index 00eb640f..4dcd754b 100644 --- a/api-model-v1-41/docs/ServiceSpecRollbackConfig.md +++ b/api-model-v1-41/docs/ServiceSpecRollbackConfig.md @@ -6,20 +6,20 @@ 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**](#FailureActionEnum) | Action to take if an rolled back task fails to run, or stops running during the rollback. | [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**](#OrderEnum) | 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] +**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 ---- | ----- diff --git a/api-model-v1-41/docs/ServiceSpecUpdateConfig.md b/api-model-v1-41/docs/ServiceSpecUpdateConfig.md index 347065a7..26fd825d 100644 --- a/api-model-v1-41/docs/ServiceSpecUpdateConfig.md +++ b/api-model-v1-41/docs/ServiceSpecUpdateConfig.md @@ -6,20 +6,20 @@ 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**](#FailureActionEnum) | Action to take if an updated task fails to run, or stops running during the update. | [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**](#OrderEnum) | 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] +**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 ---- | ----- diff --git a/api-model-v1-41/docs/ServiceUpdateResponse.md b/api-model-v1-41/docs/ServiceUpdateResponse.md index 70d64abb..6de72db5 100644 --- a/api-model-v1-41/docs/ServiceUpdateResponse.md +++ b/api-model-v1-41/docs/ServiceUpdateResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**warnings** | **kotlin.collections.List<kotlin.String>** | Optional warning messages | [optional] +**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Optional warning messages | [optional] diff --git a/api-model-v1-41/docs/ServiceUpdateStatus.md b/api-model-v1-41/docs/ServiceUpdateStatus.md index 9934f363..50b28450 100644 --- a/api-model-v1-41/docs/ServiceUpdateStatus.md +++ b/api-model-v1-41/docs/ServiceUpdateStatus.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**state** | [**inline**](#StateEnum) | | [optional] +**state** | [**inline**](#State) | | [optional] **startedAt** | **kotlin.String** | | [optional] **completedAt** | **kotlin.String** | | [optional] **message** | **kotlin.String** | | [optional] - + ## Enum: State Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/Swarm.md b/api-model-v1-41/docs/Swarm.md index 2912c660..b0eb5255 100644 --- a/api-model-v1-41/docs/Swarm.md +++ b/api-model-v1-41/docs/Swarm.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **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.List<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [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-41/docs/SwarmInfo.md b/api-model-v1-41/docs/SwarmInfo.md index c3a74a34..9dea5c10 100644 --- a/api-model-v1-41/docs/SwarmInfo.md +++ b/api-model-v1-41/docs/SwarmInfo.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **localNodeState** | [**LocalNodeState**](LocalNodeState.md) | | [optional] **controlAvailable** | **kotlin.Boolean** | | [optional] **error** | **kotlin.String** | | [optional] -**remoteManagers** | [**kotlin.collections.List<PeerNode>**](PeerNode.md) | List of ID's and addresses of other managers in the swarm. | [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-41/docs/SwarmInitRequest.md b/api-model-v1-41/docs/SwarmInitRequest.md index 953330e9..9c3d9c68 100644 --- a/api-model-v1-41/docs/SwarmInitRequest.md +++ b/api-model-v1-41/docs/SwarmInitRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] **dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] **dataPathPort** | **kotlin.Int** | DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. if no port is set or is set to 0, default port 4789 will be used. | [optional] -**defaultAddrPool** | **kotlin.collections.List<kotlin.String>** | Default Address Pool specifies default subnet pools for global scope networks. | [optional] +**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-41/docs/SwarmJoinRequest.md b/api-model-v1-41/docs/SwarmJoinRequest.md index ead4a099..5dd4fa1e 100644 --- a/api-model-v1-41/docs/SwarmJoinRequest.md +++ b/api-model-v1-41/docs/SwarmJoinRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **listenAddr** | **kotlin.String** | Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). | [optional] **advertiseAddr** | **kotlin.String** | Externally reachable address advertised to other nodes. This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the port number from the listen address is used. If `AdvertiseAddr` is not specified, it will be automatically detected when possible. | [optional] **dataPathAddr** | **kotlin.String** | Address or interface to use for data path traffic (format: `<ip|interface>`), for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is unspecified, the same address as `AdvertiseAddr` is used. The `DataPathAddr` specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster. | [optional] -**remoteAddrs** | **kotlin.collections.List<kotlin.String>** | Addresses of manager nodes already participating in the swarm. | [optional] +**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-41/docs/SwarmSpec.md b/api-model-v1-41/docs/SwarmSpec.md index 2485cc94..5a6a4a9f 100644 --- a/api-model-v1-41/docs/SwarmSpec.md +++ b/api-model-v1-41/docs/SwarmSpec.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | Name of the swarm. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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] diff --git a/api-model-v1-41/docs/SwarmSpecCAConfig.md b/api-model-v1-41/docs/SwarmSpecCAConfig.md index 355ae40d..172ee698 100644 --- a/api-model-v1-41/docs/SwarmSpecCAConfig.md +++ b/api-model-v1-41/docs/SwarmSpecCAConfig.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **nodeCertExpiry** | **kotlin.Long** | The duration node certificates are issued for. | [optional] -**externalCAs** | [**kotlin.collections.List<SwarmSpecCAConfigExternalCAs>**](SwarmSpecCAConfigExternalCAs.md) | Configuration for forwarding signing requests to an external certificate authority. | [optional] +**externalCAs** | [**kotlin.collections.MutableList<SwarmSpecCAConfigExternalCAs>**](SwarmSpecCAConfigExternalCAs.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-41/docs/SwarmSpecCAConfigExternalCAs.md b/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAs.md index e9c51b57..bed08464 100644 --- a/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAs.md +++ b/api-model-v1-41/docs/SwarmSpecCAConfigExternalCAs.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**protocol** | [**inline**](#ProtocolEnum) | Protocol for communication with the external CA (currently only `cfssl` is supported). | [optional] +**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.Map<kotlin.String, kotlin.String>** | An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. | [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 ---- | ----- diff --git a/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md b/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md index 6ad5aa4e..0f0df03c 100644 --- a/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md +++ b/api-model-v1-41/docs/SwarmSpecTaskDefaultsLogDriver.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | The log driver to use as a default for new tasks. | [optional] -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | Driver-specific options for the selectd log driver, specified as key/value pairs. | [optional] +**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | Driver-specific options for the selectd log driver, specified as key/value pairs. | [optional] diff --git a/api-model-v1-41/docs/SystemDataUsageResponse.md b/api-model-v1-41/docs/SystemDataUsageResponse.md index 749b7930..919d9273 100644 --- a/api-model-v1-41/docs/SystemDataUsageResponse.md +++ b/api-model-v1-41/docs/SystemDataUsageResponse.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **layersSize** | **kotlin.Long** | | [optional] -**images** | [**kotlin.collections.List<ImageSummary>**](ImageSummary.md) | | [optional] -**containers** | [**kotlin.collections.List<ContainerSummary>**](ContainerSummary.md) | | [optional] -**volumes** | [**kotlin.collections.List<Volume>**](Volume.md) | | [optional] -**buildCache** | [**kotlin.collections.List<BuildCache>**](BuildCache.md) | | [optional] +**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-41/docs/SystemInfo.md b/api-model-v1-41/docs/SystemInfo.md index e7fa6335..a9c819e7 100644 --- a/api-model-v1-41/docs/SystemInfo.md +++ b/api-model-v1-41/docs/SystemInfo.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **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.List<kotlin.collections.List<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] +**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] @@ -31,8 +31,8 @@ Name | Type | Description | Notes **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**](#CgroupDriverEnum) | The driver to use for managing cgroups. | [optional] -**cgroupVersion** | [**inline**](#CgroupVersionEnum) | The version of the cgroup. | [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] @@ -43,46 +43,46 @@ Name | Type | Description | Notes **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.List<kotlin.Any>**](kotlin.Any.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] +**genericResources** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.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.List<kotlin.String>** | User-defined labels (key/value metadata) as set on the daemon. <p><br /></p> > **Note**: When part of a Swarm, nodes can both have _daemon_ labels, > set through the daemon configuration, and _node_ labels, set from a > manager node in the Swarm. Node labels are not included in this > field. Node labels can be retrieved using the `/nodes/(id)` endpoint > on a manager node in the Swarm. | [optional] +**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. > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. | [optional] **clusterStore** | **kotlin.String** | URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism. <p><br /></p> > **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. | [optional] **clusterAdvertise** | **kotlin.String** | The network endpoint that the Engine advertises for the purpose of node discovery. ClusterAdvertise is a `host:port` combination on which the daemon is reachable by other hosts. <p><br /></p> > **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. | [optional] -**runtimes** | [**kotlin.collections.Map<kotlin.String, Runtime>**](Runtime.md) | List of [OCI compliant](https://github.com/opencontainers/runtime-spec) runtimes configured on the daemon. Keys hold the \"name\" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the `containerd` daemon) as its interface to the Linux kernel namespaces, cgroups, and SELinux. The default runtime is `runc`, and automatically configured. Additional runtimes can be configured by the user and will be listed here. | [optional] +**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**](#IsolationEnum) | 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] +**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.List<kotlin.String>** | List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), and rootless. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | [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), and rootless. 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.List<SystemInfoDefaultAddressPools>**](SystemInfoDefaultAddressPools.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.List<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] +**defaultAddressPools** | [**kotlin.collections.MutableList<SystemInfoDefaultAddressPools>**](SystemInfoDefaultAddressPools.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] - + ## Enum: CgroupDriver Name | Value ---- | ----- cgroupDriver | cgroupfs, systemd, none - + ## Enum: CgroupVersion Name | Value ---- | ----- cgroupVersion | 1, 2 - + ## Enum: Isolation Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/SystemInfoDefaultAddressPools.md b/api-model-v1-41/docs/SystemInfoDefaultAddressPools.md index ee6a4872..83939a12 100644 --- a/api-model-v1-41/docs/SystemInfoDefaultAddressPools.md +++ b/api-model-v1-41/docs/SystemInfoDefaultAddressPools.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **base** | **kotlin.String** | The network address in CIDR format | [optional] -**size** | **kotlin.Int** | The network pool size | [optional] +**propertySize** | **kotlin.Int** | The network pool size | [optional] diff --git a/api-model-v1-41/docs/SystemVersion.md b/api-model-v1-41/docs/SystemVersion.md index 60c694f6..ec211bc4 100644 --- a/api-model-v1-41/docs/SystemVersion.md +++ b/api-model-v1-41/docs/SystemVersion.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **platform** | [**SystemVersionPlatform**](SystemVersionPlatform.md) | | [optional] -**components** | [**kotlin.collections.List<SystemVersionComponents>**](SystemVersionComponents.md) | Information about system components | [optional] +**components** | [**kotlin.collections.MutableList<SystemVersionComponents>**](SystemVersionComponents.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] diff --git a/api-model-v1-41/docs/Task.md b/api-model-v1-41/docs/Task.md index d38af942..0ce2dcc2 100644 --- a/api-model-v1-41/docs/Task.md +++ b/api-model-v1-41/docs/Task.md @@ -9,12 +9,12 @@ Name | Type | Description | Notes **createdAt** | **kotlin.String** | | [optional] **updatedAt** | **kotlin.String** | | [optional] **name** | **kotlin.String** | Name of the task. | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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.List<kotlin.Any>**](kotlin.Any.md) | User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`). | [optional] +**assignedGenericResources** | [**kotlin.collections.MutableList<kotlin.Any>**](kotlin.Any.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-41/docs/TaskSpec.md b/api-model-v1-41/docs/TaskSpec.md index 4a3e62c9..b008cdde 100644 --- a/api-model-v1-41/docs/TaskSpec.md +++ b/api-model-v1-41/docs/TaskSpec.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **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.List<NetworkAttachmentConfig>**](NetworkAttachmentConfig.md) | Specifies which networks the service should attach to. | [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-41/docs/TaskSpecContainerSpec.md b/api-model-v1-41/docs/TaskSpecContainerSpec.md index 7a90a81e..9df6c027 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpec.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpec.md @@ -5,35 +5,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **image** | **kotlin.String** | The image name to use for the container | [optional] -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value data. | [optional] -**command** | **kotlin.collections.List<kotlin.String>** | The command to be run in the image. | [optional] -**args** | **kotlin.collections.List<kotlin.String>** | Arguments to the command. | [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.List<kotlin.String>** | A list of environment variables in the form `VAR=value`. | [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.List<kotlin.String>** | A list of additional groups that the container process will run as. | [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.List<Mount>**](Mount.md) | Specification for mounts to be added to containers created as part of the service. | [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.List<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] +**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.List<TaskSpecContainerSpecSecrets>**](TaskSpecContainerSpecSecrets.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] -**configs** | [**kotlin.collections.List<TaskSpecContainerSpecConfigs>**](TaskSpecContainerSpecConfigs.md) | Configs contains references to zero or more configs that will be exposed to the service. | [optional] -**isolation** | [**inline**](#IsolationEnum) | 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.Map<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.List<kotlin.String>** | A list of kernel capabilities to add to the default set for the container. | [optional] -**capabilityDrop** | **kotlin.collections.List<kotlin.String>** | A list of kernel capabilities to drop from the default set for the container. | [optional] -**ulimits** | [**kotlin.collections.List<ResourcesUlimits>**](ResourcesUlimits.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] +**secrets** | [**kotlin.collections.MutableList<TaskSpecContainerSpecSecrets>**](TaskSpecContainerSpecSecrets.md) | Secrets contains references to zero or more secrets that will be exposed to the service. | [optional] +**configs** | [**kotlin.collections.MutableList<TaskSpecContainerSpecConfigs>**](TaskSpecContainerSpecConfigs.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<ResourcesUlimits>**](ResourcesUlimits.md) | A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" | [optional] - + ## Enum: Isolation Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md b/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md index afc9ac5d..75bff49a 100644 --- a/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md +++ b/api-model-v1-41/docs/TaskSpecContainerSpecDNSConfig.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**nameservers** | **kotlin.collections.List<kotlin.String>** | The IP addresses of the name servers. | [optional] -**search** | **kotlin.collections.List<kotlin.String>** | A search list for host-name lookup. | [optional] -**options** | **kotlin.collections.List<kotlin.String>** | A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.). | [optional] +**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-41/docs/TaskSpecLogDriver.md b/api-model-v1-41/docs/TaskSpecLogDriver.md index e9758751..a0cfb139 100644 --- a/api-model-v1-41/docs/TaskSpecLogDriver.md +++ b/api-model-v1-41/docs/TaskSpecLogDriver.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **kotlin.String** | | [optional] -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | | [optional] +**options** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | | [optional] diff --git a/api-model-v1-41/docs/TaskSpecPlacement.md b/api-model-v1-41/docs/TaskSpecPlacement.md index 50e66b7f..2839b8c5 100644 --- a/api-model-v1-41/docs/TaskSpecPlacement.md +++ b/api-model-v1-41/docs/TaskSpecPlacement.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**constraints** | **kotlin.collections.List<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.List<TaskSpecPlacementPreferences>**](TaskSpecPlacementPreferences.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] +**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<TaskSpecPlacementPreferences>**](TaskSpecPlacementPreferences.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.List<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] +**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-41/docs/TaskSpecPluginSpec.md b/api-model-v1-41/docs/TaskSpecPluginSpec.md index 8035a40a..7adb8c81 100644 --- a/api-model-v1-41/docs/TaskSpecPluginSpec.md +++ b/api-model-v1-41/docs/TaskSpecPluginSpec.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **name** | **kotlin.String** | The name or 'alias' to use for the plugin. | [optional] **remote** | **kotlin.String** | The plugin image reference to use. | [optional] **disabled** | **kotlin.Boolean** | Disable the plugin once scheduled. | [optional] -**pluginPrivilege** | [**kotlin.collections.List<PluginPrivilege>**](PluginPrivilege.md) | | [optional] +**pluginPrivilege** | [**kotlin.collections.MutableList<PluginPrivilege>**](PluginPrivilege.md) | | [optional] diff --git a/api-model-v1-41/docs/TaskSpecRestartPolicy.md b/api-model-v1-41/docs/TaskSpecRestartPolicy.md index 4f8cc350..f29f3922 100644 --- a/api-model-v1-41/docs/TaskSpecRestartPolicy.md +++ b/api-model-v1-41/docs/TaskSpecRestartPolicy.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**condition** | [**inline**](#ConditionEnum) | Condition for restart. | [optional] +**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 ---- | ----- diff --git a/api-model-v1-41/docs/Volume.md b/api-model-v1-41/docs/Volume.md index 462d006a..a27c6687 100644 --- a/api-model-v1-41/docs/Volume.md +++ b/api-model-v1-41/docs/Volume.md @@ -7,15 +7,15 @@ 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. | -**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | -**scope** | [**inline**](#ScopeEnum) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | -**options** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | The driver specific options used when creating the volume. | +**labels** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | User-defined key/value metadata. | +**scope** | [**inline**](#Scope) | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. | +**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.Map<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] +**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] **usageData** | [**VolumeUsageData**](VolumeUsageData.md) | | [optional] - + ## Enum: Scope Name | Value ---- | ----- diff --git a/api-model-v1-41/docs/VolumeConfig.md b/api-model-v1-41/docs/VolumeConfig.md index ed94d00c..286b4c0b 100644 --- a/api-model-v1-41/docs/VolumeConfig.md +++ b/api-model-v1-41/docs/VolumeConfig.md @@ -6,8 +6,8 @@ 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.Map<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.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. | [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] diff --git a/api-model-v1-41/docs/VolumeListResponse.md b/api-model-v1-41/docs/VolumeListResponse.md index 27809166..67337586 100644 --- a/api-model-v1-41/docs/VolumeListResponse.md +++ b/api-model-v1-41/docs/VolumeListResponse.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**volumes** | [**kotlin.collections.List<Volume>**](Volume.md) | List of volumes | -**warnings** | **kotlin.collections.List<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | +**volumes** | [**kotlin.collections.MutableList<Volume>**](Volume.md) | List of volumes | +**warnings** | **kotlin.collections.MutableList<kotlin.String>** | Warnings that occurred when fetching the list of volumes. | diff --git a/api-model-v1-41/docs/VolumePruneResponse.md b/api-model-v1-41/docs/VolumePruneResponse.md index bab150e0..bd4d15c5 100644 --- a/api-model-v1-41/docs/VolumePruneResponse.md +++ b/api-model-v1-41/docs/VolumePruneResponse.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**volumesDeleted** | **kotlin.collections.List<kotlin.String>** | Volumes that were deleted | [optional] +**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-41/docs/VolumeUsageData.md b/api-model-v1-41/docs/VolumeUsageData.md index d191d54c..cf3e05e7 100644 --- a/api-model-v1-41/docs/VolumeUsageData.md +++ b/api-model-v1-41/docs/VolumeUsageData.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**size** | **kotlin.Int** | 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\") | +**propertySize** | **kotlin.Int** | 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.Int** | 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt index a3406eed..1d83fce8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt index 90ef58ff..cf027ee6 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -23,12 +33,17 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class AuthConfig( + @Json(name = "username") var username: kotlin.String? = null, + @Json(name = "password") var password: kotlin.String? = null, + @Json(name = "email") var email: kotlin.String? = null, + @Json(name = "serveraddress") var serveraddress: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt index 5215f7da..154fd8fd 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 parent @@ -22,34 +32,45 @@ import com.squareup.moshi.JsonClass * @param description * @param inUse * @param shared - * @param size Amount of disk space used by the build cache (in bytes). + * @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( + @Json(name = "ID") var ID: kotlin.String? = null, + @Json(name = "Parent") var parent: kotlin.String? = null, + @Json(name = "Type") var type: kotlin.String? = null, + @Json(name = "Description") var description: kotlin.String? = null, + @Json(name = "InUse") var inUse: kotlin.Boolean? = null, + @Json(name = "Shared") var shared: kotlin.Boolean? = null, + /* Amount of disk space used by the build cache (in bytes). */ @Json(name = "Size") - var size: kotlin.Int? = null, + 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 + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt index d5058cbc..3a527028 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -27,20 +37,29 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt index 53a3d961..878378bc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt @@ -1,29 +1,42 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt index 55589e95..db511c4d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ClusterInfo.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -29,31 +39,42 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt index 251b8217..4a74d4ff 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Commit.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt index 3e808862..5fc50ddc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Config.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt index c56b4f95..e8a813fd 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigSpec.kt @@ -1,37 +1,52 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. + * @param `data` Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. * @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.Map? = null, + var labels: kotlin.collections.MutableMap? = null, + /* Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) config data. */ @Json(name = "Data") - var data: kotlin.String? = null, + var `data`: kotlin.String? = null, + @Json(name = "Templating") var templating: Driver? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerChangeResponseItem.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerChangeResponseItem.kt index fbbb8748..398f53f8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerChangeResponseItem.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerChangeResponseItem.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ import com.squareup.moshi.JsonClass /** * change item in response to ContainerChanges operation + * * @param path Path to file that has changed * @param kind Kind of change */ @JsonClass(generateAdapter = true) data class ContainerChangeResponseItem( + /* Path to file that has changed */ @Json(name = "Path") var path: kotlin.String, + /* Kind of change */ @Json(name = "Kind") var kind: kotlin.Int + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt index 34dc3dde..1ed964fb 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 The user that commands are run as inside the container. @@ -44,78 +54,104 @@ import com.squareup.moshi.JsonClass */ @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? = null, + var attachStdin: kotlin.Boolean? = false, + /* Whether to attach to `stdout`. */ @Json(name = "AttachStdout") - var attachStdout: kotlin.Boolean? = null, + var attachStdout: kotlin.Boolean? = true, + /* Whether to attach to `stderr`. */ @Json(name = "AttachStderr") - var attachStderr: kotlin.Boolean? = null, + var attachStderr: kotlin.Boolean? = true, + /* An object mapping ports to an empty object in the form: `{\"/\": {}}` */ @Json(name = "ExposedPorts") - var exposedPorts: kotlin.collections.Map? = null, + 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? = null, + var tty: kotlin.Boolean? = false, + /* Open `stdin` */ @Json(name = "OpenStdin") - var openStdin: kotlin.Boolean? = null, + var openStdin: kotlin.Boolean? = false, + /* Close `stdin` after one attached client disconnects */ @Json(name = "StdinOnce") - var stdinOnce: kotlin.Boolean? = null, + 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.List? = null, + 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.List? = null, + 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 of the image to use when creating the container/ */ @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.Map? = null, + 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.List? = null, + var entrypoint: kotlin.collections.MutableList? = null, + /* Disable networking for the container. */ @Json(name = "NetworkDisabled") var networkDisabled: kotlin.Boolean? = null, + /* MAC address of the container. */ @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.List? = null, + var onBuild: kotlin.collections.MutableList? = null, + /* User-defined key/value metadata. */ @Json(name = "Labels") - var labels: kotlin.collections.Map? = null, + 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, + 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.List? = null + var shell: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt index 26a8cb91..498964b6 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequest.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -18,84 +27,140 @@ import com.squareup.moshi.JsonClass // - ContainerConfig (embedded) // - HostConfig // - NetworkingConfig +/** + * 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 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 of the image to use when creating the container/ + * @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. + * @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 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? = null, + var attachStdin: kotlin.Boolean? = false, + /* Whether to attach to `stdout`. */ @Json(name = "AttachStdout") - var attachStdout: kotlin.Boolean? = null, + var attachStdout: kotlin.Boolean? = true, + /* Whether to attach to `stderr`. */ @Json(name = "AttachStderr") - var attachStderr: kotlin.Boolean? = null, + var attachStderr: kotlin.Boolean? = true, + /* An object mapping ports to an empty object in the form: `{\"/\": {}}` */ @Json(name = "ExposedPorts") - var exposedPorts: kotlin.collections.Map? = null, + 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? = null, + var tty: kotlin.Boolean? = false, + /* Open `stdin` */ @Json(name = "OpenStdin") - var openStdin: kotlin.Boolean? = null, + var openStdin: kotlin.Boolean? = false, + /* Close `stdin` after one attached client disconnects */ @Json(name = "StdinOnce") - var stdinOnce: kotlin.Boolean? = null, + 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.List? = null, + 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.List? = null, + 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 of the image to use when creating the container/ */ @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.Map? = null, + 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.List? = null, + var entrypoint: kotlin.collections.MutableList? = null, + /* Disable networking for the container. */ @Json(name = "NetworkDisabled") var networkDisabled: kotlin.Boolean? = null, + /* MAC address of the container. */ @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.List? = null, + var onBuild: kotlin.collections.MutableList? = null, + /* User-defined key/value metadata. */ @Json(name = "Labels") - var labels: kotlin.collections.Map? = null, + 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, + 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt index a1d17d1e..c125b59e 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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.List? + var warnings: kotlin.collections.MutableList? + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt index 61a1ac40..e10cb8aa 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerInspectResponse.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -44,62 +54,88 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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.List? = null, + 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt index eb868bd9..aa623454 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerPruneResponse.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt index 65e0eda5..d7640419 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerState.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -31,43 +41,57 @@ import com.squareup.moshi.JsonClass */ @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 this container has been killed because it ran out of memory. */ @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 */ enum class Status(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt index 410129e2..b6d8153a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummary.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -34,46 +44,62 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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.List? = null, + 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.Map? = null, + 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.List? = null + var mounts: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt index b0cabcfb..c2335173 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryHostConfig.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt index da08afa4..dbc880cc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerSummaryNetworkSettings.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,10 +25,13 @@ 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.Map? = null + var networks: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt index 978c3743..ff0e4947 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerTopResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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.List? = null, + 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.List>? = null + var processes: kotlin.collections.MutableList>? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt index d2be52be..f37ab2eb 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequest.kt @@ -1,9 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -12,104 +26,173 @@ import com.squareup.moshi.JsonClass // Merged from: // - Resources (embedded) // - RestartPolicy +/** + * 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 kernelMemory Kernel memory limit in bytes.


> **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. + * @param kernelMemoryTCP Hard limit for kernel TCP buffer memory (in bytes). + * @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 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? = null, + var memory: kotlin.Long? = 0, + /* 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + var devices: kotlin.collections.MutableList? = null, + /* a list of cgroup rules to apply to the container */ @Json(name = "DeviceCgroupRules") - var deviceCgroupRules: kotlin.collections.List? = null, + 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.List? = null, + var deviceRequests: kotlin.collections.MutableList? = null, + /* Kernel memory limit in bytes.


> **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. */ @Json(name = "KernelMemory") var kernelMemory: kotlin.Long? = null, + /* Hard limit for kernel TCP buffer memory (in bytes). */ @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, + 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt index 63b6e61d..3781146d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,10 +25,13 @@ 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.List? = null + var warnings: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt index 1fc86a7d..02bf3018 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,14 +25,18 @@ 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: java.math.BigDecimal, + @Json(name = "Error") var error: ContainerWaitResponseError? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponseError.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponseError.kt index a45a8517..50649249 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponseError.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitResponseError.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ import com.squareup.moshi.JsonClass /** * container waiting error, if any + * * @param message Details of an error */ @JsonClass(generateAdapter = true) data class ContainerWaitResponseError( + /* Details of an error */ @Json(name = "Message") var message: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt index adbf734d..a46b19d9 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/CreateImageInfo.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class CreateImageInfo( + @Json(name = "id") var id: kotlin.String? = null, + @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-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt index 7d000652..27dd86a7 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceMapping.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,16 +25,21 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt index f45dddf5..e5ff64a6 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DeviceRequest.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * A request for devices to be sent to device drivers + * * @param driver * @param count * @param deviceIDs @@ -24,16 +34,22 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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.List>? = null, + 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.Map? = null + var options: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt index 12ce9915..6a7df2e4 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/DistributionInspect.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,14 +25,18 @@ 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.List + var platforms: kotlin.collections.MutableList + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt index f51758d5..3a3a74e3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Driver.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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.Map? = null + var options: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt index 7c72d71f..7cd1f4bf 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointIPAMConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,16 +25,21 @@ 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.List? = null + var linkLocalIPs: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt index 22f631eb..c16d7f0d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointPortConfig.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,22 +34,29 @@ import com.squareup.moshi.JsonClass */ @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? = null + var publishMode: EndpointPortConfig.PublishMode? = PublishMode.Ingress + ) { /** + * * * Values: Tcp,Udp,Sctp */ @@ -50,6 +67,7 @@ data class EndpointPortConfig( } /** * 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 */ enum class PublishMode(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt index 1c4f9340..79a749fc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSettings.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * Configuration for a network endpoint. + * * @param ipAMConfig * @param links * @param aliases @@ -32,40 +42,54 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class EndpointSettings( + @Json(name = "IPAMConfig") var ipAMConfig: EndpointIPAMConfig? = null, + @Json(name = "Links") - var links: kotlin.collections.List? = null, + var links: kotlin.collections.MutableList? = null, + @Json(name = "Aliases") - var aliases: kotlin.collections.List? = null, + 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, + /* MAC address for the endpoint on this network. */ @Json(name = "MacAddress") var macAddress: kotlin.String? = 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.Map? = null + var driverOpts: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt index 525a2f3d..67a14236 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EndpointSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,21 +25,26 @@ 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? = null, + 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.List? = null + var ports: kotlin.collections.MutableList? = null + ) { /** * The mode of resolution to use for internal load balancing between tasks. + * * Values: Vip,Dnsrr */ enum class Mode(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt index 7776164a..1f9574da 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescription.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,16 +25,21 @@ 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.Map? = null, + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "Plugins") - var plugins: kotlin.collections.List? = null + var plugins: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPlugins.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPlugins.kt index a57295ec..c055faf8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPlugins.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPlugins.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 EngineDescriptionPlugins( + @Json(name = "Type") var type: kotlin.String? = null, + @Json(name = "Name") var name: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt index 59b5b4aa..f18efb80 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorDetail.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt index e6a2a7f1..7ae430e8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ErrorResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt index 2c31af06..99533f49 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventActor.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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.Map? = null + var attributes: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt index e059213f..93a4ba09 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EventMessage.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -25,27 +35,35 @@ import com.squareup.moshi.JsonClass */ @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 */ enum class Type(val value: kotlin.String) { @@ -63,6 +81,7 @@ data class EventMessage( } /** * Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are `swarm` scope. + * * Values: Local,Swarm */ enum class Scope(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt index 32108e4c..672ec4a4 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecConfig.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -29,34 +39,45 @@ import com.squareup.moshi.JsonClass */ @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, + /* 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.List? = null, + var env: kotlin.collections.MutableList? = null, + /* Command to run, as a string or array of strings. */ @Json(name = "Cmd") - var cmd: kotlin.collections.List? = null, + var cmd: kotlin.collections.MutableList? = null, + /* Runs the exec process with extended privileges. */ @Json(name = "Privileged") - var privileged: kotlin.Boolean? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt index 375cc3af..fc7db5b2 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecInspectResponse.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -30,27 +40,39 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt index 4b96a4eb..56825307 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ExecStartConfig.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. */ @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 + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt index 678df031..af13adc5 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GraphDriverData.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,13 +25,17 @@ import com.squareup.moshi.JsonClass /** * Information about a container's graph driver. + * * @param name - * @param data + * @param `data` */ @JsonClass(generateAdapter = true) data class GraphDriverData( + @Json(name = "Name") var name: kotlin.String, + @Json(name = "Data") - var data: kotlin.collections.Map? + var `data`: kotlin.collections.MutableMap? + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt index 80fd5a85..321be5d1 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Health.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,25 +25,31 @@ 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.List? = null + 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 */ enum class Status(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt index edc21df0..ed1deda6 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -24,19 +34,25 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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.Int? = 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.Int? = 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.Int? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt index bc614378..21a27dcd 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HealthcheckResult.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt index 38b2db52..d948c5b2 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HistoryResponseItem.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,25 +25,33 @@ import com.squareup.moshi.JsonClass /** * individual image layer information in response to ImageHistory operation + * * @param id * @param created * @param createdBy * @param tags - * @param size + * @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.List?, + var tags: kotlin.collections.MutableList?, + @Json(name = "Size") - var size: kotlin.Long, + var propertySize: kotlin.Long, + @Json(name = "Comment") var comment: kotlin.String + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt index 192ff7f1..efb4500f 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -41,7 +51,7 @@ import com.squareup.moshi.JsonClass * @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 `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. @@ -89,218 +99,290 @@ import com.squareup.moshi.JsonClass */ @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? = null, + var memory: kotlin.Long? = 0, + /* 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + var devices: kotlin.collections.MutableList? = null, + /* a list of cgroup rules to apply to the container */ @Json(name = "DeviceCgroupRules") - var deviceCgroupRules: kotlin.collections.List? = null, + 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.List? = null, + var deviceRequests: kotlin.collections.MutableList? = null, + /* Kernel memory limit in bytes.


> **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. */ @Json(name = "KernelMemory") var kernelMemory: kotlin.Long? = null, + /* Hard limit for kernel TCP buffer memory (in bytes). */ @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, + 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.List? = null, + 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.List? = null, + 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.Map>? = null, + 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.List? = null, + var volumesFrom: kotlin.collections.MutableList? = null, + /* Specification for mounts to be added to the container. */ @Json(name = "Mounts") - var mounts: kotlin.collections.List? = null, + var mounts: kotlin.collections.MutableList? = null, + /* A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. */ @Json(name = "CapAdd") - var capAdd: kotlin.collections.List? = null, + 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.List? = null, + 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.List? = null, + var dns: kotlin.collections.MutableList? = null, + /* A list of DNS options. */ @Json(name = "DnsOptions") - var dnsOptions: kotlin.collections.List? = null, + var dnsOptions: kotlin.collections.MutableList? = null, + /* A list of DNS search domains. */ @Json(name = "DnsSearch") - var dnsSearch: kotlin.collections.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + var securityOpt: kotlin.collections.MutableList? = null, + /* Storage driver options for this container, in the form `{\"size\": \"120G\"}`. */ @Json(name = "StorageOpt") - var storageOpt: kotlin.collections.Map? = null, + 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.Map? = null, + 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.Int? = 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.Map? = null, + var sysctls: kotlin.collections.MutableMap? = null, + /* Runtime to use with this container. */ @Json(name = "Runtime") var runtime: kotlin.String? = null, + /* Initial console size, as an `[height, width]` array. (Windows only) */ @Json(name = "ConsoleSize") - var consoleSize: kotlin.collections.List? = null, + var consoleSize: kotlin.collections.MutableList? = 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.List? = null, + 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.List? = null + 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 */ enum class CgroupnsMode(val value: kotlin.String) { @@ -309,6 +391,7 @@ data class HostConfig( } /** * Isolation technology of the container. (Windows only) + * * Values: Default,Process,Hyperv */ enum class Isolation(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOf.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOf.kt index d5337fa7..f5769db3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOf.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOf.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 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 @@ -57,122 +67,162 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class HostConfigAllOf( + /* 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.List? = null, + 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.Map>? = null, + 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.List? = null, + var volumesFrom: kotlin.collections.MutableList? = null, + /* Specification for mounts to be added to the container. */ @Json(name = "Mounts") - var mounts: kotlin.collections.List? = null, + var mounts: kotlin.collections.MutableList? = null, + /* A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. */ @Json(name = "CapAdd") - var capAdd: kotlin.collections.List? = null, + 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.List? = null, + 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: HostConfigAllOf.CgroupnsMode? = null, + /* A list of DNS servers for the container to use. */ @Json(name = "Dns") - var dns: kotlin.collections.List? = null, + var dns: kotlin.collections.MutableList? = null, + /* A list of DNS options. */ @Json(name = "DnsOptions") - var dnsOptions: kotlin.collections.List? = null, + var dnsOptions: kotlin.collections.MutableList? = null, + /* A list of DNS search domains. */ @Json(name = "DnsSearch") - var dnsSearch: kotlin.collections.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + var securityOpt: kotlin.collections.MutableList? = null, + /* Storage driver options for this container, in the form `{\"size\": \"120G\"}`. */ @Json(name = "StorageOpt") - var storageOpt: kotlin.collections.Map? = null, + 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.Map? = null, + 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.Int? = 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.Map? = null, + var sysctls: kotlin.collections.MutableMap? = null, + /* Runtime to use with this container. */ @Json(name = "Runtime") var runtime: kotlin.String? = null, + /* Initial console size, as an `[height, width]` array. (Windows only) */ @Json(name = "ConsoleSize") - var consoleSize: kotlin.collections.List? = null, + var consoleSize: kotlin.collections.MutableList? = null, + /* Isolation technology of the container. (Windows only) */ @Json(name = "Isolation") var isolation: HostConfigAllOf.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.List? = null, + 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.List? = null + 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 */ enum class CgroupnsMode(val value: kotlin.String) { @@ -181,6 +231,7 @@ data class HostConfigAllOf( } /** * Isolation technology of the container. (Windows only) + * * Values: Default,Process,Hyperv */ enum class Isolation(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt index 91b156e5..1b9d587a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/HostConfigAllOfLogConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,18 +25,23 @@ 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.Map? = null + var config: kotlin.collections.MutableMap? = null + ) { /** + * * * Values: JsonMinusFile,Syslog,Journald,Gelf,Fluentd,Awslogs,Splunk,Etwlogs,None */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt index 74c1f126..17ccd450 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAM.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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\": } ``` @@ -22,13 +32,17 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class IPAM( + /* Name of the IPAM driver to use. */ @Json(name = "Driver") - var driver: kotlin.String? = null, + 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.List>? = null, + var config: kotlin.collections.MutableList>? = null, + /* Driver-specific options, specified as a map. */ @Json(name = "Options") - var options: kotlin.collections.Map? = null + var options: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt index c62af918..c9b50686 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IdResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Image.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Image.kt index 68cb7ab5..a6fdf1e3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Image.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Image.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 parent @@ -25,7 +35,7 @@ import com.squareup.moshi.JsonClass * @param author * @param architecture * @param os - * @param size + * @param propertySize * @param virtualSize * @param graphDriver * @param rootFS @@ -38,42 +48,62 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class Image( + @Json(name = "Id") var id: kotlin.String, + @Json(name = "Parent") var parent: kotlin.String, + @Json(name = "Comment") var comment: kotlin.String, + @Json(name = "Created") var created: kotlin.String, + @Json(name = "Container") var container: kotlin.String, + @Json(name = "DockerVersion") var dockerVersion: kotlin.String, + @Json(name = "Author") var author: kotlin.String, + @Json(name = "Architecture") var architecture: kotlin.String, + @Json(name = "Os") var os: kotlin.String, + @Json(name = "Size") - var size: kotlin.Long, + var propertySize: kotlin.Long, + @Json(name = "VirtualSize") var virtualSize: kotlin.Long, + @Json(name = "GraphDriver") var graphDriver: GraphDriverData, + @Json(name = "RootFS") var rootFS: ImageRootFS, + @Json(name = "RepoTags") - var repoTags: kotlin.collections.List? = null, + var repoTags: kotlin.collections.MutableList? = null, + @Json(name = "RepoDigests") - var repoDigests: kotlin.collections.List? = null, + var repoDigests: kotlin.collections.MutableList? = null, + @Json(name = "ContainerConfig") var containerConfig: ContainerConfig? = null, + @Json(name = "Config") var config: ContainerConfig? = null, + @Json(name = "OsVersion") var osVersion: kotlin.String? = null, + @Json(name = "Metadata") var metadata: ImageMetadata? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt index 4bbe82fa..adc7e0c9 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageDeleteResponseItem.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt index 8cae1189..14ea8505 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageID.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,10 +25,13 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageMetadata.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageMetadata.kt index faa92ce0..d60ab232 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageMetadata.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageMetadata.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 lastTagTime */ @JsonClass(generateAdapter = true) data class ImageMetadata( + @Json(name = "LastTagTime") var lastTagTime: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt index b5e860e7..7c967d3a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImagePruneResponse.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageRootFS.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageRootFS.kt index 21608eb5..37d762df 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageRootFS.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageRootFS.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 layers @@ -22,10 +32,14 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class ImageRootFS( + @Json(name = "Type") var type: kotlin.String, + @Json(name = "Layers") - var layers: kotlin.collections.List? = null, + var layers: kotlin.collections.MutableList? = null, + @Json(name = "BaseLayer") var baseLayer: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt index 762f5efe..422e7a85 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSearchResponseItem.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 isOfficial @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class ImageSearchResponseItem( + @Json(name = "description") var description: kotlin.String? = null, + @Json(name = "is_official") var isOfficial: kotlin.Boolean? = null, + @Json(name = "is_automated") var isAutomated: 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt index 8b8c732d..ee9022a0 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageSummary.kt @@ -1,27 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 parentId * @param repoTags * @param repoDigests * @param created - * @param size + * @param propertySize * @param sharedSize * @param virtualSize * @param labels @@ -29,24 +39,35 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class ImageSummary( + @Json(name = "Id") var id: kotlin.String, + @Json(name = "ParentId") var parentId: kotlin.String, + @Json(name = "RepoTags") - var repoTags: kotlin.collections.List?, + var repoTags: kotlin.collections.MutableList?, + @Json(name = "RepoDigests") - var repoDigests: kotlin.collections.List?, + var repoDigests: kotlin.collections.MutableList?, + @Json(name = "Created") var created: kotlin.Int, + @Json(name = "Size") - var size: java.math.BigDecimal, + var propertySize: java.math.BigDecimal, + @Json(name = "SharedSize") var sharedSize: java.math.BigDecimal, + @Json(name = "VirtualSize") var virtualSize: java.math.BigDecimal, + @Json(name = "Labels") - var labels: kotlin.collections.Map?, + var labels: kotlin.collections.MutableMap?, + @Json(name = "Containers") var containers: kotlin.Int + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt index 1de85ee8..97f5a564 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IndexInfo.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/InlineResponse400.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/InlineResponse400.kt index 0696ecad..6cab1234 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/InlineResponse400.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/InlineResponse400.kt @@ -1,29 +1,42 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 errorResponse * @param message The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file). */ @JsonClass(generateAdapter = true) data class InlineResponse400( + @Json(name = "ErrorResponse") var errorResponse: ErrorResponse? = null, + /* The error message. Either \"must specify path parameter\" (path cannot be empty) or \"not a directory\" (path was asserted to be a directory but exists as a file). */ @Json(name = "message") var message: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt index aa2897e7..ab13f9b8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/JoinTokens.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt index bea9693f..eb81507f 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Limit.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,17 +25,22 @@ 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? = null + var pids: kotlin.Long? = 0 + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt index 633d4648..64dbbf77 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/LocalNodeState.kt @@ -1,22 +1,32 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json /** -* Current local status of this node. -* Values: EMPTY,Inactive,Pending,Active,Error,Locked -*/ + * Current local status of this node. + * + * Values: EMPTY,Inactive,Pending,Active,Error,Locked + */ enum class LocalNodeState(val value: kotlin.String) { @@ -39,10 +49,28 @@ enum class LocalNodeState(val value: kotlin.String) { Locked("locked"); /** - This override toString avoids using the enum var name and uses the actual api value instead. - In cases the var name and value are different, the client would send incorrect enums to the server. - **/ - override fun toString(): String { - return value + * 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(): 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt index 926f6411..547cf7b3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ManagerStatus.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,17 +25,22 @@ 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? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt index fc081593..01c5ab2a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Mount.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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). @@ -27,31 +37,41 @@ import com.squareup.moshi.JsonClass */ @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. */ @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. + * * Values: Bind,Volume,Tmpfs,Npipe */ enum class Type(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt index 77371b15..08160323 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountBindOptions.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,21 +25,26 @@ 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. */ @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? = null + var nonRecursive: kotlin.Boolean? = false + ) { /** * A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`. + * * Values: Private,Rprivate,Shared,Rshared,Slave,Rslave */ enum class Propagation(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt index c584fdbf..d54d91ce 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountPoint.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * A mount point inside a container + * * @param type * @param name * @param source @@ -27,20 +37,29 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class MountPoint( + @Json(name = "Type") var type: kotlin.String? = null, + @Json(name = "Name") var name: kotlin.String? = null, + @Json(name = "Source") var source: kotlin.String? = null, + @Json(name = "Destination") var destination: kotlin.String? = null, + @Json(name = "Driver") var driver: kotlin.String? = null, + @Json(name = "Mode") var mode: kotlin.String? = null, + @Json(name = "RW") var RW: kotlin.Boolean? = null, + @Json(name = "Propagation") var propagation: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt index 0745c871..190d4ecb 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountTmpfsOptions.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt index 7ad545b7..1c66c288 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptions.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,18 +25,23 @@ 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? = null, + var noCopy: kotlin.Boolean? = false, + /* User-defined key/value metadata. */ @Json(name = "Labels") - var labels: kotlin.collections.Map? = null, + var labels: kotlin.collections.MutableMap? = null, + @Json(name = "DriverConfig") var driverConfig: MountVolumeOptionsDriverConfig? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt index a67a583b..42a7a2b5 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/MountVolumeOptionsDriverConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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.Map? = null + var options: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt index 20dbf723..91655eba 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Network.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 id @@ -32,30 +42,44 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class Network( + @Json(name = "Name") var name: kotlin.String? = null, + @Json(name = "Id") var id: kotlin.String? = null, + @Json(name = "Created") var created: kotlin.String? = null, + @Json(name = "Scope") var scope: kotlin.String? = null, + @Json(name = "Driver") var driver: kotlin.String? = null, + @Json(name = "EnableIPv6") var enableIPv6: kotlin.Boolean? = null, + @Json(name = "IPAM") var IPAM: IPAM? = null, + @Json(name = "Internal") var `internal`: kotlin.Boolean? = null, + @Json(name = "Attachable") var attachable: kotlin.Boolean? = null, + @Json(name = "Ingress") var ingress: kotlin.Boolean? = null, + @Json(name = "Containers") - var containers: kotlin.collections.Map? = null, + var containers: kotlin.collections.MutableMap? = null, + @Json(name = "Options") - var options: kotlin.collections.Map? = null, + var options: kotlin.collections.MutableMap? = null, + @Json(name = "Labels") - var labels: kotlin.collections.Map? = null + var labels: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt index e8f289bf..e4232dd4 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkAttachmentConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,19 +25,24 @@ 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.List? = null, + var aliases: kotlin.collections.MutableList? = null, + /* Driver attachment options for the network target. */ @Json(name = "DriverOpts") - var driverOpts: kotlin.collections.Map? = null + var driverOpts: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt index f173a94d..c0f8f4b8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkConnectRequest.kt @@ -1,29 +1,42 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt index a055e38b..bdd9147a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkContainer.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt index c6ee2cf6..e4838c1f 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateRequest.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions. @@ -29,33 +39,44 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class NetworkCreateRequest( + /* The network's name. */ @Json(name = "Name") var name: kotlin.String, + /* Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions. */ @Json(name = "CheckDuplicate") var checkDuplicate: kotlin.Boolean? = null, + /* Name of the network driver plugin to use. */ @Json(name = "Driver") - var driver: kotlin.String? = null, + var driver: kotlin.String? = "bridge", + /* 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, + @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.Map? = null, + var options: kotlin.collections.MutableMap? = null, + /* User-defined key/value metadata. */ @Json(name = "Labels") - var labels: kotlin.collections.Map? = null + var labels: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt index 83d3d971..fb8ccc9e 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkCreateResponse.kt @@ -1,29 +1,42 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt index 632dd23c..8ec0ac22 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkDisconnectRequest.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt index f8accc63..8882c632 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkPruneResponse.kt @@ -1,26 +1,38 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null + var networksDeleted: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt index 36e2ab46..e568e361 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkSettings.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * NetworkSettings exposes the network settings in the API + * * @param bridge Name of the network's bridge (for example, `docker0`). * @param sandboxID SandboxID uniquely represents a container's network stack. * @param hairpinMode Indicates if hairpin NAT should be enabled on the virtual interface. @@ -37,58 +47,77 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class NetworkSettings( + /* Name of the network's bridge (for example, `docker0`). */ @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. */ @Json(name = "HairpinMode") var hairpinMode: kotlin.Boolean? = null, + /* IPv6 unicast address using the link-local prefix. */ @Json(name = "LinkLocalIPv6Address") var linkLocalIPv6Address: kotlin.String? = null, + /* Prefix length of the IPv6 unicast address. */ @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.Map>? = null, + var ports: kotlin.collections.MutableMap>? = null, + /* SandboxKey identifies the sandbox */ @Json(name = "SandboxKey") var sandboxKey: kotlin.String? = null, + /* */ @Json(name = "SecondaryIPAddresses") - var secondaryIPAddresses: kotlin.collections.List
? = null, + var secondaryIPAddresses: kotlin.collections.MutableList
? = null, + /* */ @Json(name = "SecondaryIPv6Addresses") - var secondaryIPv6Addresses: kotlin.collections.List
? = null, + 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.Map? = null + var networks: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt index 23ebd7e1..929c735a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NetworkingConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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. */ @JsonClass(generateAdapter = true) data class NetworkingConfig( + /* A mapping of network name to endpoint configuration for that network. */ @Json(name = "EndpointsConfig") - var endpointsConfig: kotlin.collections.Map? = null + var endpointsConfig: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt index 30bd85c6..04a2cc36 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Node.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -27,22 +37,31 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt index 317d020b..e3f1ffd6 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeDescription.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * NodeDescription encapsulates the properties of the Node as reported by the agent. + * * @param hostname * @param platform * @param resources @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt index 128ee665..2dbb8932 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeSpec.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -23,22 +33,28 @@ import com.squareup.moshi.JsonClass */ @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.Map? = null, + 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 */ enum class Role(val value: kotlin.String) { @@ -47,6 +63,7 @@ data class NodeSpec( } /** * Availability of the node. + * * Values: Active,Pause,Drain */ enum class Availability(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt index fd33193c..d2e6628b 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeState.kt @@ -1,22 +1,32 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json /** -* NodeState represents the state of a node. -* Values: Unknown,Down,Ready,Disconnected -*/ + * NodeState represents the state of a node. + * + * Values: Unknown,Down,Ready,Disconnected + */ enum class NodeState(val value: kotlin.String) { @@ -33,10 +43,28 @@ enum class NodeState(val value: kotlin.String) { Disconnected("disconnected"); /** - This override toString avoids using the enum var name and uses the actual api value instead. - In cases the var name and value are different, the client would send incorrect enums to the server. - **/ - override fun toString(): String { - return value + * 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(): 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-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt index 55f39b28..47356297 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/NodeStatus.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,17 +25,22 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt index 6721b576..fcdbc470 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIDescriptor.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,19 +25,24 @@ 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 size The size in bytes of the blob. + * @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 size: kotlin.Long? = null + var propertySize: kotlin.Long? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt index 22430acd..c6295554 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/OCIPlatform.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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`. @@ -24,19 +34,25 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt index 4daf842c..11db96b8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ObjectVersion.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,10 +25,13 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt index c08a2816..97399ff8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PeerNode.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt index 4c430f23..1152e940 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Platform.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt index 4e7f5f0a..0c52bb9d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Plugin.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -25,18 +35,25 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt index 9feafcfe..5dc116a1 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * The config of a plugin. + * * @param description * @param documentation * @param `interface` @@ -35,37 +45,54 @@ import com.squareup.moshi.JsonClass */ @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.List, + 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.List, + var mounts: kotlin.collections.MutableList, + @Json(name = "Env") - var env: kotlin.collections.List, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt index 7b715c45..21bb36ea 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigArgs.kt @@ -1,34 +1,49 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 + * @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.List, + var settable: kotlin.collections.MutableList, + @Json(name = "Value") - var value: kotlin.collections.List + var `value`: kotlin.collections.MutableList + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt index d5ef9f7b..d3b41345 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigInterface.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,23 +25,29 @@ 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.List, + 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 */ enum class ProtocolScheme(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt index 80f9f053..b35ddf8c 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigLinux.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -22,10 +32,14 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class PluginConfigLinux( + @Json(name = "Capabilities") - var capabilities: kotlin.collections.List, + var capabilities: kotlin.collections.MutableList, + @Json(name = "AllowAllDevices") var allowAllDevices: kotlin.Boolean, + @Json(name = "Devices") - var devices: kotlin.collections.List + var devices: kotlin.collections.MutableList + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt index 36cc74b1..e01ca16a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigNetwork.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt index 60094ecb..8519a5e4 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigRootfs.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null + var diffIds: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt index 6d53fdcf..106d1810 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginConfigUser.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt index afb8a4be..e50bee9f 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginDevice.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -23,12 +33,17 @@ import com.squareup.moshi.JsonClass */ @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.List, + var settable: kotlin.collections.MutableList, + @Json(name = "Path") var path: kotlin.String + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt index 788a0760..600097aa 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginEnv.kt @@ -1,34 +1,49 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 + * @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.List, + var settable: kotlin.collections.MutableList, + @Json(name = "Value") - var value: kotlin.String + var `value`: kotlin.String + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt index fb4b26ee..7472c2aa 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginInterfaceType.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -22,10 +32,14 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt index 0f4b7b3e..e4a7f232 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginMount.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -26,18 +36,26 @@ import com.squareup.moshi.JsonClass */ @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.List, + 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.List + var options: kotlin.collections.MutableList + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt index b1c48c67..31637a00 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginPrivilege.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,16 +25,21 @@ import com.squareup.moshi.JsonClass /** * Describes a permission the user has to accept upon installing the plugin. + * * @param name * @param description - * @param value + * @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.List? = null + var `value`: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt index b40c0829..bf0030cd 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginSettings.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * Settings that can be modified by users. + * * @param mounts * @param env * @param args @@ -23,12 +33,17 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class PluginSettings( + @Json(name = "Mounts") - var mounts: kotlin.collections.List, + var mounts: kotlin.collections.MutableList, + @Json(name = "Env") - var env: kotlin.collections.List, + var env: kotlin.collections.MutableList, + @Json(name = "Args") - var args: kotlin.collections.List, + var args: kotlin.collections.MutableList, + @Json(name = "Devices") - var devices: kotlin.collections.List + var devices: kotlin.collections.MutableList + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt index 9b19699b..1ec1383e 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PluginsInfo.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class PluginsInfo( + /* Names of available volume-drivers, and network-driver plugins. */ @Json(name = "Volume") - var volume: kotlin.collections.List? = null, + var volume: kotlin.collections.MutableList? = null, + /* Names of available network-drivers, and network-driver plugins. */ @Json(name = "Network") - var network: kotlin.collections.List? = null, + var network: kotlin.collections.MutableList? = null, + /* Names of available authorization plugins. */ @Json(name = "Authorization") - var authorization: kotlin.collections.List? = null, + var authorization: kotlin.collections.MutableList? = null, + /* Names of available logging-drivers, and logging-driver plugins. */ @Json(name = "Log") - var log: kotlin.collections.List? = null + var log: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt index 03d9e0de..89eacaaa 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Port.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -23,20 +33,26 @@ import com.squareup.moshi.JsonClass */ @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 */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt index 54ae6a5f..a7a7aa21 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PortBinding.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt index 40c49b12..50cadf31 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProcessConfig.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @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.List? = null + var arguments: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt index ee1aa2ae..4844c840 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ProgressDetail.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt index 194b7c48..69e51bfe 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/PushImageInfo.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -23,12 +33,17 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt index 045fbca8..bf832d3b 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Reachability.kt @@ -1,22 +1,32 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json /** -* Reachability represents the reachability of a node. -* Values: Unknown,Unreachable,Reachable -*/ + * Reachability represents the reachability of a node. + * + * Values: Unknown,Unreachable,Reachable + */ enum class Reachability(val value: kotlin.String) { @@ -30,10 +40,28 @@ enum class Reachability(val value: kotlin.String) { Reachable("reachable"); /** - This override toString avoids using the enum var name and uses the actual api value instead. - In cases the var name and value are different, the client would send incorrect enums to the server. - **/ - override fun toString(): String { - return value + * 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(): 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-41/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt index db97e322..9e134202 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/RegistryServiceConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. * @param allowNondistributableArtifactsHostnames List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. * @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. @@ -24,18 +34,24 @@ import com.squareup.moshi.JsonClass */ @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). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. */ @Json(name = "AllowNondistributableArtifactsCIDRs") - var allowNondistributableArtifactsCIDRs: kotlin.collections.List? = null, + var allowNondistributableArtifactsCIDRs: kotlin.collections.MutableList? = null, + /* List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server. > **Warning**: Nondistributable artifacts typically have restrictions > on how and where they can be distributed and shared. Only use this > feature to push artifacts to private registries and ensure that you > are in compliance with any terms that cover redistributing > nondistributable artifacts. */ @Json(name = "AllowNondistributableArtifactsHostnames") - var allowNondistributableArtifactsHostnames: kotlin.collections.List? = null, + 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.List? = null, + var insecureRegistryCIDRs: kotlin.collections.MutableList? = null, + @Json(name = "IndexConfigs") - var indexConfigs: kotlin.collections.Map? = null, + 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.List? = null + var mirrors: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt index 386dec39..ce87395d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourceObject.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,17 +25,22 @@ 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.List? = null + var genericResources: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt index e305969e..b09b4d1d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Resources.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -41,7 +51,7 @@ import com.squareup.moshi.JsonClass * @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 `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. @@ -51,100 +61,133 @@ import com.squareup.moshi.JsonClass */ @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? = null, + var memory: kotlin.Long? = 0, + /* 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + var devices: kotlin.collections.MutableList? = null, + /* a list of cgroup rules to apply to the container */ @Json(name = "DeviceCgroupRules") - var deviceCgroupRules: kotlin.collections.List? = null, + 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.List? = null, + var deviceRequests: kotlin.collections.MutableList? = null, + /* Kernel memory limit in bytes.


> **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. */ @Json(name = "KernelMemory") var kernelMemory: kotlin.Long? = null, + /* Hard limit for kernel TCP buffer memory (in bytes). */ @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, + 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDevice.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDevice.kt index 58944620..f5134096 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDevice.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDevice.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 ResourcesBlkioWeightDevice( + @Json(name = "Path") var path: kotlin.String? = null, + @Json(name = "Weight") var weight: kotlin.Int? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimits.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimits.kt index f39b6c88..c9b2c7ae 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimits.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimits.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -22,13 +32,17 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class ResourcesUlimits( + /* 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-41/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt index 5560abe2..94de26d7 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/RestartPolicy.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,21 +25,26 @@ 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,UnlessMinusStopped,OnMinusFailure */ enum class Name(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt index 6d1afda8..e0aea435 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Runtime.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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. */ @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.List? = null + var runtimeArgs: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt index 9684fae3..c857ebb3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Secret.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt index f0ba8f88..514aa400 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretSpec.kt @@ -1,40 +1,56 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. + * @param `data` Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. 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.Map? = null, + var labels: kotlin.collections.MutableMap? = null, + /* Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5)) data to store as secret. This field is only used to _create_ a secret, and is not returned by other endpoints. */ @Json(name = "Data") - var data: kotlin.String? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt index 6d155a82..e46ad98b 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Service.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -28,22 +38,32 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt index 40e97f81..76874bd8 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateResponse.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 service. * @param warning Optional warning message */ @JsonClass(generateAdapter = true) data class ServiceCreateResponse( + /* The ID of the created service. */ @Json(name = "ID") var ID: kotlin.String? = null, + /* Optional warning message */ @Json(name = "Warning") var warning: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt index 5cae08c5..3ef08f64 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpoint.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -22,10 +32,14 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class ServiceEndpoint( + @Json(name = "Spec") var spec: EndpointSpec? = null, + @Json(name = "Ports") - var ports: kotlin.collections.List? = null, + var ports: kotlin.collections.MutableList? = null, + @Json(name = "VirtualIPs") - var virtualIPs: kotlin.collections.List? = null + var virtualIPs: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPs.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPs.kt index de510003..22b56a80 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPs.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPs.kt @@ -1,28 +1,41 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 ServiceEndpointVirtualIPs( + @Json(name = "NetworkID") var networkID: kotlin.String? = null, + @Json(name = "Addr") var addr: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt index a7df8a63..2606abd1 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceJobStatus.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,14 +25,18 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt index d03ad161..7a8e99dc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceServiceStatus.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,19 +25,24 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt index 382a6532..34ee83b9 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -27,23 +37,32 @@ import com.squareup.moshi.JsonClass */ @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.Map? = null, + 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. */ @Json(name = "Networks") - var networks: kotlin.collections.List? = null, + var networks: kotlin.collections.MutableList? = null, + @Json(name = "EndpointSpec") var endpointSpec: EndpointSpec? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt index ad14cbd4..915571a9 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecMode.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * Scheduling mode for the service. + * * @param replicated * @param global * @param replicatedJob @@ -23,13 +33,18 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt index 7b759615..714997bc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicated.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt index 30ae5c1a..1c10f1b9 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecModeReplicatedJob.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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? = null, + var maxConcurrent: kotlin.Long? = 1, + /* 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-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt index edf943d8..654c20e4 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecRollbackConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -25,28 +35,36 @@ import com.squareup.moshi.JsonClass */ @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 */ enum class FailureAction(val value: kotlin.String) { @@ -55,6 +73,7 @@ data class ServiceSpecRollbackConfig( } /** * 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: StopMinusFirst,StartMinusFirst */ enum class Order(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt index 98a6e825..2b62f178 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceSpecUpdateConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -25,28 +35,36 @@ import com.squareup.moshi.JsonClass */ @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 */ enum class FailureAction(val value: kotlin.String) { @@ -56,6 +74,7 @@ data class ServiceSpecUpdateConfig( } /** * 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: StopMinusFirst,StartMinusFirst */ enum class Order(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt index 45202900..0d7761d3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateResponse.kt @@ -1,26 +1,38 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null + var warnings: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt index 4080e320..ae43d65c 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateStatus.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * The status of a service update. + * * @param state * @param startedAt * @param completedAt @@ -23,17 +33,23 @@ import com.squareup.moshi.JsonClass */ @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 */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt index 39053d3d..7b158b9b 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Swarm.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -30,33 +40,45 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmAllOf.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmAllOf.kt index 785099ec..89e07471 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmAllOf.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmAllOf.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 joinTokens */ @JsonClass(generateAdapter = true) data class SwarmAllOf( + @Json(name = "JoinTokens") var joinTokens: JoinTokens? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt index a72c8776..b4e9de85 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInfo.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -28,27 +38,37 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class SwarmInfo( + /* Unique identifier of for this node in the swarm. */ @Json(name = "NodeID") - var nodeID: kotlin.String? = null, + 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? = null, + var nodeAddr: kotlin.String? = "", + @Json(name = "LocalNodeState") - var localNodeState: LocalNodeState? = null, + var localNodeState: LocalNodeState? = LocalNodeState.EMPTY, + @Json(name = "ControlAvailable") - var controlAvailable: kotlin.Boolean? = null, + var controlAvailable: kotlin.Boolean? = false, + @Json(name = "Error") - var error: kotlin.String? = null, + var error: kotlin.String? = "", + /* List of ID's and addresses of other managers in the swarm. */ @Json(name = "RemoteManagers") - var remoteManagers: kotlin.collections.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt index da9fab98..1ec48ee5 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmInitRequest.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -27,27 +37,36 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt index 2e201d6e..ee047269 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmJoinRequest.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -24,19 +34,25 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt index 2f1d9bb4..dd1a1ac7 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * User modifiable swarm configuration. + * * @param name Name of the swarm. * @param labels User-defined key/value metadata. * @param orchestration @@ -27,22 +37,31 @@ import com.squareup.moshi.JsonClass */ @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.Map? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt index 3d79e892..b7c53705 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -24,19 +34,25 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAs.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAs.kt index cea0fbec..a4e7902c 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAs.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAs.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -23,22 +33,28 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class SwarmSpecCAConfigExternalCAs( + /* Protocol for communication with the external CA (currently only `cfssl` is supported). */ @Json(name = "Protocol") - var protocol: SwarmSpecCAConfigExternalCAs.Protocol? = null, + var protocol: SwarmSpecCAConfigExternalCAs.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.Map? = null, + 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 */ enum class Protocol(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt index af44297c..a0a17cbb 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecDispatcher.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt index 66ae3bb8..cdb28f46 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecEncryptionConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt index a268b45f..ff958764 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecOrchestration.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt index a9df2a05..2279ae34 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecRaft.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -24,19 +34,25 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt index ba5f6cbb..38e641db 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaults.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,10 +25,13 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt index 39c31d0c..033f3ab3 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecTaskDefaultsLogDriver.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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 selectd 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 selectd log driver, specified as key/value pairs. */ @Json(name = "Options") - var options: kotlin.collections.Map? = null + var options: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt index fb0c8b7c..90ab8b23 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmUnlockRequest.kt @@ -1,26 +1,38 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt index b271f45d..89d62514 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemAuthResponse.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt index dbbc51d2..602a092f 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemDataUsageResponse.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class SystemDataUsageResponse( + @Json(name = "LayersSize") var layersSize: kotlin.Long? = null, + @Json(name = "Images") - var images: kotlin.collections.List? = null, + var images: kotlin.collections.MutableList? = null, + @Json(name = "Containers") - var containers: kotlin.collections.List? = null, + var containers: kotlin.collections.MutableList? = null, + @Json(name = "Volumes") - var volumes: kotlin.collections.List? = null, + var volumes: kotlin.collections.MutableList? = null, + @Json(name = "BuildCache") - var buildCache: kotlin.collections.List? = null + var buildCache: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt index 8f2aed1f..8d151398 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfo.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -81,190 +91,254 @@ import com.squareup.moshi.JsonClass */ @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.List>? = null, + 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 limit support enabled.


> **Deprecated**: This field is deprecated as the kernel 5.4 deprecated > `kmem.limit_in_bytes`. */ @Json(name = "KernelMemory") var kernelMemory: 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? = null, + var cgroupDriver: SystemInfo.CgroupDriver? = CgroupDriver.Cgroupfs, + /* The version of the cgroup. */ @Json(name = "CgroupVersion") - var cgroupVersion: SystemInfo.CgroupVersion? = null, + var cgroupVersion: SystemInfo.CgroupVersion? = CgroupVersion._1, + /* 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://golang.org/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://golang.org/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? = null, + 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.List? = null, + 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.List? = null, + 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. > **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) > returns the Swarm version instead of the daemon version, for example > `swarm/1.2.8`. */ @Json(name = "ServerVersion") var serverVersion: kotlin.String? = null, + /* URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism.


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


> **Deprecated**: This field is only propagated when using standalone Swarm > mode, and overlay networking using an external k/v store. Overlay > networks with Swarm mode enabled use the built-in raft store, and > this field will be empty. */ @Json(name = "ClusterAdvertise") var clusterAdvertise: 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.Map? = null, + 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? = null, + 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? = null, + 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? = null, + 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), and rootless. 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.List? = null, + 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.List? = null, + 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.List? = null + var warnings: kotlin.collections.MutableList? = null + ) { /** * The driver to use for managing cgroups. + * * Values: Cgroupfs,Systemd,None */ enum class CgroupDriver(val value: kotlin.String) { @@ -274,6 +348,7 @@ data class SystemInfo( } /** * The version of the cgroup. + * * Values: _1,_2 */ enum class CgroupVersion(val value: kotlin.String) { @@ -282,6 +357,7 @@ data class SystemInfo( } /** * 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 */ enum class Isolation(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPools.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPools.kt index 62a8a760..e1841dc5 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPools.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPools.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 size The network pool size + * @param propertySize The network pool size */ @JsonClass(generateAdapter = true) data class SystemInfoDefaultAddressPools( + /* The network address in CIDR format */ @Json(name = "Base") var base: kotlin.String? = null, + /* The network pool size */ @Json(name = "Size") - var size: kotlin.Int? = null + var propertySize: kotlin.Int? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt index abfd2492..ec4b200e 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersion.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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 @@ -31,39 +41,52 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class SystemVersion( + @Json(name = "Platform") var platform: SystemVersionPlatform? = null, + /* Information about system components */ @Json(name = "Components") - var components: kotlin.collections.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponents.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponents.kt index 70d3250f..b4bdc6ba 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponents.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponents.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -22,13 +32,17 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class SystemVersionComponents( + /* 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-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt index 4c676ffb..08e9a994 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionPlatform.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt index a2198a08..c654c241 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TLSInfo.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,19 +25,24 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt index 289ab0d9..b3798d98 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Task.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -33,38 +43,53 @@ import com.squareup.moshi.JsonClass */ @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.Map? = null, + 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt index d2544a09..229de3dc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * User modifiable task configuration. + * * @param pluginSpec * @param containerSpec * @param networkAttachmentSpec @@ -29,27 +39,38 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + var networks: kotlin.collections.MutableList? = null, + @Json(name = "LogDriver") var logDriver: TaskSpecLogDriver? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt index 0e57465c..73fcd608 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -38,7 +48,7 @@ import com.squareup.moshi.JsonClass * @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 `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. @@ -46,88 +56,117 @@ import com.squareup.moshi.JsonClass */ @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.Map? = null, + var labels: kotlin.collections.MutableMap? = null, + /* The command to be run in the image. */ @Json(name = "Command") - var command: kotlin.collections.List? = null, + var command: kotlin.collections.MutableList? = null, + /* Arguments to the command. */ @Json(name = "Args") - var args: kotlin.collections.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null, + 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, + 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.Map? = null, + 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.List? = null, + 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.List? = null, + 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.List? = null + var ulimits: kotlin.collections.MutableList? = null + ) { /** * Isolation technology of the containers running the service. (Windows only) + * * Values: Default,Process,Hyperv */ enum class Isolation(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigs.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigs.kt index 572bb7e4..7ac3c91a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigs.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigs.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 @@ -23,15 +33,20 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class TaskSpecContainerSpecConfigs( + @Json(name = "File") var file: TaskSpecContainerSpecFile1? = 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt index f44889a4..5ffe5d30 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecDNSConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,19 +25,24 @@ 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.List? = null, + var nameservers: kotlin.collections.MutableList? = null, + /* A search list for host-name lookup. */ @Json(name = "Search") - var search: kotlin.collections.List? = null, + 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.List? = null + var options: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile.kt index 5a2c4838..47477190 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class TaskSpecContainerSpecFile( + /* 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile1.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile1.kt index 2cc3b655..96a1d71e 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile1.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile1.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class TaskSpecContainerSpecFile1( + /* 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt index 29da78bf..10be2076 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivileges.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,13 +25,17 @@ import com.squareup.moshi.JsonClass /** * Security options for the container + * * @param credentialSpec * @param seLinuxContext */ @JsonClass(generateAdapter = true) data class TaskSpecContainerSpecPrivileges( + @Json(name = "CredentialSpec") var credentialSpec: TaskSpecContainerSpecPrivilegesCredentialSpec? = null, + @Json(name = "SELinuxContext") var seLinuxContext: TaskSpecContainerSpecPrivilegesSELinuxContext? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt index 36b36d37..650df1ee 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesCredentialSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,19 +25,24 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt index 7e20186a..d24fc4cc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecPrivilegesSELinuxContext.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ import com.squareup.moshi.JsonClass /** * SELinux labels of the container + * * @param disable Disable SELinux * @param user SELinux user label * @param role SELinux role label @@ -24,19 +34,25 @@ import com.squareup.moshi.JsonClass */ @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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecrets.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecrets.kt index 33a4fcf6..bb23dafa 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecrets.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecrets.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -22,12 +32,16 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class TaskSpecContainerSpecSecrets( + @Json(name = "File") var file: TaskSpecContainerSpecFile? = 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt index e74a5b94..a587b9c9 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecLogDriver.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,13 +25,17 @@ 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.Map? = null + var options: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt index 394c1f26..d486b3be 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecNetworkAttachmentSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,11 +25,14 @@ 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt index f34bbee9..a2f400a7 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacement.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @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.List? = null, + 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.List? = null, + 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? = null, + var maxReplicas: kotlin.Long? = 0, + /* 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.List? = null + var platforms: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferences.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferences.kt index f17f4f74..79382dc2 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferences.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferences.kt @@ -1,25 +1,37 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 TaskSpecPlacementPreferences( + @Json(name = "Spread") var spread: TaskSpecPlacementSpread? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementSpread.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementSpread.kt index 111c0d6f..88a6dcc7 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementSpread.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementSpread.kt @@ -1,26 +1,38 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 TaskSpecPlacementSpread( + /* label descriptor, such as `engine.labels.az`. */ @Json(name = "SpreadDescriptor") var spreadDescriptor: kotlin.String? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt index dc66bd71..5d9e2d32 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPluginSpec.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -23,15 +33,20 @@ import com.squareup.moshi.JsonClass */ @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.List? = null + var pluginPrivilege: kotlin.collections.MutableList? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt index 19bafcc6..af90bafd 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecResources.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,13 +25,17 @@ import com.squareup.moshi.JsonClass /** * Resource requirements which apply to each individual container created as part of the service. + * * @param limits * @param reservation */ @JsonClass(generateAdapter = true) data class TaskSpecResources( + @Json(name = "Limits") var limits: Limit? = null, + @Json(name = "Reservation") var reservation: ResourceObject? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt index bfa4b19d..2bc8856d 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecRestartPolicy.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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). @@ -23,22 +33,28 @@ import com.squareup.moshi.JsonClass */ @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? = null, + var maxAttempts: kotlin.Long? = 0, + /* 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? = null + var window: kotlin.Long? = 0 + ) { /** * Condition for restart. + * * Values: None,OnMinusFailure,Any */ enum class Condition(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt index 534ad09a..fa082189 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskState.kt @@ -1,22 +1,32 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json /** -* -* Values: New,Allocated,Pending,Assigned,Accepted,Preparing,Ready,Starting,Running,Complete,Shutdown,Failed,Rejected,Remove,Orphaned -*/ + * + * + * Values: New,Allocated,Pending,Assigned,Accepted,Preparing,Ready,Starting,Running,Complete,Shutdown,Failed,Rejected,Remove,Orphaned + */ enum class TaskState(val value: kotlin.String) { @@ -66,10 +76,28 @@ enum class TaskState(val value: kotlin.String) { Orphaned("orphaned"); /** - This override toString avoids using the enum var name and uses the actual api value instead. - In cases the var name and value are different, the client would send incorrect enums to the server. - **/ - override fun toString(): String { - return value + * 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(): 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-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt index 05ea620c..ef2dd432 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatus.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 timestamp * @param state @@ -24,14 +34,20 @@ import com.squareup.moshi.JsonClass */ @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: TaskStatusContainerStatus? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatusContainerStatus.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatusContainerStatus.kt index 58e50bc3..402aa2e6 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatusContainerStatus.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskStatusContainerStatus.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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 containerID * @param PID @@ -22,10 +32,14 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class TaskStatusContainerStatus( + @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-41/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt index 325e8b89..5501eb28 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ThrottleDevice.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt index c18bc69a..c3d3916c 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/UnlockKeyResponse.kt @@ -1,26 +1,38 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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-41/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt index 3cd46271..0b449cad 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Volume.kt @@ -1,20 +1,30 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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. @@ -28,36 +38,47 @@ import com.squareup.moshi.JsonClass */ @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, + /* User-defined key/value metadata. */ @Json(name = "Labels") - var labels: kotlin.collections.Map?, + var labels: kotlin.collections.MutableMap?, + /* The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. */ @Json(name = "Scope") - var scope: Volume.Scope?, + var scope: Volume.Scope? = Scope.Local, + /* The driver specific options used when creating the volume. */ @Json(name = "Options") - var options: kotlin.collections.Map?, + 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.Map? = null, + var status: kotlin.collections.MutableMap? = 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 */ enum class Scope(val value: kotlin.String) { diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeConfig.kt index c83c32c8..0c84b4e0 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeConfig.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,6 +25,7 @@ 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. @@ -23,16 +33,21 @@ import com.squareup.moshi.JsonClass */ @JsonClass(generateAdapter = true) data class VolumeConfig( + /* 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? = null, + 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.Map? = null, + var driverOpts: kotlin.collections.MutableMap? = null, + /* User-defined key/value metadata. */ @Json(name = "Labels") - var labels: kotlin.collections.Map? = null + var labels: kotlin.collections.MutableMap? = null + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt index 24831ea0..f3210247 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeListResponse.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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.List, + var volumes: kotlin.collections.MutableList, + /* Warnings that occurred when fetching the list of volumes. */ @Json(name = "Warnings") - var warnings: kotlin.collections.List? + var warnings: kotlin.collections.MutableList? + ) diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt index a61eecdd..6257ec26 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumePruneResponse.kt @@ -1,30 +1,43 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this 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.List? = null, + 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-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt index 3d7e409f..9961d36e 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeUsageData.kt @@ -1,14 +1,23 @@ /** -* Docker Engine API -* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` -* -* The version of the OpenAPI document: 1.41 -* -* -* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -* https://openapi-generator.tech -* Do not edit the class manually. -*/ + * Docker Engine API + * + * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ``` + * + * The version of the OpenAPI document: 1.41 + * + * + * Please note: + * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * Do not edit this file manually. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + package de.gesellix.docker.remote.api import com.squareup.moshi.Json @@ -16,15 +25,19 @@ 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 size 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 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 size: kotlin.Int, + var propertySize: kotlin.Int, + /* 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.Int + ) diff --git a/build.gradle.kts b/build.gradle.kts index 0d6276a6..f299c2a2 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -11,7 +11,7 @@ plugins { id("io.github.gradle-nexus.publish-plugin") version "1.1.0" id("org.jetbrains.kotlin.jvm") version "1.6.10" apply false id("com.google.devtools.ksp") version("1.6.10-1.0.2") apply false - id("org.openapi.generator") version "5.2.0" apply false + id("org.openapi.generator") version "5.4.0" apply false id("org.jlleitschuh.gradle.ktlint") version "10.2.1" apply false }