Skip to content

Commit 299ebec

Browse files
gesellixgesellix
committed
add generated engine-api from https://docs.docker.com/engine/api/v1.41/ 
1 parent 64e52fe commit 299ebec

File tree

99 files changed

+17417
-33
lines changed

Some content is hidden

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

99 files changed

+17417
-33
lines changed

‎build.gradle.kts

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,43 @@ plugins {
44
id("net.ossindex.audit") version "0.4.11"
55
id("io.freefair.maven-central.validate-poms") version "6.2.0"
66
id("io.github.gradle-nexus.publish-plugin") version "1.1.0"
7+
id("org.jetbrains.kotlin.jvm") version "1.5.31" apply false
8+
id("org.jetbrains.kotlin.kapt") version "1.5.31" apply false
79
}
810

911
val dependencyVersions = listOf(
12+
"com.fasterxml.jackson.core:jackson-databind:2.9.10.8",
13+
"com.squareup.moshi:moshi:1.12.0",
14+
"com.squareup.okio:okio:2.10.0",
15+
"org.apache.commons:commons-lang3:3.12.0",
16+
"org.apiguardian:apiguardian-api:1.1.0",
1017
"org.codehaus.groovy:groovy:3.0.9",
1118
"org.codehaus.groovy:groovy-json:3.0.9",
12-
"org.jetbrains:annotations:22.0.0"
19+
"org.jetbrains:annotations:22.0.0",
20+
"org.jetbrains.kotlin:kotlin-reflect:1.5.31",
21+
"org.jetbrains.kotlin:kotlin-stdlib:1.5.31",
22+
"org.jetbrains.kotlin:kotlin-stdlib-common:1.5.31",
23+
"org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.5.31",
24+
"org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.5.31",
25+
"org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2",
26+
"org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.2",
27+
"org.junit:junit-bom:5.8.1",
28+
"org.junit.jupiter:junit-jupiter-api:5.8.1",
29+
"org.junit.platform:junit-platform-commons:1.8.0",
30+
"org.junit.platform:junit-platform-engine:1.8.0",
31+
"org.junit.platform:junit-platform-launcher:1.8.0",
32+
"org.junit.platform:junit-platform-suite-api:1.8.0",
33+
"org.opentest4j:opentest4j:1.2.0"
1334
)
1435

1536
val dependencyVersionsByGroup = mapOf<String, String>()
1637

