feat: update docker api spec to v1.51 add validation to jane config

Author: Fahl-Design

.jane-openapi

@@ -2,7 +2,7 @@
 declare(strict_types=1);
 
 return [
-    'openapi-file'                  => __DIR__ . '/spec/docker-v1.48-patched.yaml',
+    'openapi-file'                  => __DIR__ . '/spec/docker-v1.51-patched.yaml',
     'namespace'                     => 'WebProject\DockerApi\Library\Generated',
     'directory'                     => __DIR__ . '/generated',
     'strict'                        => true,
@@ -11,5 +11,5 @@ return [
     'clean-generated'               => true,
     'reference'                     => true,
     'use-cacheable-supports-method' => true,
-    'validation'                    => false,
+    'validation'                    => true,
 ];

README.md

@@ -1,8 +1,8 @@
 # php-docker-api-client - A PHP docker API client
 
 
-## Based on Docker API Version spec [docker-v1.48.yaml](spec/docker-v1.48.yaml)
-> patched types from real world [docker-v1.48-patched.yaml](spec/docker-v1.48-patched.yaml) responses and minor code patches (WIP) 
+## Based on Docker API Version spec [docker-v1.51.yaml](spec/docker-v1.51.yaml)
+> converted to openapi v3.1.0 [docker-v1.51-patched.yaml](spec/docker-v1.51-patched.yaml) see  [UPDATE.md](spec/UPDATE.md) how to upgrade client
 
 ## Example
 ```shell

composer.json

@@ -46,6 +46,7 @@
     }
   },
   "scripts": {
-    "generate": "XDEBUG_MODE=off jane-openapi generate"
+    "generate": "XDEBUG_MODE=off jane-openapi generate",
+    "tests": "vendor/bin/codecept run"
   }
 }

generated/Client.php

@@ -1116,9 +1116,13 @@ public function imageTag(string $name, array $queryParameters = [], string $fetc
      * @param string $name            Image name or ID
      * @param array  $queryParameters {
      *
-     * @var bool $force Remove the image even if it is being used by stopped containers or has other tags
-     * @var bool $noprune Do not delete untagged parent images
-     *           }
+     * @var bool  $force Remove the image even if it is being used by stopped containers or has other tags
+     * @var bool  $noprune Do not delete untagged parent images
+     * @var array $platforms Select platform-specific content to delete.
+     *            Multiple values are accepted.
+     *            Each platform is a OCI platform encoded as a JSON string.
+     *
+     * }
      *
      * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
      *
@@ -1353,13 +1357,9 @@ public function systemDataUsage(array $queryParameters = [], string $fetch = sel
      *
      * ### Image tarball format
      *
-     * An image tarball contains one directory per image layer (named using its long ID), each containing these files:
-     *
-     * - `VERSION`: currently `1.0` - the file format version
-     * - `json`: detailed layer information, similar to `docker inspect layer_id`
-     * - `layer.tar`: A tarfile containing the filesystem changes in this layer
+     * An image tarball contains [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content).
      *
-     * The `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories for storing attribute changes and deletions.
+     * Additionally, includes the manifest.json file associated with a backwards compatible docker save format.
      *
      * If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs.
      *
@@ -1406,8 +1406,15 @@ public function imageGet(string $name, array $queryParameters = [], string $fetc
      *
      * @param array $queryParameters {
      *
-     * @var array $names Image names to filter by
-     *            }
+     * @var array  $names Image names to filter by
+     * @var string $platform JSON encoded OCI platform describing a platform which will be used
+     *             to select a platform-specific image to be saved if the image is
+     *             multi-platform.
+     *             If not provided, the full multi-platform image will be saved.
+     *
+     * Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
+     *
+     * }
      *
      * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
      *
@@ -2735,7 +2742,7 @@ public static function create($httpClient = null, array $additionalPlugins = [],
         if (null === $httpClient) {
             $httpClient = \Http\Discovery\Psr18ClientDiscovery::find();
             $plugins    = [];
-            $uri        = \Http\Discovery\Psr17FactoryDiscovery::findUriFactory()->createUri('/v1.48');
+            $uri        = \Http\Discovery\Psr17FactoryDiscovery::findUriFactory()->createUri('/v1.51');
             $plugins[]  = new \Http\Client\Common\Plugin\AddPathPlugin($uri);
             if (count($additionalPlugins) > 0) {
                 $plugins = array_merge($plugins, $additionalPlugins);

generated/Endpoint/ConfigDelete.php

@@ -50,6 +50,7 @@ protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $re
         $status = $response->getStatusCode();
         $body   = (string) $response->getBody();
         if (204 === $status) {
+            return null;
         }
         if ((null === $contentType) === false && (404 === $status && false !== mb_strpos($contentType, 'application/json'))) {
             throw new \WebProject\DockerApi\Library\Generated\Exception\ConfigDeleteNotFoundException($serializer->deserialize($body, 'WebProject\DockerApi\Library\Generated\Model\ErrorResponse', 'json'), $response);

generated/Endpoint/ConfigUpdate.php

@@ -86,6 +86,7 @@ protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $re
         $status = $response->getStatusCode();
         $body   = (string) $response->getBody();
         if (200 === $status) {
+            return null;
         }
         if ((null === $contentType) === false && (400 === $status && false !== mb_strpos($contentType, 'application/json'))) {
             throw new \WebProject\DockerApi\Library\Generated\Exception\ConfigUpdateBadRequestException($serializer->deserialize($body, 'WebProject\DockerApi\Library\Generated\Model\ErrorResponse', 'json'), $response);

generated/Endpoint/ContainerArchive.php

@@ -74,6 +74,7 @@ protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $re
         $status = $response->getStatusCode();
         $body   = (string) $response->getBody();
         if (200 === $status) {
+            return null;
         }
         if (400 === $status) {
         }

generated/Endpoint/ContainerArchiveInfo.php

@@ -78,6 +78,7 @@ protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $re
         $status = $response->getStatusCode();
         $body   = (string) $response->getBody();
         if (200 === $status) {
+            return null;
         }
         if ((null === $contentType) === false && (400 === $status && false !== mb_strpos($contentType, 'application/json'))) {
             throw new \WebProject\DockerApi\Library\Generated\Exception\ContainerArchiveInfoBadRequestException($serializer->deserialize($body, 'WebProject\DockerApi\Library\Generated\Model\ErrorResponse', 'json'), $response);

generated/Endpoint/ContainerAttach.php

@@ -186,8 +186,10 @@ protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $re
         $status = $response->getStatusCode();
         $body   = (string) $response->getBody();
         if (101 === $status) {
+            return null;
         }
         if (200 === $status) {
+            return null;
         }
         if (400 === $status) {
         }

generated/Endpoint/ContainerAttachWebsocket.php

@@ -86,8 +86,10 @@ protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $re
         $status = $response->getStatusCode();
         $body   = (string) $response->getBody();
         if (101 === $status) {
+            return null;
         }
         if (200 === $status) {
+            return null;
         }
         if ((null === $contentType) === false && (400 === $status && false !== mb_strpos($contentType, 'application/json'))) {
             throw new \WebProject\DockerApi\Library\Generated\Exception\ContainerAttachWebsocketBadRequestException($serializer->deserialize($body, 'WebProject\DockerApi\Library\Generated\Model\ErrorResponse', 'json'), $response);