Skip to content

Commit 7588888

Browse files
committed
updateApiModelSources after openapi-generator update
1 parent d247371 commit 7588888

File tree

202 files changed

+473
-1329
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+473
-1329
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.2.0
1+
6.2.1

api-model-v1-41/README.md

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,89 @@
11
# de.gesellix.docker.remote.api - Kotlin client library for Docker Engine API
22

3+
The Engine API is an HTTP API served by Docker Engine. It is the API the
4+
Docker client uses to communicate with the Engine, so everything the Docker
5+
client can do can be done with the API.
6+
7+
Most of the client's commands map directly to API endpoints (e.g. `docker ps`
8+
is `GET /containers/json`). The notable exception is running containers,
9+
which consists of several API calls.
10+
11+
# Errors
12+
13+
The API uses standard HTTP status codes to indicate the success or failure
14+
of the API call. The body of the response will be JSON in the following
15+
format:
16+
17+
```
18+
{
19+
\"message\": \"page not found\"
20+
}
21+
```
22+
23+
# Versioning
24+
25+
The API is usually changed in each release, so API calls are versioned to
26+
ensure that clients don't break. To lock to a specific version of the API,
27+
you prefix the URL with its version, for example, call `/v1.30/info` to use
28+
the v1.30 version of the `/info` endpoint. If the API version specified in
29+
the URL is not supported by the daemon, a HTTP `400 Bad Request` error message
30+
is returned.
31+
32+
If you omit the version-prefix, the current version of the API (v1.41) is used.
33+
For example, calling `/info` is the same as calling `/v1.41/info`. Using the
34+
API without a version-prefix is deprecated and will be removed in a future release.
35+
36+
Engine releases in the near future should support this version of the API,
37+
so your client will continue to work even if it is talking to a newer Engine.
38+
39+
The API uses an open schema model, which means server may add extra properties
40+
to responses. Likewise, the server will ignore any extra query parameters and
41+
request body properties. When you write clients, you need to ignore additional
42+
properties in responses to ensure they do not break when talking to newer
43+
daemons.
44+
45+
46+
# Authentication
47+
48+
Authentication for registries is handled client side. The client has to send
49+
authentication details to various endpoints that need to communicate with
50+
registries, such as `POST /images/(name)/push`. These are sent as
51+
`X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)
52+
(JSON) string with the following structure:
53+
54+
```
55+
{
56+
\"username\": \"string\",
57+
\"password\": \"string\",
58+
\"email\": \"string\",
59+
\"serveraddress\": \"string\"
60+
}
61+
```
62+
63+
The `serveraddress` is a domain/IP without a protocol. Throughout this
64+
structure, double quotes are required.
65+
66+
If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth),
67+
you can just pass this instead of credentials:
68+
69+
```
70+
{
71+
\"identitytoken\": \"9cbaf023786cd7...\"
72+
}
73+
```
74+
75+
76+
## Overview
77+
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.
78+
79+
- API version: 1.41
80+
- Package version:
81+
- Build package: org.openapitools.codegen.languages.KotlinClientCodegen
82+
383
## Requires
484

5-
* Kotlin 1.4.30
6-
* Gradle 6.8.3
85+
* Kotlin 1.6.10
86+
* Gradle 7.5
787

888
## Build
989

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/Address.kt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
/**
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-
*
82
*
93
* Please note:
104
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
115
* Do not edit this file manually.
6+
*
127
*/
138

149
@file:Suppress(
@@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass
3025
* @param prefixLen Mask length of the IP address.
3126
*/
3227
@JsonClass(generateAdapter = true)
28+
3329
data class Address(
3430

3531
/* IP address. */

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/AuthConfig.kt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
/**
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-
*
82
*
93
* Please note:
104
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
115
* Do not edit this file manually.
6+
*
127
*/
138

149
@file:Suppress(
@@ -32,6 +27,7 @@ import com.squareup.moshi.JsonClass
3227
* @param serveraddress
3328
*/
3429
@JsonClass(generateAdapter = true)
30+
3531
data class AuthConfig(
3632

3733
@Json(name = "username")

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildCache.kt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
/**
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-
*
82
*
93
* Please note:
104
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
115
* Do not edit this file manually.
6+
*
127
*/
138

149
@file:Suppress(
@@ -38,6 +33,7 @@ import com.squareup.moshi.JsonClass
3833
* @param usageCount
3934
*/
4035
@JsonClass(generateAdapter = true)
36+
4137
data class BuildCache(
4238

4339
@Json(name = "ID")

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildInfo.kt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
/**
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-
*
82
*
93
* Please note:
104
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
115
* Do not edit this file manually.
6+
*
127
*/
138

149
@file:Suppress(
@@ -36,6 +31,7 @@ import com.squareup.moshi.JsonClass
3631
* @param aux
3732
*/
3833
@JsonClass(generateAdapter = true)
34+
3935
data class BuildInfo(
4036

4137
@Json(name = "id")

api-model-v1-41/src/main/kotlin/de/gesellix/docker/remote/api/BuildPruneResponse.kt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
/**
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-
*
82
*
93
* Please note:
104
* This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
115
* Do not edit this file manually.
6+
*
127
*/
138

149
@file:Suppress(
@@ -30,6 +25,7 @@ import com.squareup.moshi.JsonClass
3025
* @param spaceReclaimed Disk space reclaimed in bytes
3126
*/
3227
@JsonClass(generateAdapter = true)
28+
3329
data class BuildPruneResponse(
3430

3531
@Json(name = "CachesDeleted")

0 commit comments

Comments
 (0)