generate api model with a patched version of the v1.41 api schema

Author: gesellix

engine-api-model/.openapi-generator/FILES

@@ -14,6 +14,9 @@ docs/ContainerCreateResponse.md
 docs/ContainerInspectResponse.md
 docs/ContainerPruneResponse.md
 docs/ContainerState.md
+docs/ContainerSummary.md
+docs/ContainerSummaryHostConfig.md
+docs/ContainerSummaryNetworkSettings.md
 docs/ContainerTopResponse.md
 docs/ContainerUpdateResponse.md
 docs/ContainerWaitResponse.md
@@ -197,6 +200,9 @@ src/main/kotlin/de/gesellix/docker/engine/model/ContainerCreateResponse.kt
 src/main/kotlin/de/gesellix/docker/engine/model/ContainerInspectResponse.kt
 src/main/kotlin/de/gesellix/docker/engine/model/ContainerPruneResponse.kt
 src/main/kotlin/de/gesellix/docker/engine/model/ContainerState.kt
+src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummary.kt
+src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryHostConfig.kt
+src/main/kotlin/de/gesellix/docker/engine/model/ContainerSummaryNetworkSettings.kt
 src/main/kotlin/de/gesellix/docker/engine/model/ContainerTopResponse.kt
 src/main/kotlin/de/gesellix/docker/engine/model/ContainerUpdateResponse.kt
 src/main/kotlin/de/gesellix/docker/engine/model/ContainerWaitResponse.kt

engine-api-model/README.md

@@ -1,5 +1,23 @@
 # de.gesellix.docker.engine.client - Kotlin client library for Docker Engine API
 
+## Generate/update api sources
+
+The config from `openapi-generator-config.yaml` will be used via Gradle plugin:
+
+```shell
+./gradlew clean updateApiModelSource publishToMavenLocal -x signDockerApiModelPublication -x signDockerEnginePublication
+ ```
+
+Using the official OpenApi generator works like below. Please note that some customizations
+from the Gradle build script will be missing:
+
+```shell
+docker run --rm -it \
+  -v "${PWD}:/local" -w /local \
+  openapitools/openapi-generator-cli generate \
+  -c openapi-generator-config.yaml
+```
+
 ## Requires
 
 * Kotlin 1.4.30
@@ -145,6 +163,9 @@ Class | Method | HTTP request | Description
  - [de.gesellix.docker.engine.model.ContainerInspectResponse](docs/ContainerInspectResponse.md)
  - [de.gesellix.docker.engine.model.ContainerPruneResponse](docs/ContainerPruneResponse.md)
  - [de.gesellix.docker.engine.model.ContainerState](docs/ContainerState.md)
+ - [de.gesellix.docker.engine.model.ContainerSummary](docs/ContainerSummary.md)
+ - [de.gesellix.docker.engine.model.ContainerSummaryHostConfig](docs/ContainerSummaryHostConfig.md)
+ - [de.gesellix.docker.engine.model.ContainerSummaryNetworkSettings](docs/ContainerSummaryNetworkSettings.md)
  - [de.gesellix.docker.engine.model.ContainerTopResponse](docs/ContainerTopResponse.md)
  - [de.gesellix.docker.engine.model.ContainerUpdateResponse](docs/ContainerUpdateResponse.md)
  - [de.gesellix.docker.engine.model.ContainerWaitResponse](docs/ContainerWaitResponse.md)

engine-api-model/docker-engine-api-v1.41.yaml

@@ -1616,7 +1616,7 @@ definitions:
           type: "string"
       RepoDigests:
         type: "array"
-        x-nullable: false
+        x-nullable: true
         items:
           type: "string"
       Created:
@@ -1633,7 +1633,7 @@ definitions:
         x-nullable: false
       Labels:
         type: "object"
-        x-nullable: false
+        x-nullable: true
         additionalProperties:
           type: "string"
       Containers:
@@ -1706,7 +1706,7 @@ definitions:
       Labels:
         type: "object"
         description: "User-defined key/value metadata."