38+
subprojects {
39+
repositories {
40+
mavenCentral()
41+
}
42+
}
43+
1744
allprojects {
1845
configurations.all {
1946
resolutionStrategy {

‎client/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ dependencies {
6767
api("de.gesellix:docker-engine:2021-09-29T15-30-00")
6868
api("de.gesellix:docker-compose:2021-09-21T08-00-00")
6969

70-
implementation("org.codehaus.groovy:groovy:[2.5,)")
70+
api("org.codehaus.groovy:groovy:[2.5,)")
7171
implementation("org.codehaus.groovy:groovy-json:[2.5,)")
7272

7373
api("com.squareup.moshi:moshi:[1.12.0,2)")

‎engine-api/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
*.class
2+
3+
# Mobile Tools for Java (J2ME)
4+
.mtj.tmp/
5+
6+
# Package Files #
7+
*.jar
8+
*.war
9+
*.ear
10+
11+
# exclude jar for gradle wrapper
12+
!gradle/wrapper/*.jar
13+
14+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
15+
hs_err_pid*
16+
17+
# build files
18+
**/target
19+
target
20+
.gradle
21+
build

‎engine-api/README.md

Lines changed: 321 additions & 0 deletions
Large diffs are not rendered by default.

‎engine-api/build.gradle.kts

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
plugins {
2+
id("java")
3+
id("org.jetbrains.kotlin.jvm")
4+
id("org.jetbrains.kotlin.kapt")
5+
id("com.github.ben-manes.versions")
6+
}
7+
8+
version = "1.41"
9+
10+
java {
11+
sourceCompatibility = JavaVersion.VERSION_1_8
12+
targetCompatibility = JavaVersion.VERSION_1_8
13+
}
14+
15+
dependencies {
16+
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.5.31")
17+
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2")
18+
implementation("com.squareup.moshi:moshi:1.12.0")
19+
// implementation("com.squareup.moshi:moshi-kotlin:1.12.0")
20+
kapt("com.squareup.moshi:moshi-kotlin-codegen:1.12.0")
21+
implementation("com.squareup.okhttp3:okhttp:4.9.1")
22+
testImplementation("io.kotlintest:kotlintest-runner-junit5:3.4.2")
23+
implementation("de.gesellix:docker-api-model:2021-09-29T15-30-00")
24+
implementation("de.gesellix:docker-engine:2021-09-29T15-30-00")
25+
implementation("de.gesellix:docker-filesocket:2021-09-20T20-10-00")
26+
27+
implementation("org.slf4j:slf4j-api:[1.7,)!!1.7.32")
28+
testImplementation("ch.qos.logback:logback-classic:[1.2,2)!!1.2.6")
29+
30+
// implementation("com.squareup.okhttp3:logging-interceptor:4.9.1")
31+
// implementation("org.apache.commons:commons-lang3:3.10")
32+
// implementation("javax.annotation:javax.annotation-api:1.3.2")
33+
// testImplementation("junit:junit:4.13.1")
34+
}
35+
36+
tasks.withType(Test::class.java) {
37+
useJUnitPlatform()
38+
}
39+
40+
//tasks.javadoc {
41+
// options.tags = ["http.response.details:a:Http Response Details"]
42+
//}

‎engine-api/docs/ConfigApi.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
# ConfigApi
2+
3+
All URIs are relative to *http://localhost/v1.41*
4+
5+
Method | HTTP request | Description | Integration tests
6+
------------- | ------------- | ------------- | ---
7+
[**configCreate**](ConfigApi.md#configCreate) | **POST** /configs/create | Create a config | ✅
8+
[**configDelete**](ConfigApi.md#configDelete) | **DELETE** /configs/{id} | Delete a config | ✅
9+
[**configInspect**](ConfigApi.md#configInspect) | **GET** /configs/{id} | Inspect a config | ✅
10+
[**configList**](ConfigApi.md#configList) | **GET** /configs | List configs | ✅
11+
[**configUpdate**](ConfigApi.md#configUpdate) | **POST** /configs/{id}/update | Update a Config | ✅
12+
13+
14+
<a name="configCreate"></a>
15+
# **configCreate**
16+
> IdResponse configCreate(body)
17+
18+
Create a config
19+
20+
### Example
21+
```kotlin
22+
// Import classes:
23+
//import de.gesellix.docker.engine.client.infrastructure.*
24+
//import de.gesellix.docker.engine.model.*
25+
26+
val apiInstance = ConfigApi()
27+
val body : UNKNOWN_BASE_TYPE = // UNKNOWN_BASE_TYPE |
28+
try {
29+
val result : IdResponse = apiInstance.configCreate(body)
30+
println(result)
31+
} catch (e: ClientException) {
32+
println("4xx response calling ConfigApi#configCreate")
33+
e.printStackTrace()
34+
} catch (e: ServerException) {
35+
println("5xx response calling ConfigApi#configCreate")
36+
e.printStackTrace()
37+
}
38+
```
39+
40+
### Parameters
41+
42+
Name | Type | Description | Notes
43+
------------- | ------------- | ------------- | -------------
44+
**body** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)| | [optional]
45+
46+
### Return type
47+
48+
[**IdResponse**](IdResponse.md)
49+
50+
### Authorization
51+
52+
No authorization required
53+
54+
### HTTP request headers
55+
56+
- **Content-Type**: application/json
57+
- **Accept**: application/json
58+
59+
<a name="configDelete"></a>
60+
# **configDelete**
61+
> configDelete(id)
62+
63+
Delete a config
64+
65+
### Example
66+
```kotlin
67+
// Import classes:
68+
//import de.gesellix.docker.engine.client.infrastructure.*
69+
//import de.gesellix.docker.engine.model.*
70+
71+
val apiInstance = ConfigApi()
72+
val id : kotlin.String = id_example // kotlin.String | ID of the config
73+
try {
74+
apiInstance.configDelete(id)
75+
} catch (e: ClientException) {
76+
println("4xx response calling ConfigApi#configDelete")
77+
e.printStackTrace()
78+
} catch (e: ServerException) {
79+
println("5xx response calling ConfigApi#configDelete")
80+
e.printStackTrace()
81+
}
82+
```
83+
84+
### Parameters
85+
86+
Name | Type | Description | Notes
87+
------------- | ------------- | ------------- | -------------
88+
**id** | **kotlin.String**| ID of the config |
89+
90+
### Return type
91+
92+
null (empty response body)
93+
94+
### Authorization
95+
96+
No authorization required
97+
98+
### HTTP request headers
99+
100+
- **Content-Type**: Not defined
101+
- **Accept**: application/json
102+
103+
<a name="configInspect"></a>
104+
# **configInspect**
105+
> Config configInspect(id)
106+
107+
Inspect a config
108+
109+
### Example
110+
```kotlin
111+
// Import classes:
112+
//import de.gesellix.docker.engine.client.infrastructure.*
113+
//import de.gesellix.docker.engine.model.*
114+
115+
val apiInstance = ConfigApi()
116+
val id : kotlin.String = id_example // kotlin.String | ID of the config
117+
try {
118+
val result : Config = apiInstance.configInspect(id)
119+
println(result)
120+
} catch (e: ClientException) {
121+
println("4xx response calling ConfigApi#configInspect")
122+
e.printStackTrace()
123+
} catch (e: ServerException) {
124+
println("5xx response calling ConfigApi#configInspect")
125+
e.printStackTrace()
126+
}
127+
```
128+
129+
### Parameters
130+
131+
Name | Type | Description | Notes
132+
------------- | ------------- | ------------- | -------------
133+
**id** | **kotlin.String**| ID of the config |
134+
135+
### Return type
136+
137+
[**Config**](Config.md)
138+
139+
### Authorization
140+
141+
No authorization required
142+
143+
### HTTP request headers
144+
145+
- **Content-Type**: Not defined
146+
- **Accept**: application/json
147+
148+
<a name="configList"></a>
149+
# **configList**
150+
> kotlin.collections.List&lt;Config&gt; configList(filters)
151+
152+
List configs
153+
154+
### Example
155+
```kotlin
156+
// Import classes:
157+
//import de.gesellix.docker.engine.client.infrastructure.*
158+
//import de.gesellix.docker.engine.model.*
159+
160+
val apiInstance = ConfigApi()
161+
val filters : kotlin.String = filters_example // kotlin.String | A JSON encoded value of the filters (a `map[string][]string`) to process on the configs list. Available filters: - `id=<config id>` - `label=<key> or label=<key>=value` - `name=<config name>` - `names=<config name>`
162+
try {
163+
val result : kotlin.collections.List<Config> = apiInstance.configList(filters)
164+
println(result)
165+
} catch (e: ClientException) {
166+
println("4xx response calling ConfigApi#configList")
167+
e.printStackTrace()
168+
} catch (e: ServerException) {
169+
println("5xx response calling ConfigApi#configList")
170+
e.printStackTrace()
171+
}
172+
```
173+
174+
### Parameters
175+
176+
Name | Type | Description | Notes
177+
------------- | ------------- | ------------- | -------------
178+
**filters** | **kotlin.String**| A JSON encoded value of the filters (a &#x60;map[string][]string&#x60;) to process on the configs list. Available filters: - &#x60;id&#x3D;&lt;config id&gt;&#x60; - &#x60;label&#x3D;&lt;key&gt; or label&#x3D;&lt;key&gt;&#x3D;value&#x60; - &#x60;name&#x3D;&lt;config name&gt;&#x60; - &#x60;names&#x3D;&lt;config name&gt;&#x60; | [optional]
179+
180+
### Return type
181+
182+
[**kotlin.collections.List&lt;Config&gt;**](Config.md)
183+
184+
### Authorization
185+
186+
No authorization required
187+
188+
### HTTP request headers
189+
190+
- **Content-Type**: Not defined
191+
- **Accept**: application/json
192+
193+
<a name="configUpdate"></a>
194+
# **configUpdate**
195+
> configUpdate(id, version, body)
196+
197+
Update a Config
198+
199+
### Example
200+
```kotlin
201+
// Import classes:
202+
//import de.gesellix.docker.engine.client.infrastructure.*
203+
//import de.gesellix.docker.engine.model.*
204+
205+
val apiInstance = ConfigApi()
206+
val id : kotlin.String = id_example // kotlin.String | The ID or name of the config
207+
val version : kotlin.Long = 789 // kotlin.Long | The version number of the config object being updated. This is required to avoid conflicting writes.
208+
val body : ConfigSpec = // ConfigSpec | The spec of the config to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the [ConfigInspect endpoint](#operation/ConfigInspect) response values.
209+
try {
210+
apiInstance.configUpdate(id, version, body)
211+
} catch (e: ClientException) {
212+
println("4xx response calling ConfigApi#configUpdate")
213+
e.printStackTrace()
214+
} catch (e: ServerException) {
215+
println("5xx response calling ConfigApi#configUpdate")
216+
e.printStackTrace()
217+
}
218+
```
219+
220+
### Parameters
221+
222+
Name | Type | Description | Notes
223+
------------- | ------------- | ------------- | -------------
224+
**id** | **kotlin.String**| The ID or name of the config |
225+
**version** | **kotlin.Long**| The version number of the config object being updated. This is required to avoid conflicting writes. |
226+
**body** | [**ConfigSpec**](ConfigSpec.md)| The spec of the config to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the [ConfigInspect endpoint](#operation/ConfigInspect) response values. | [optional]
227+
228+
### Return type
229+
230+
null (empty response body)
231+
232+
### Authorization
233+
234+
No authorization required
235+
236+
### HTTP request headers
237+
238+
- **Content-Type**: application/json, text/plain
239+
- **Accept**: application/json, text/plain
240+

0 commit comments

Comments
 (0)