-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add generated engine-api from https://docs.docker.com/engine/api/v1.41/
- Loading branch information
Showing
76 changed files
with
14,874 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| *.class | ||
|
|
||
| # Mobile Tools for Java (J2ME) | ||
| .mtj.tmp/ | ||
|
|
||
| # Package Files # | ||
| *.jar | ||
| *.war | ||
| *.ear | ||
|
|
||
| # exclude jar for gradle wrapper | ||
| !gradle/wrapper/*.jar | ||
|
|
||
| # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml | ||
| hs_err_pid* | ||
|
|
||
| # build files | ||
| **/target | ||
| target | ||
| .gradle | ||
| build |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| plugins { | ||
| id("java") | ||
| id("org.jetbrains.kotlin.jvm") | ||
| id("org.jetbrains.kotlin.kapt") | ||
| id("com.github.ben-manes.versions") | ||
| } | ||
|
|
||
| version = "1.41" | ||
|
|
||
| repositories { | ||
| mavenCentral() | ||
| } | ||
|
|
||
| java { | ||
| sourceCompatibility = JavaVersion.VERSION_1_8 | ||
| targetCompatibility = JavaVersion.VERSION_1_8 | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.4.10") | ||
| implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3") | ||
| implementation("com.squareup.moshi:moshi:1.12.0") | ||
| // implementation("com.squareup.moshi:moshi-kotlin:1.12.0") | ||
| kapt("com.squareup.moshi:moshi-kotlin-codegen:1.12.0") | ||
| implementation("com.squareup.okhttp3:okhttp:4.9.1") | ||
| testImplementation("io.kotlintest:kotlintest-runner-junit5:3.4.2") | ||
| implementation("de.gesellix:docker-api-model:2021-06-18T21-30-35") | ||
| implementation("de.gesellix:docker-engine:2021-06-18T21-30-35") | ||
| implementation("de.gesellix:docker-filesocket:2021-06-06T17-29-35") | ||
|
|
||
| // implementation("com.squareup.okhttp3:logging-interceptor:4.9.1") | ||
| // implementation("org.apache.commons:commons-lang3:3.10") | ||
| // implementation("javax.annotation:javax.annotation-api:1.3.2") | ||
| // testImplementation("junit:junit:4.13.1") | ||
| } | ||
|
|
||
| tasks.withType(Test::class.java) { | ||
| useJUnitPlatform() | ||
| } | ||
|
|
||
| //tasks.javadoc { | ||
| // options.tags = ["http.response.details:a:Http Response Details"] | ||
| //} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| # ConfigApi | ||
|
|
||
| All URIs are relative to *http://localhost/v1.41* | ||
|
|
||
| Method | HTTP request | Description | Integration tests | ||
| ------------- | ------------- | ------------- | --- | ||
| [**configCreate**](ConfigApi.md#configCreate) | **POST** /configs/create | Create a config | ✅ | ||
| [**configDelete**](ConfigApi.md#configDelete) | **DELETE** /configs/{id} | Delete a config | ✅ | ||
| [**configInspect**](ConfigApi.md#configInspect) | **GET** /configs/{id} | Inspect a config | ✅ | ||
| [**configList**](ConfigApi.md#configList) | **GET** /configs | List configs | ✅ | ||
| [**configUpdate**](ConfigApi.md#configUpdate) | **POST** /configs/{id}/update | Update a Config | ✅ | ||
|
|
||
|
|
||
| <a name="configCreate"></a> | ||
| # **configCreate** | ||
| > IdResponse configCreate(body) | ||
| Create a config | ||
|
|
||
| ### Example | ||
| ```kotlin | ||
| // Import classes: | ||
| //import org.openapitools.client.infrastructure.* | ||
| //import de.gesellix.docker.engine.model.* | ||
|
|
||
| val apiInstance = ConfigApi() | ||
| val body : UNKNOWN_BASE_TYPE = // UNKNOWN_BASE_TYPE | | ||
| try { | ||
| val result : IdResponse = apiInstance.configCreate(body) | ||
| println(result) | ||
| } catch (e: ClientException) { | ||
| println("4xx response calling ConfigApi#configCreate") | ||
| e.printStackTrace() | ||
| } catch (e: ServerException) { | ||
| println("5xx response calling ConfigApi#configCreate") | ||
| e.printStackTrace() | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **body** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)| | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| [**IdResponse**](IdResponse.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: application/json | ||
| - **Accept**: application/json | ||
|
|
||
| <a name="configDelete"></a> | ||
| # **configDelete** | ||
| > configDelete(id) | ||
| Delete a config | ||
|
|
||
| ### Example | ||
| ```kotlin | ||
| // Import classes: | ||
| //import org.openapitools.client.infrastructure.* | ||
| //import de.gesellix.docker.engine.model.* | ||
|
|
||
| val apiInstance = ConfigApi() | ||
| val id : kotlin.String = id_example // kotlin.String | ID of the config | ||
| try { | ||
| apiInstance.configDelete(id) | ||
| } catch (e: ClientException) { | ||
| println("4xx response calling ConfigApi#configDelete") | ||
| e.printStackTrace() | ||
| } catch (e: ServerException) { | ||
| println("5xx response calling ConfigApi#configDelete") | ||
| e.printStackTrace() | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **id** | **kotlin.String**| ID of the config | | ||
|
|
||
| ### Return type | ||
|
|
||
| null (empty response body) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| <a name="configInspect"></a> | ||
| # **configInspect** | ||
| > Config configInspect(id) | ||
| Inspect a config | ||
|
|
||
| ### Example | ||
| ```kotlin | ||
| // Import classes: | ||
| //import org.openapitools.client.infrastructure.* | ||
| //import de.gesellix.docker.engine.model.* | ||
|
|
||
| val apiInstance = ConfigApi() | ||
| val id : kotlin.String = id_example // kotlin.String | ID of the config | ||
| try { | ||
| val result : Config = apiInstance.configInspect(id) | ||
| println(result) | ||
| } catch (e: ClientException) { | ||
| println("4xx response calling ConfigApi#configInspect") | ||
| e.printStackTrace() | ||
| } catch (e: ServerException) { | ||
| println("5xx response calling ConfigApi#configInspect") | ||
| e.printStackTrace() | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **id** | **kotlin.String**| ID of the config | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**Config**](Config.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| <a name="configList"></a> | ||
| # **configList** | ||
| > kotlin.collections.List<Config> configList(filters) | ||
| List configs | ||
|
|
||
| ### Example | ||
| ```kotlin | ||
| // Import classes: | ||
| //import org.openapitools.client.infrastructure.* | ||
| //import de.gesellix.docker.engine.model.* | ||
|
|
||
| val apiInstance = ConfigApi() | ||
| 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>` | ||
| try { | ||
| val result : kotlin.collections.List<Config> = apiInstance.configList(filters) | ||
| println(result) | ||
| } catch (e: ClientException) { | ||
| println("4xx response calling ConfigApi#configList") | ||
| e.printStackTrace() | ||
| } catch (e: ServerException) { | ||
| println("5xx response calling ConfigApi#configList") | ||
| e.printStackTrace() | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **filters** | **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>` | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| [**kotlin.collections.List<Config>**](Config.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| <a name="configUpdate"></a> | ||
| # **configUpdate** | ||
| > configUpdate(id, version, body) | ||
| Update a Config | ||
|
|
||
| ### Example | ||
| ```kotlin | ||
| // Import classes: | ||
| //import org.openapitools.client.infrastructure.* | ||
| //import de.gesellix.docker.engine.model.* | ||
|
|
||
| val apiInstance = ConfigApi() | ||
| val id : kotlin.String = id_example // kotlin.String | The ID or name of the config | ||
| val version : kotlin.Long = 789 // kotlin.Long | The version number of the config object being updated. This is required to avoid conflicting writes. | ||
| 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. | ||
| try { | ||
| apiInstance.configUpdate(id, version, body) | ||
| } catch (e: ClientException) { | ||
| println("4xx response calling ConfigApi#configUpdate") | ||
| e.printStackTrace() | ||
| } catch (e: ServerException) { | ||
| println("5xx response calling ConfigApi#configUpdate") | ||
| e.printStackTrace() | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **id** | **kotlin.String**| The ID or name of the config | | ||
| **version** | **kotlin.Long**| The version number of the config object being updated. This is required to avoid conflicting writes. | | ||
| **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] | ||
|
|
||
| ### Return type | ||
|
|
||
| null (empty response body) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: application/json, text/plain | ||
| - **Accept**: application/json, text/plain | ||
|
|
Oops, something went wrong.