-        x-nullable: false
+        x-nullable: true
         additionalProperties:
           type: "string"
       Scope:
@@ -1719,6 +1719,7 @@ definitions:
         enum: ["local", "global"]
       Options:
         type: "object"
+        x-nullable: true
         description: |
           The driver specific options used when creating the volume.
         additionalProperties:
@@ -4022,73 +4023,71 @@ definitions:
       Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
 
   ContainerSummary:
-    type: "array"
-    items:
-      type: "object"
-      properties:
-        Id:
-          description: "The ID of this container"
-          type: "string"
-          x-go-name: "ID"
-        Names:
-          description: "The names that this container has been given"
-          type: "array"
-          items:
-            type: "string"
-        Image:
-          description: "The name of the image used when creating this container"
-          type: "string"
-        ImageID:
-          description: "The ID of the image that this container was created from"
+    type: "object"
+    properties:
+      Id:
+        description: "The ID of this container"
+        type: "string"
+        x-go-name: "ID"
+      Names:
+        description: "The names that this container has been given"
+        type: "array"
+        items:
           type: "string"
-        Command:
-          description: "Command to run when starting the container"
+      Image:
+        description: "The name of the image used when creating this container"
+        type: "string"
+      ImageID:
+        description: "The ID of the image that this container was created from"
+        type: "string"
+      Command:
+        description: "Command to run when starting the container"
+        type: "string"
+      Created:
+        description: "When the container was created"
+        type: "integer"
+        format: "int64"
+      Ports:
+        description: "The ports exposed by this container"
+        type: "array"
+        items:
+          $ref: "#/definitions/Port"
+      SizeRw:
+        description: "The size of files that have been created or changed by this container"
+        type: "integer"
+        format: "int64"
+      SizeRootFs:
+        description: "The total size of all the files in this container"
+        type: "integer"
+        format: "int64"
+      Labels:
+        description: "User-defined key/value metadata."
+        type: "object"
+        additionalProperties:
           type: "string"
-        Created:
-          description: "When the container was created"
-          type: "integer"
-          format: "int64"
-        Ports:
-          description: "The ports exposed by this container"
-          type: "array"
-          items:
-            $ref: "#/definitions/Port"
-        SizeRw:
-          description: "The size of files that have been created or changed by this container"
-          type: "integer"
-          format: "int64"
-        SizeRootFs:
-          description: "The total size of all the files in this container"
-          type: "integer"
-          format: "int64"
-        Labels:
-          description: "User-defined key/value metadata."
-          type: "object"
-          additionalProperties:
+      State:
+        description: "The state of this container (e.g. `Exited`)"
+        type: "string"
+      Status:
+        description: "Additional human-readable status of this container (e.g. `Exit 0`)"
+        type: "string"
+      HostConfig:
+        type: "object"
+        properties:
+          NetworkMode:
             type: "string"
-        State:
-          description: "The state of this container (e.g. `Exited`)"
-          type: "string"
-        Status:
-          description: "Additional human-readable status of this container (e.g. `Exit 0`)"
-          type: "string"
-        HostConfig:
-          type: "object"
-          properties:
-            NetworkMode:
-              type: "string"
-        NetworkSettings:
-          description: "A summary of the container's network settings"
-          type: "object"
-          properties:
-            Networks:
-              type: "object"
-              additionalProperties:
-                $ref: "#/definitions/EndpointSettings"
-        Mounts:
-          type: "array"
-          items:
-            $ref: "#/definitions/Mount"
+      NetworkSettings:
+        description: "A summary of the container's network settings"
+        type: "object"
+        properties:
+          Networks:
+            type: "object"
+            additionalProperties:
+              $ref: "#/definitions/EndpointSettings"
+      Mounts:
+        type: "array"
+        items:
+          $ref: "#/definitions/Mount"
 
   Driver:
     description: "Driver represents a driver (network, logging, secrets)."

