diff --git a/api-model-v1-41/.openapi-generator/VERSION b/api-model-v1-41/.openapi-generator/VERSION index 4ac4fded..0df17dd0 100644 --- a/api-model-v1-41/.openapi-generator/VERSION +++ b/api-model-v1-41/.openapi-generator/VERSION @@ -1 +1 @@ -6.2.0 \ No newline at end of file +6.2.1 \ No newline at end of file diff --git a/api-model-v1-41/README.md b/api-model-v1-41/README.md index 35990b19..598e9bfd 100644 --- a/api-model-v1-41/README.md +++ b/api-model-v1-41/README.md @@ -1,9 +1,89 @@ # de.gesellix.docker.remote.api - Kotlin client library for Docker Engine API +The Engine API is an HTTP API served by Docker Engine. It is the API the +Docker client uses to communicate with the Engine, so everything the Docker +client can do can be done with the API. + +Most of the client's commands map directly to API endpoints (e.g. `docker ps` +is `GET /containers/json`). The notable exception is running containers, +which consists of several API calls. + +# Errors + +The API uses standard HTTP status codes to indicate the success or failure +of the API call. The body of the response will be JSON in the following +format: + +``` +{ + \"message\": \"page not found\" +} +``` + +# Versioning + +The API is usually changed in each release, so API calls are versioned to +ensure that clients don't break. To lock to a specific version of the API, +you prefix the URL with its version, for example, call `/v1.30/info` to use +the v1.30 version of the `/info` endpoint. If the API version specified in +the URL is not supported by the daemon, a HTTP `400 Bad Request` error message +is returned. + +If you omit the version-prefix, the current version of the API (v1.41) is used. +For example, calling `/info` is the same as calling `/v1.41/info`. Using the +API without a version-prefix is deprecated and will be removed in a future release. + +Engine releases in the near future should support this version of the API, +so your client will continue to work even if it is talking to a newer Engine. + +The API uses an open schema model, which means server may add extra properties +to responses. Likewise, the server will ignore any extra query parameters and +request body properties. When you write clients, you need to ignore additional +properties in responses to ensure they do not break when talking to newer +daemons. + + +# Authentication + +Authentication for registries is handled client side. The client has to send +authentication details to various endpoints that need to communicate with +registries, such as `POST /images/(name)/push`. These are sent as +`X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) +(JSON) string with the following structure: + +``` +{ + \"username\": \"string\", + \"password\": \"string\", + \"email\": \"string\", + \"serveraddress\": \"string\" +} +``` + +The `serveraddress` is a domain/IP without a protocol. Throughout this +structure, double quotes are required. + +If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), +you can just pass this instead of credentials: + +``` +{ + \"identitytoken\": \"9cbaf023786cd7...\" +} +``` + + +## Overview +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client. + +- API version: 1.41 +- Package version: +- Build package: org.openapitools.codegen.languages.KotlinClientCodegen + ## Requires -* Kotlin 1.4.30 -* Gradle 6.8.3 +* Kotlin 1.6.10 +* Gradle 7.5 ## Build 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 1d83fce8..e6f76056 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param prefixLen Mask length of the IP address. */ @JsonClass(generateAdapter = true) + data class Address( /* IP address. */ 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 cf027ee6..03494bf2 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param serveraddress */ @JsonClass(generateAdapter = true) + data class AuthConfig( @Json(name = "username") 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 154fd8fd..64ab206e 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass * @param usageCount */ @JsonClass(generateAdapter = true) + data class BuildCache( @Json(name = "ID") 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 3a527028..a4cfe450 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param aux */ @JsonClass(generateAdapter = true) + data class BuildInfo( @Json(name = "id") 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 878378bc..f1c45a7a 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param spaceReclaimed Disk space reclaimed in bytes */ @JsonClass(generateAdapter = true) + data class BuildPruneResponse( @Json(name = "CachesDeleted") 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 db511c4d..5eb93880 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass * @param subnetSize SubnetSize specifies the subnet size of the networks created from the default subnet pool. */ @JsonClass(generateAdapter = true) + data class ClusterInfo( /* The ID of the swarm. */ 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 4a74d4ff..d9d6da17 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 5fc50ddc..2deedfa0 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param spec */ @JsonClass(generateAdapter = true) + data class Config( @Json(name = "ID") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt index 3a5cdd7a..83ebd456 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ConfigCreateRequest.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param templating */ @JsonClass(generateAdapter = true) + data class ConfigCreateRequest( /* User-defined name of the config. */ 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 e8a813fd..b26d2e6d 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param templating */ @JsonClass(generateAdapter = true) + data class ConfigSpec( /* User-defined name of the config. */ 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 398f53f8..d687495f 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param kind Kind of change */ @JsonClass(generateAdapter = true) + data class ContainerChangeResponseItem( /* Path to file that has changed */ 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 0e405887..934cf05d 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -53,6 +48,7 @@ import com.squareup.moshi.JsonClass * @param shell Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell. */ @JsonClass(generateAdapter = true) + data class ContainerConfig( /* The hostname to use for the container, as a valid RFC 1123 hostname. */ 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 37675794..9ea6c63f 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -55,6 +50,7 @@ import com.squareup.moshi.JsonClass * @param networkingConfig */ @JsonClass(generateAdapter = true) + data class ContainerCreateRequest( /* The hostname to use for the container, as a valid RFC 1123 hostname. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequestAllOf.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequestAllOf.kt index 1c445a94..e5546551 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequestAllOf.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerCreateRequestAllOf.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param networkingConfig */ @JsonClass(generateAdapter = true) + data class ContainerCreateRequestAllOf( @Json(name = "HostConfig") 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 2015c940..7ddcff26 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param warnings Warnings encountered when creating the container */ @JsonClass(generateAdapter = true) + data class ContainerCreateResponse( /* The ID of the created container */ 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 e10cb8aa..ad0af44f 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -53,6 +48,7 @@ import com.squareup.moshi.JsonClass * @param networkSettings */ @JsonClass(generateAdapter = true) + data class ContainerInspectResponse( /* The ID of the container */ 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 aa623454..6218b666 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param spaceReclaimed Disk space reclaimed in bytes */ @JsonClass(generateAdapter = true) + data class ContainerPruneResponse( /* Container IDs that were deleted */ 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 d7640419..20704901 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -40,6 +35,7 @@ import com.squareup.moshi.JsonClass * @param health */ @JsonClass(generateAdapter = true) + data class ContainerState( /* String representation of the container state. Can be one of \"created\", \"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\". */ 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 108a9231..fc1c8f8e 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -43,6 +38,7 @@ import com.squareup.moshi.JsonClass * @param mounts */ @JsonClass(generateAdapter = true) + data class ContainerSummary( /* The ID of this container */ 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 c2335173..08e1b0a5 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param networkMode */ @JsonClass(generateAdapter = true) + data class ContainerSummaryHostConfig( @Json(name = "NetworkMode") 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 dbc880cc..42c09dfe 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param networks */ @JsonClass(generateAdapter = true) + data class ContainerSummaryNetworkSettings( @Json(name = "Networks") 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 ff0e4947..f512ba5b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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 */ 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 c11db051..829242d9 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -60,6 +55,7 @@ import com.squareup.moshi.JsonClass * @param restartPolicy */ @JsonClass(generateAdapter = true) + data class ContainerUpdateRequest( /* An integer value representing this container's relative CPU weight versus other containers. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequestAllOf.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequestAllOf.kt index 967fa4c7..82220998 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequestAllOf.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerUpdateRequestAllOf.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param restartPolicy */ @JsonClass(generateAdapter = true) + data class ContainerUpdateRequestAllOf( @Json(name = "RestartPolicy") 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 3781146d..4cf0afd9 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param warnings */ @JsonClass(generateAdapter = true) + data class ContainerUpdateResponse( @Json(name = "Warnings") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt index 45de9088..ddd78b39 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ContainerWaitExitError.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param message Details of an error */ @JsonClass(generateAdapter = true) + data class ContainerWaitExitError( /* Details of an error */ 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 46e38462..fca45a45 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param error */ @JsonClass(generateAdapter = true) + data class ContainerWaitResponse( /* Exit code of the container */ 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 a46b19d9..b41712cb 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param progressDetail */ @JsonClass(generateAdapter = true) + data class CreateImageInfo( @Json(name = "id") 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 27dd86a7..2b50ba48 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param cgroupPermissions */ @JsonClass(generateAdapter = true) + data class DeviceMapping( @Json(name = "PathOnHost") 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 e5ff64a6..d12be6df 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param options Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. */ @JsonClass(generateAdapter = true) + data class DeviceRequest( @Json(name = "Driver") 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 6a7df2e4..9d1bc196 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param platforms An array containing all platforms supported by the image. */ @JsonClass(generateAdapter = true) + data class DistributionInspect( @Json(name = "Descriptor") 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 3a3a74e3..7d8b952b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param options Key/value map of driver-specific options. */ @JsonClass(generateAdapter = true) + data class Driver( /* Name of the driver. */ 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 7cd1f4bf..b83485e8 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param linkLocalIPs */ @JsonClass(generateAdapter = true) + data class EndpointIPAMConfig( @Json(name = "IPv4Address") 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 c16d7f0d..3345fb52 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param publishMode The mode in which port is published.


