Skip to content

Commit 0f99286

Browse files
committed
Use the updated remote-api model
Relates to #154
1 parent 1c3c931 commit 0f99286

23 files changed

+371
-338
lines changed

api-client/src/main/kotlin/de/gesellix/docker/remote/api/client/ConfigApi.kt

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
1+
/**
2+
* Docker Engine API
3+
*
4+
* The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API. Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { \"message\": \"page not found\" } ``` # Versioning The API is usually changed in each release, so API calls are versioned to ensure that clients don't break. To lock to a specific version of the API, you prefix the URL with its version, for example, call `/v1.30/info` to use the v1.30 version of the `/info` endpoint. If the API version specified in the URL is not supported by the daemon, a HTTP `400 Bad Request` error message is returned. If you omit the version-prefix, the current version of the API (v1.41) is used. For example, calling `/info` is the same as calling `/v1.41/info`. Using the API without a version-prefix is deprecated and will be removed in a future release. Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine. The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer daemons. # Authentication Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5) (JSON) string with the following structure: ``` { \"username\": \"string\", \"password\": \"string\", \"email\": \"string\", \"serveraddress\": \"string\" } ``` The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required. If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials: ``` { \"identitytoken\": \"9cbaf023786cd7...\" } ```
5+
*
6+
* The version of the OpenAPI document: 1.41
7+
*
8+
*
9+
* Please note:
10+
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11+
* Do not edit this file manually.
12+
*/
113
package de.gesellix.docker.remote.api.client
214

315
import de.gesellix.docker.engine.DockerClientConfig
416
import de.gesellix.docker.engine.RequestMethod
517
import de.gesellix.docker.remote.api.Config
18+
import de.gesellix.docker.remote.api.ConfigCreateRequest
619
import de.gesellix.docker.remote.api.ConfigSpec
720
import de.gesellix.docker.remote.api.IdResponse
821
import de.gesellix.docker.remote.api.core.ApiClient
@@ -36,9 +49,8 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
3649
* @throws ClientException If the API returns a client error response
3750
* @throws ServerException If the API returns a server error response
3851
*/
39-
@Suppress("UNCHECKED_CAST")
4052
@Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
41-
fun configCreate(body: ConfigSpec?): IdResponse {
53+
fun configCreate(body: ConfigCreateRequest?): IdResponse {
4254
val localVariableConfig = configCreateRequestConfig(body = body)
4355

4456
val localVarResponse = request<IdResponse>(
@@ -66,8 +78,8 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
6678
* @param body (optional)
6779
* @return RequestConfig
6880
*/
69-
fun configCreateRequestConfig(body: ConfigSpec?): RequestConfig {
70-
val localVariableBody: Any? = body
81+
fun configCreateRequestConfig(body: ConfigCreateRequest?): RequestConfig {
82+
val localVariableBody = body
7183
val localVariableQuery: MultiValueMap = mutableMapOf()
7284
val localVariableHeaders: MutableMap<String, String> = mutableMapOf()
7385

@@ -119,7 +131,7 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
119131
* @return RequestConfig
120132
*/
121133
fun configDeleteRequestConfig(id: String): RequestConfig {
122-
val localVariableBody: Any? = null
134+
val localVariableBody = null
123135
val localVariableQuery: MultiValueMap = mutableMapOf()
124136
val localVariableHeaders: MutableMap<String, String> = mutableMapOf()
125137

@@ -141,7 +153,6 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
141153
* @throws ClientException If the API returns a client error response
142154
* @throws ServerException If the API returns a server error response
143155
*/
144-
@Suppress("UNCHECKED_CAST")
145156
@Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
146157
fun configInspect(id: String): Config {
147158
val localVariableConfig = configInspectRequestConfig(id = id)
@@ -172,7 +183,7 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
172183
* @return RequestConfig
173184
*/
174185
fun configInspectRequestConfig(id: String): RequestConfig {
175-
val localVariableBody: Any? = null
186+
val localVariableBody = null
176187
val localVariableQuery: MultiValueMap = mutableMapOf()
177188
val localVariableHeaders: MutableMap<String, String> = mutableMapOf()
178189

@@ -194,7 +205,6 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
194205
* @throws ClientException If the API returns a client error response
195206
* @throws ServerException If the API returns a server error response
196207
*/
197-
@Suppress("UNCHECKED_CAST")
198208
@Throws(UnsupportedOperationException::class, ClientException::class, ServerException::class)
199209
fun configList(filters: String?): List<Config> {
200210
val localVariableConfig = configListRequestConfig(filters = filters)
@@ -225,7 +235,7 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
225235
* @return RequestConfig
226236
*/
227237
fun configListRequestConfig(filters: String?): RequestConfig {
228-
val localVariableBody: Any? = null
238+
val localVariableBody = null
229239
val localVariableQuery: MultiValueMap = mutableMapOf<String, List<String>>()
230240
.apply {
231241
if (filters != null) {
@@ -287,7 +297,7 @@ class ConfigApi(dockerClientConfig: DockerClientConfig = defaultClientConfig, pr
287297
* @return RequestConfig
288298
*/
289299
fun configUpdateRequestConfig(id: String, version: Long, body: ConfigSpec?): RequestConfig {
290-
val localVariableBody: Any? = body
300+
val localVariableBody = body
291301
val localVariableQuery: MultiValueMap = mutableMapOf<String, List<String>>()
292302
.apply {
293303
put("version", listOf(version.toString()))

0 commit comments

Comments
 (0)