engine-api-model/docs/ContainerChangeResponseItem.md

@@ -4,8 +4,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**path** | **kotlin.String** | Path to file that has changed |
-**kind** | **kotlin.Int** | Kind of change |
+**path** | **kotlin.String** | Path to file that has changed | 
+**kind** | **kotlin.Int** | Kind of change | 
 
 
 

engine-api-model/docs/ContainerCreateResponse.md

@@ -4,8 +4,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **kotlin.String** | The ID of the created container |
-**warnings** | **kotlin.collections.List<kotlin.String>** | Warnings encountered when creating the container |
+**id** | **kotlin.String** | The ID of the created container | 
+**warnings** | **kotlin.collections.List<kotlin.String>** | Warnings encountered when creating the container | 
 
 
 

engine-api-model/docs/ContainerSummary.md

@@ -0,0 +1,24 @@
+
+# ContainerSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **kotlin.String** | The ID of this container |  [optional]
+**names** | **kotlin.collections.List<kotlin.String>** | The names that this container has been given |  [optional]
+**image** | **kotlin.String** | The name of the image used when creating this container |  [optional]
+**imageID** | **kotlin.String** | The ID of the image that this container was created from |  [optional]
+**command** | **kotlin.String** | Command to run when starting the container |  [optional]
+**created** | **kotlin.Long** | When the container was created |  [optional]
+**ports** | [**kotlin.collections.List<Port>**](Port.md) | The ports exposed by this container |  [optional]
+**sizeRw** | **kotlin.Long** | The size of files that have been created or changed by this container |  [optional]
+**sizeRootFs** | **kotlin.Long** | The total size of all the files in this container |  [optional]
+**labels** | **kotlin.collections.Map<kotlin.String, kotlin.String>** | User-defined key/value metadata. |  [optional]
+**state** | **kotlin.String** | The state of this container (e.g. `Exited`) |  [optional]
+**status** | **kotlin.String** | Additional human-readable status of this container (e.g. `Exit 0`) |  [optional]
+**hostConfig** | [**ContainerSummaryHostConfig**](ContainerSummaryHostConfig.md) |  |  [optional]
+**networkSettings** | [**ContainerSummaryNetworkSettings**](ContainerSummaryNetworkSettings.md) |  |  [optional]
+**mounts** | [**kotlin.collections.List<Mount>**](Mount.md) |  |  [optional]
+
+
+

engine-api-model/docs/ContainerSummaryHostConfig.md

@@ -0,0 +1,10 @@
+
+# ContainerSummaryHostConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**networkMode** | **kotlin.String** |  |  [optional]
+
+
+

engine-api-model/docs/ContainerSummaryNetworkSettings.md

@@ -0,0 +1,10 @@
+
+# ContainerSummaryNetworkSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**networks** | [**kotlin.collections.Map<kotlin.String, EndpointSettings>**](EndpointSettings.md) |  |  [optional]
+
+
+

engine-api-model/docs/ContainerWaitResponse.md

@@ -4,7 +4,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**statusCode** | **kotlin.Int** | Exit code of the container |
+**statusCode** | **kotlin.Int** | Exit code of the container | 
 **error** | [**ContainerWaitResponseError**](ContainerWaitResponseError.md) |  |  [optional]
 
 

engine-api-model/docs/DistributionInspectResponse.md

@@ -4,8 +4,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**descriptor** | [**DistributionInspectResponseDescriptor**](DistributionInspectResponseDescriptor.md) |  |
-**platforms** | [**kotlin.collections.List<DistributionInspectResponsePlatforms>**](DistributionInspectResponsePlatforms.md) | An array containing all platforms supported by the image.  |
+**descriptor** | [**DistributionInspectResponseDescriptor**](DistributionInspectResponseDescriptor.md) |  | 
+**platforms** | [**kotlin.collections.List<DistributionInspectResponsePlatforms>**](DistributionInspectResponsePlatforms.md) | An array containing all platforms supported by the image.  |