- \"ingress\" makes the target port accessible on every node, regardless of whether there is a task for the service running on that node or not. - \"host\" bypasses the routing mesh and publish the port directly on the swarm node where that service is running. */ @JsonClass(generateAdapter = true) + data class EndpointPortConfig( @Json(name = "Name") 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 79a749fc..618f38cd 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -41,6 +36,7 @@ import com.squareup.moshi.JsonClass * @param driverOpts DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. */ @JsonClass(generateAdapter = true) + data class EndpointSettings( @Json(name = "IPAMConfig") 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 67a14236..ee34754d 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 1d08d4f4..15e222d7 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param plugins */ @JsonClass(generateAdapter = true) + data class EngineDescription( @Json(name = "EngineVersion") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt index 9933e6c8..08a2f866 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/EngineDescriptionPluginsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param name */ @JsonClass(generateAdapter = true) + data class EngineDescriptionPluginsInner( @Json(name = "Type") 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 f18efb80..edc75876 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param message */ @JsonClass(generateAdapter = true) + data class ErrorDetail( @Json(name = "code") 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 7ae430e8..74c8ee40 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param message The error message. */ @JsonClass(generateAdapter = true) + data class ErrorResponse( /* The error message. */ 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 99533f49..f56788cd 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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 */ 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 93a4ba09..e4626c5e 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -34,6 +29,7 @@ import com.squareup.moshi.JsonClass * @param timeNano Timestamp of event, with nanosecond accuracy */ @JsonClass(generateAdapter = true) + data class EventMessage( /* The type of object emitting the event */ 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 672ec4a4..6d666298 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass * @param workingDir The working directory for the exec process inside the container. */ @JsonClass(generateAdapter = true) + data class ExecConfig( /* Attach to `stdin` of the exec command. */ 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 fc7db5b2..de98d91e 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -39,6 +34,7 @@ import com.squareup.moshi.JsonClass * @param pid The system process ID for the exec process. */ @JsonClass(generateAdapter = true) + data class ExecInspectResponse( @Json(name = "CanRemove") 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 56825307..96694b7d 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param tty Allocate a pseudo-TTY. */ @JsonClass(generateAdapter = true) + data class ExecStartConfig( /* Detach from the command. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt index 4aa49c82..0e7961a1 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param discreteResourceSpec */ @JsonClass(generateAdapter = true) + data class GenericResourcesInner( @Json(name = "NamedResourceSpec") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt index d6b50925..6ff1d602 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerDiscreteResourceSpec.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param `value` */ @JsonClass(generateAdapter = true) + data class GenericResourcesInnerDiscreteResourceSpec( @Json(name = "Kind") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt index fc3095fd..34162153 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/GenericResourcesInnerNamedResourceSpec.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param `value` */ @JsonClass(generateAdapter = true) + data class GenericResourcesInnerNamedResourceSpec( @Json(name = "Kind") 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 94feb4b3..861a3312 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param `data` Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. */ @JsonClass(generateAdapter = true) + data class GraphDriverData( /* Name of the storage driver. */ 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 321be5d1..6a8835ca 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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 */ 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 5f5de9c8..532c4613 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param startPeriod Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. */ @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 */ 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 21a27dcd..9e1ca0ee 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param output Output from last check */ @JsonClass(generateAdapter = true) + data class HealthcheckResult( /* Date and time at which this check started in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. */ 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 d948c5b2..c2379bd2 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -34,6 +29,7 @@ import com.squareup.moshi.JsonClass * @param comment */ @JsonClass(generateAdapter = true) + data class HistoryResponseItem( @Json(name = "Id") 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 3d98089a..b482a24d 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -97,6 +92,7 @@ import com.squareup.moshi.JsonClass * @param readonlyPaths The list of paths to be set as read-only inside the container (this overrides the default set of paths). */ @JsonClass(generateAdapter = true) + data class HostConfig( /* An integer value representing this container's relative CPU weight versus other containers. */ 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 6e096c4e..e21ba340 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -66,6 +61,7 @@ import com.squareup.moshi.JsonClass * @param readonlyPaths The list of paths to be set as read-only inside the container (this overrides the default set of paths). */ @JsonClass(generateAdapter = true) + data class 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`. */ 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 1b9d587a..d687de2c 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param config */ @JsonClass(generateAdapter = true) + data class HostConfigAllOfLogConfig( @Json(name = "Type") 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 aedc19af..602efba8 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param options Driver-specific options, specified as a map. */ @JsonClass(generateAdapter = true) + data class IPAM( /* Name of the IPAM driver to use. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt index bf3fd927..596a19c2 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/IPAMConfig.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param auxiliaryAddresses */ @JsonClass(generateAdapter = true) + data class IPAMConfig( @Json(name = "Subnet") 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 c9b50686..e886cd7b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param id The id of the newly created object. */ @JsonClass(generateAdapter = true) + data class IdResponse( /* The id of the newly created object. */ 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 adc7e0c9..8af3b1de 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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 */ 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 14ea8505..bbd2eb4d 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param ID */ @JsonClass(generateAdapter = true) + data class ImageID( @Json(name = "ID") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt index c41b4374..1983d516 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspect.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -48,6 +43,7 @@ import com.squareup.moshi.JsonClass * @param metadata */ @JsonClass(generateAdapter = true) + data class ImageInspect( /* ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt index dfee1c28..6d95c8cd 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectMetadata.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param lastTagTime Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. */ @JsonClass(generateAdapter = true) + data class ImageInspectMetadata( /* Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt index 1cb6593e..71f11b9c 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ImageInspectRootFS.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param baseLayer */ @JsonClass(generateAdapter = true) + data class ImageInspectRootFS( @Json(name = "Type") 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 7c967d3a..172d3c09 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param spaceReclaimed Disk space reclaimed in bytes */ @JsonClass(generateAdapter = true) + data class ImagePruneResponse( /* Images that were deleted */ 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 422e7a85..18744ef4 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param starCount */ @JsonClass(generateAdapter = true) + data class ImageSearchResponseItem( @Json(name = "description") 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 aad62ad2..f055f735 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass * @param labels User-defined key/value metadata. */ @JsonClass(generateAdapter = true) + data class ImageSummary( /* ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the `RepoDigests` below, which holds digests of image manifests that reference the image. */ 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 97f5a564..d47b7f0e 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param official Indicates whether this is an official registry (i.e., Docker Hub / docker.io) */ @JsonClass(generateAdapter = true) + data class IndexInfo( /* Name of the registry, such as \"docker.io\". */ 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 ab13f9b8..48bb27b1 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 b8e40005..0c40e0cc 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param pids Limits the maximum number of PIDs in the container. Set `0` for unlimited. */ @JsonClass(generateAdapter = true) + data class Limit( @Json(name = "NanoCPUs") 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 64dbbf77..56605f87 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( 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 547cf7b3..03eb4aa9 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param addr The IP address and port at which the manager is reachable. */ @JsonClass(generateAdapter = true) + data class ManagerStatus( @Json(name = "Leader") 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 01c5ab2a..aee66a70 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param tmpfsOptions */ @JsonClass(generateAdapter = true) + data class Mount( /* Container path. */ 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 08160323..0df4c0ad 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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`. */ 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 bd13e252..7176e3cd 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param propagation Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt) for details. This field is not used on Windows. */ @JsonClass(generateAdapter = true) + data class MountPoint( /* The mount type: - `bind` a mount of a file or directory from the host into the container. - `volume` a docker volume with the given `Name`. - `tmpfs` a `tmpfs`. - `npipe` a named pipe from the host into the container. */ 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 190d4ecb..fa642b63 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 1c66c288..f532660c 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param driverConfig */ @JsonClass(generateAdapter = true) + data class MountVolumeOptions( /* Populate volume with data from the target. */ 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 42a7a2b5..81d605e9 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 91655eba..d372d475 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -41,6 +36,7 @@ import com.squareup.moshi.JsonClass * @param labels */ @JsonClass(generateAdapter = true) + data class Network( @Json(name = "Name") 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 e4232dd4..866bb121 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 c0f8f4b8..f9f42537 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param endpointConfig */ @JsonClass(generateAdapter = true) + data class NetworkConnectRequest( /* The ID or name of the container to connect to the network. */ 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 bdd9147a..4b8951c2 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param ipv6Address */ @JsonClass(generateAdapter = true) + data class NetworkContainer( @Json(name = "Name") 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 e4838c1f..1b5383fe 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass * @param labels User-defined key/value metadata. */ @JsonClass(generateAdapter = true) + data class NetworkCreateRequest( /* The network's name. */ 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 fb8ccc9e..4718cbb8 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param warning */ @JsonClass(generateAdapter = true) + data class NetworkCreateResponse( /* The ID of the created network. */ 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 8ec0ac22..e8d2b21b 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 8882c632..c247486f 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param networksDeleted Networks that were deleted */ @JsonClass(generateAdapter = true) + data class NetworkPruneResponse( /* Networks that were deleted */ 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 e568e361..9228b36b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -46,6 +41,7 @@ import com.squareup.moshi.JsonClass * @param networks Information about all networks that the container is connected to. */ @JsonClass(generateAdapter = true) + data class NetworkSettings( /* Name of the network's bridge (for example, `docker0`). */ 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 929c735a..33e9f9d8 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 04a2cc36..428db96e 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param managerStatus */ @JsonClass(generateAdapter = true) + data class Node( @Json(name = "ID") 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 e3f1ffd6..c408dd41 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param tlSInfo */ @JsonClass(generateAdapter = true) + data class NodeDescription( @Json(name = "Hostname") 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 2dbb8932..ad9f7c01 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param availability Availability of the node. */ @JsonClass(generateAdapter = true) + data class NodeSpec( /* Name for the node. */ 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 d2e6628b..db051cee 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( 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 47356297..e7fd57df 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param addr IP address of the node. */ @JsonClass(generateAdapter = true) + data class NodeStatus( @Json(name = "State") 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 fcdbc470..cefa85e4 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 c6295554..702ae731 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param variant Optional field specifying a variant of the CPU, for example `v7` to specify ARMv7 when architecture is `arm`. */ @JsonClass(generateAdapter = true) + data class OCIPlatform( /* The CPU architecture, for example `amd64` or `ppc64`. */ 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 11db96b8..1c875fb4 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param index */ @JsonClass(generateAdapter = true) + data class ObjectVersion( @Json(name = "Index") 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 97399ff8..bc7534d6 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 1152e940..e9234259 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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`). */ 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 0c52bb9d..fca18324 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -34,6 +29,7 @@ import com.squareup.moshi.JsonClass * @param pluginReference plugin remote reference used to push/pull the plugin */ @JsonClass(generateAdapter = true) + data class Plugin( @Json(name = "Name") 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 5dc116a1..b3bf5cd0 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -44,6 +39,7 @@ import com.squareup.moshi.JsonClass * @param rootfs */ @JsonClass(generateAdapter = true) + data class PluginConfig( @Json(name = "Description") 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 21bb36ea..2ff13afc 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param `value` */ @JsonClass(generateAdapter = true) + data class PluginConfigArgs( @Json(name = "Name") 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 d3b41345..79932b9b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param protocolScheme Protocol to use for clients connecting to the plugin. */ @JsonClass(generateAdapter = true) + data class PluginConfigInterface( @Json(name = "Types") 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 b35ddf8c..4b980153 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param devices */ @JsonClass(generateAdapter = true) + data class PluginConfigLinux( @Json(name = "Capabilities") 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 e01ca16a..8d37629b 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param type */ @JsonClass(generateAdapter = true) + data class PluginConfigNetwork( @Json(name = "Type") 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 8519a5e4..dbe7f55c 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param diffIds */ @JsonClass(generateAdapter = true) + data class PluginConfigRootfs( @Json(name = "type") 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 106d1810..94a1a235 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param GID */ @JsonClass(generateAdapter = true) + data class PluginConfigUser( @Json(name = "UID") 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 e50bee9f..8941aa0b 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param path */ @JsonClass(generateAdapter = true) + data class PluginDevice( @Json(name = "Name") 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 600097aa..923347cf 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param `value` */ @JsonClass(generateAdapter = true) + data class PluginEnv( @Json(name = "Name") 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 7472c2aa..28fe0884 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param version */ @JsonClass(generateAdapter = true) + data class PluginInterfaceType( @Json(name = "Prefix") 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 e4a7f232..934f68fa 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -35,6 +30,7 @@ import com.squareup.moshi.JsonClass * @param options */ @JsonClass(generateAdapter = true) + data class PluginMount( @Json(name = "Name") 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 31637a00..752a58b0 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param `value` */ @JsonClass(generateAdapter = true) + data class PluginPrivilege( @Json(name = "Name") 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 bf0030cd..8031c4c6 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param devices */ @JsonClass(generateAdapter = true) + data class PluginSettings( @Json(name = "Mounts") 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 1ec1383e..7830bee1 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param log Names of available logging-drivers, and logging-driver plugins. */ @JsonClass(generateAdapter = true) + data class PluginsInfo( /* Names of available volume-drivers, and network-driver plugins. */ 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 89eacaaa..6fd4f613 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param publicPort Port exposed on the host */ @JsonClass(generateAdapter = true) + data class Port( /* Port on the container */ 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 a7a7aa21..a8249bb8 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 50cadf31..753f0b29 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param arguments */ @JsonClass(generateAdapter = true) + data class ProcessConfig( @Json(name = "privileged") 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 4844c840..2aaf01b4 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param total */ @JsonClass(generateAdapter = true) + data class ProgressDetail( @Json(name = "current") 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 69e51bfe..14355f52 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param progressDetail */ @JsonClass(generateAdapter = true) + data class PushImageInfo( @Json(name = "error") 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 bf832d3b..42482a30 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( 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 9e134202..4c728efc 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param mirrors List of registry URLs that act as a mirror for the official (`docker.io`) registry. */ @JsonClass(generateAdapter = true) + data class RegistryServiceConfig( /* List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). 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. */ 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 57060a19..f6a20403 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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") 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 e1851d2c..c6a11a19 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -59,6 +54,7 @@ import com.squareup.moshi.JsonClass * @param ioMaximumBandwidth Maximum IO in bytes per second for the container system drive (Windows only). */ @JsonClass(generateAdapter = true) + data class Resources( /* An integer value representing this container's relative CPU weight versus other containers. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt index f139ea7c..b9405ef4 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesBlkioWeightDeviceInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param weight */ @JsonClass(generateAdapter = true) + data class ResourcesBlkioWeightDeviceInner( @Json(name = "Path") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt index a2107fcd..e74cb90b 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ResourcesUlimitsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param hard Hard limit */ @JsonClass(generateAdapter = true) + data class ResourcesUlimitsInner( /* Name of ulimit */ 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 94de26d7..b2eb17d3 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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 */ 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 e0aea435..2f593e59 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 c857ebb3..70db4f0a 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param spec */ @JsonClass(generateAdapter = true) + data class Secret( @Json(name = "ID") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt index 5bd28844..7331d8bf 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SecretCreateRequest.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param templating */ @JsonClass(generateAdapter = true) + data class SecretCreateRequest( /* User-defined name of the secret. */ 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 514aa400..ac2089b3 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param templating */ @JsonClass(generateAdapter = true) + data class SecretSpec( /* User-defined name of the secret. */ 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 e46ad98b..efb5a7c9 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -37,6 +32,7 @@ import com.squareup.moshi.JsonClass * @param jobStatus */ @JsonClass(generateAdapter = true) + data class Service( @Json(name = "ID") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt index 64a63c26..b921cbb5 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceCreateRequest.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param endpointSpec */ @JsonClass(generateAdapter = true) + data class ServiceCreateRequest( /* Name of the service. */ 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 76874bd8..585ca5c5 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param warning Optional warning message */ @JsonClass(generateAdapter = true) + data class ServiceCreateResponse( /* The ID of the created service. */ 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 d735bceb..b10cc606 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param virtualIPs */ @JsonClass(generateAdapter = true) + data class ServiceEndpoint( @Json(name = "Spec") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt index 40f3c912..f4e6ebc2 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceEndpointVirtualIPsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param addr */ @JsonClass(generateAdapter = true) + data class ServiceEndpointVirtualIPsInner( @Json(name = "NetworkID") 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 2606abd1..41defa3c 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param lastExecution The last time, as observed by the server, that this job was started. */ @JsonClass(generateAdapter = true) + data class ServiceJobStatus( @Json(name = "JobIteration") 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 7a8e99dc..fd0735f7 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 34ee83b9..9348f4ed 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param endpointSpec */ @JsonClass(generateAdapter = true) + data class ServiceSpec( /* Name of the service. */ 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 915571a9..e88c8b0e 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param globalJob The mode used for services which run a task to the completed state on each valid node. */ @JsonClass(generateAdapter = true) + data class ServiceSpecMode( @Json(name = "Replicated") 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 714997bc..893997ef 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param replicas */ @JsonClass(generateAdapter = true) + data class ServiceSpecModeReplicated( @Json(name = "Replicas") 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 8a809dbb..63d3275b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 654c20e4..6ec46720 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -34,6 +29,7 @@ import com.squareup.moshi.JsonClass * @param order The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. */ @JsonClass(generateAdapter = true) + data class ServiceSpecRollbackConfig( /* Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). */ 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 2b62f178..d720e007 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -34,6 +29,7 @@ import com.squareup.moshi.JsonClass * @param order The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down. */ @JsonClass(generateAdapter = true) + data class ServiceSpecUpdateConfig( /* Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt index 9eb50a06..964d2681 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/ServiceUpdateRequest.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param endpointSpec */ @JsonClass(generateAdapter = true) + data class ServiceUpdateRequest( /* Name of the service. */ 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 0d7761d3..6edb0149 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param warnings Optional warning messages */ @JsonClass(generateAdapter = true) + data class ServiceUpdateResponse( /* Optional warning messages */ 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 ae43d65c..6e1a87dd 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param message */ @JsonClass(generateAdapter = true) + data class ServiceUpdateStatus( @Json(name = "State") 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 7b158b9b..59666b52 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -39,6 +34,7 @@ import com.squareup.moshi.JsonClass * @param joinTokens */ @JsonClass(generateAdapter = true) + data class Swarm( /* The ID of the swarm. */ 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 89e07471..a0c90d77 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param joinTokens */ @JsonClass(generateAdapter = true) + data class SwarmAllOf( @Json(name = "JoinTokens") 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 b4e9de85..747564fe 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -37,6 +32,7 @@ import com.squareup.moshi.JsonClass * @param cluster */ @JsonClass(generateAdapter = true) + data class SwarmInfo( /* Unique identifier of for this node in the swarm. */ 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 1ec48ee5..73e2a089 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param spec */ @JsonClass(generateAdapter = true) + data class SwarmInitRequest( /* Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form `192.168.1.1:4567`, or an interface followed by a port number, like `eth0:4567`. If the port number is omitted, the default swarm listening port is used. */ 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 ee047269..72e0e4c6 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param joinToken Secret token for joining this swarm. */ @JsonClass(generateAdapter = true) + data class SwarmJoinRequest( /* Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). */ 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 dd1a1ac7..872bff8a 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass * @param taskDefaults */ @JsonClass(generateAdapter = true) + data class SwarmSpec( /* Name of the swarm. */ 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 1c26e351..46077b52 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param forceRotate An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in `SigningCACert` and `SigningCAKey` */ @JsonClass(generateAdapter = true) + data class SwarmSpecCAConfig( /* The duration node certificates are issued for. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt index 2a01eee1..a27c48ab 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SwarmSpecCAConfigExternalCAsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param caCert The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). */ @JsonClass(generateAdapter = true) + data class SwarmSpecCAConfigExternalCAsInner( /* Protocol for communication with the external CA (currently only `cfssl` is supported). */ 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 a0a17cbb..3af31394 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 cdb28f46..358dc10f 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 ff958764..db617831 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 2279ae34..b326e0b6 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param heartbeatTick The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers. A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed. */ @JsonClass(generateAdapter = true) + data class SwarmSpecRaft( /* The number of log entries between snapshots. */ 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 38e641db..871c1111 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param logDriver */ @JsonClass(generateAdapter = true) + data class SwarmSpecTaskDefaults( @Json(name = "LogDriver") 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 033f3ab3..a86040ad 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 90ab8b23..33ea037a 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param unlockKey The swarm's unlock key. */ @JsonClass(generateAdapter = true) + data class SwarmUnlockRequest( /* The swarm's unlock key. */ 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 89d62514..88142a8a 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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 */ 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 602a092f..2c45e0be 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param buildCache */ @JsonClass(generateAdapter = true) + data class SystemDataUsageResponse( @Json(name = "LayersSize") 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 b1ed877f..b07ee4c3 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -90,6 +85,7 @@ import com.squareup.moshi.JsonClass * @param warnings List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. */ @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. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt index 9def69d8..ff36a22b 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemInfoDefaultAddressPoolsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param propertySize The network pool size */ @JsonClass(generateAdapter = true) + data class SystemInfoDefaultAddressPoolsInner( /* The network address in CIDR format */ 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 f9830a8e..8fe3c432 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -40,6 +35,7 @@ import com.squareup.moshi.JsonClass * @param buildTime The date and time that the daemon was compiled. */ @JsonClass(generateAdapter = true) + data class SystemVersion( @Json(name = "Platform") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt index b9798354..c855bda0 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/SystemVersionComponentsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param details Key/value pairs of strings with additional information about the component. These values are intended for informational purposes only, and their content is not defined, and not part of the API specification. These messages can be printed by the client as information to the user. */ @JsonClass(generateAdapter = true) + data class SystemVersionComponentsInner( /* Name of the component */ 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 08e9a994..f68134cc 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param name */ @JsonClass(generateAdapter = true) + data class SystemVersionPlatform( @Json(name = "Name") 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 c654c241..eec96021 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 4a78e72b..0da614d5 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -42,6 +37,7 @@ import com.squareup.moshi.JsonClass * @param jobIteration */ @JsonClass(generateAdapter = true) + data class Task( /* The ID of the task. */ 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 229de3dc..6069339f 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass * @param logDriver */ @JsonClass(generateAdapter = true) + data class TaskSpec( @Json(name = "PluginSpec") 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 d405090c..cd5c3112 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -55,6 +50,7 @@ import com.squareup.moshi.JsonClass * @param ulimits A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\" */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpec( /* The image name to use for the container */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt index 9f3081a2..554590d0 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param configName ConfigName is the name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID. */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpecConfigsInner( @Json(name = "File") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt index 255df888..2cb78da1 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecConfigsInnerFile.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param mode Mode represents the FileMode of the file. */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpecConfigsInnerFile( /* Name represents the final filename in the filesystem. */ 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 5ffe5d30..0538be09 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 deleted file mode 100644 index 47477190..00000000 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile.kt +++ /dev/null @@ -1,53 +0,0 @@ -/** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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 - -/** - * File represents a specific target that is backed by a file. - * - * @param name Name represents the final filename in the filesystem. - * @param UID UID represents the file UID. - * @param GID GID represents the file GID. - * @param mode Mode represents the FileMode of the file. - */ -@JsonClass(generateAdapter = true) -data class 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 deleted file mode 100644 index 96a1d71e..00000000 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecFile1.kt +++ /dev/null @@ -1,53 +0,0 @@ -/** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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 - -/** - * File represents a specific target that is backed by a file.


> **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive - * - * @param name Name represents the final filename in the filesystem. - * @param UID UID represents the file UID. - * @param GID GID represents the file GID. - * @param mode Mode represents the FileMode of the file. - */ -@JsonClass(generateAdapter = true) -data class 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 10be2076..cdf1dd2a 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param seLinuxContext */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpecPrivileges( @Json(name = "CredentialSpec") 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 650df1ee..a4cf5000 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @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. */ 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 d24fc4cc..7a1100b5 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param level SELinux level label */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpecPrivilegesSELinuxContext( /* Disable SELinux */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt index 8b6759f5..b0aee287 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param secretName SecretName is the name of the secret that this references, but this is just provided for lookup/display purposes. The secret in the reference will be identified by its ID. */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpecSecretsInner( @Json(name = "File") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt index 1840f9a6..9cae401f 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecContainerSpecSecretsInnerFile.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param mode Mode represents the FileMode of the file. */ @JsonClass(generateAdapter = true) + data class TaskSpecContainerSpecSecretsInnerFile( /* Name represents the final filename in the filesystem. */ 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 a587b9c9..40338d05 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param options */ @JsonClass(generateAdapter = true) + data class TaskSpecLogDriver( @Json(name = "Name") 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 d486b3be..185de00b 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param containerID ID of the container represented by this task */ @JsonClass(generateAdapter = true) + data class TaskSpecNetworkAttachmentSpec( /* ID of the container represented by this task */ 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 4f27ae9b..355cc7f7 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param platforms Platforms stores all the platforms that the service's image can run on. This field is used in the platform filter for scheduling. If empty, then the platform filter is off, meaning there are no scheduling restrictions. */ @JsonClass(generateAdapter = true) + data class TaskSpecPlacement( /* An array of constraint expressions to limit the set of nodes where a task can be scheduled. Constraint expressions can either use a _match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find nodes that satisfy every expression (AND match). Constraints can match node or Docker Engine labels as follows: node attribute | matches | example ---------------------|--------------------------------|----------------------------------------------- `node.id` | Node ID | `node.id==2ivku8v2gvtg4` `node.hostname` | Node hostname | `node.hostname!=node-2` `node.role` | Node role (`manager`/`worker`) | `node.role==manager` `node.platform.os` | Node operating system | `node.platform.os==windows` `node.platform.arch` | Node architecture | `node.platform.arch==x86_64` `node.labels` | User-defined node labels | `node.labels.security==high` `engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04` `engine.labels` apply to Docker Engine labels like operating system, drivers, etc. Swarm administrators add `node.labels` for operational purposes by using the [`node update endpoint`](#operation/NodeUpdate). */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt index a330f771..0177b14a 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInner.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param spread */ @JsonClass(generateAdapter = true) + data class TaskSpecPlacementPreferencesInner( @Json(name = "Spread") diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt index dd02424a..750fdafc 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementPreferencesInnerSpread.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param spreadDescriptor label descriptor, such as `engine.labels.az`. */ @JsonClass(generateAdapter = true) + data class TaskSpecPlacementPreferencesInnerSpread( /* label descriptor, such as `engine.labels.az`. */ 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 deleted file mode 100644 index 88a6dcc7..00000000 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/TaskSpecPlacementSpread.kt +++ /dev/null @@ -1,38 +0,0 @@ -/** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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 5d9e2d32..e9ed6cf6 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param pluginPrivilege */ @JsonClass(generateAdapter = true) + data class TaskSpecPluginSpec( /* The name or 'alias' to use for the plugin. */ 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 e3787612..7cbe6e28 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param reservations */ @JsonClass(generateAdapter = true) + data class TaskSpecResources( @Json(name = "Limits") 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 79e33166..06b8d0fb 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param window Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded). */ @JsonClass(generateAdapter = true) + data class TaskSpecRestartPolicy( /* Condition for restart. */ 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 fa082189..39911720 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( 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 ef2dd432..2586135c 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -33,6 +28,7 @@ import com.squareup.moshi.JsonClass * @param containerStatus */ @JsonClass(generateAdapter = true) + data class TaskStatus( @Json(name = "Timestamp") 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 402aa2e6..dc868e44 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -31,6 +26,7 @@ import com.squareup.moshi.JsonClass * @param exitCode */ @JsonClass(generateAdapter = true) + data class TaskStatusContainerStatus( @Json(name = "ContainerID") 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 5501eb28..6ec029db 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param rate Rate */ @JsonClass(generateAdapter = true) + data class ThrottleDevice( /* Device path */ 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 c3d3916c..7f48cc27 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -29,6 +24,7 @@ import com.squareup.moshi.JsonClass * @param unlockKey The swarm's unlock key. */ @JsonClass(generateAdapter = true) + data class UnlockKeyResponse( /* The swarm's unlock key. */ 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 ae545247..6d690374 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -37,6 +32,7 @@ import com.squareup.moshi.JsonClass * @param usageData */ @JsonClass(generateAdapter = true) + data class Volume( /* Name of the volume. */ diff --git a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt index e50b3a3f..b4de1f11 100644 --- a/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt +++ b/api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/VolumeCreateOptions.kt @@ -1,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass * @param labels User-defined key/value metadata. */ @JsonClass(generateAdapter = true) + data class VolumeCreateOptions( /* The new volume's name. If not specified, Docker generates a name. */ 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 87a99976..6a653913 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param warnings Warnings that occurred when fetching the list of volumes. */ @JsonClass(generateAdapter = true) + data class VolumeListResponse( /* List of volumes */ 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 6257ec26..adb45075 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,14 +1,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @param spaceReclaimed Disk space reclaimed in bytes */ @JsonClass(generateAdapter = true) + data class VolumePruneResponse( /* Volumes that were deleted */ 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 e239af64..1c6caceb 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,9 @@ /** - * Docker Engine API - * - * The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token 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( @@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass * @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\") */