feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 102
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Fdocker-7dbd508c79cf09803a2a05ee36b55ae9219a6218f0637891b33e1ac25db10b5d.yml
-openapi_spec_hash: 16948cc9b83def4e333889ca4e0497f3
-config_hash: a0d02ef4b296f2f9edd1fffc571fe475
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Fdocker-7c27e60683f553b522c94b55041ccbc74513c0149abef7c85c313c18aba4132a.yml
+openapi_spec_hash: 2a49592907fe275ad63f5caca002f67d
+config_hash: 6c8d41e69c7e4032b23f6adbe9fc9a81

lib/docker_engine_ruby/client.rb

@@ -20,6 +20,19 @@ class Client < DockerEngineRuby::Internal::Transport::BaseClient
     ENVIRONMENTS = {production: "http://localhost:2375", production_tls: "https://localhost:2376"}
     # rubocop:enable Style/MutableConstant
 
+    # Path to the trusted CA certificate file (PEM) used to verify the Docker daemon
+    # certificate.
+    # @return [String, nil]
+    attr_reader :tls_ca_cert_path
+
+    # Path to the client TLS certificate file (PEM).
+    # @return [String, nil]
+    attr_reader :tls_client_cert_path
+
+    # Path to the client TLS private key file (PEM).
+    # @return [String, nil]
+    attr_reader :tls_client_key_path
+
     # @return [DockerEngineRuby::Resources::Auth]
     attr_reader :auth
 
@@ -67,6 +80,15 @@ class Client < DockerEngineRuby::Internal::Transport::BaseClient
 
     # Creates and returns a new client for interacting with the API.
     #
+    # @param tls_ca_cert_path [String, nil] Path to the trusted CA certificate file (PEM) used to verify the Docker daemon
+    # certificate. Defaults to `ENV["DOCKER_TLS_CA_CERT_PATH"]`
+    #
+    # @param tls_client_cert_path [String, nil] Path to the client TLS certificate file (PEM). Defaults to
+    # `ENV["DOCKER_TLS_CLIENT_CERT_PATH"]`
+    #
+    # @param tls_client_key_path [String, nil] Path to the client TLS private key file (PEM). Defaults to
+    # `ENV["DOCKER_TLS_CLIENT_KEY_PATH"]`
+    #
     # @param environment [:production, :production_tls, nil] Specifies the environment to use for the API.
     #
     # Each environment maps to a different base URL:
@@ -85,6 +107,9 @@ class Client < DockerEngineRuby::Internal::Transport::BaseClient
     #
     # @param max_retry_delay [Float]
     def initialize(
+      tls_ca_cert_path: ENV["DOCKER_TLS_CA_CERT_PATH"],
+      tls_client_cert_path: ENV["DOCKER_TLS_CLIENT_CERT_PATH"],
+      tls_client_key_path: ENV["DOCKER_TLS_CLIENT_KEY_PATH"],
       environment: nil,
       base_url: ENV["DOCKER_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
@@ -97,6 +122,10 @@ def initialize(
         raise ArgumentError.new(message)
       end
 
+      @tls_ca_cert_path = tls_ca_cert_path&.to_s
+      @tls_client_cert_path = tls_client_cert_path&.to_s
+      @tls_client_key_path = tls_client_key_path&.to_s
+
       super(
         base_url: base_url,
         timeout: timeout,

lib/docker_engine_ruby/models/config.rb

@@ -62,11 +62,8 @@ class Config < DockerEngineRuby::Internal::Type::BaseModel
       #
       #   `{"<port>/<tcp|udp|sctp>": {}}`
       #
-      #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-      optional :exposed_ports,
-               DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown]],
-               api_name: :ExposedPorts,
-               nil?: true
+      #   @return [Object, nil]
+      optional :exposed_ports, DockerEngineRuby::Internal::Type::Unknown, api_name: :ExposedPorts, nil?: true
 
       # @!attribute healthcheck
       #   A test to perform to check that the container is healthy. Healthcheck commands
@@ -91,8 +88,8 @@ class Config < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute labels
       #   User-defined key/value metadata.
       #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+      #   @return [Object, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::Unknown, api_name: :Labels
 
       # @!attribute network_disabled
       #   Disable networking for the container.
@@ -158,10 +155,8 @@ class Config < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute volumes
       #   An object mapping mount point paths inside the container to empty objects.
       #
-      #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-      optional :volumes,
-               DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown]],
-               api_name: :Volumes
+      #   @return [Object, nil]
+      optional :volumes, DockerEngineRuby::Internal::Type::Unknown, api_name: :Volumes
 
       # @!attribute working_dir
       #   The working directory for commands to run in.
@@ -191,15 +186,15 @@ class Config < DockerEngineRuby::Internal::Type::BaseModel
       #
       #   @param env [Array<String>] A list of environment variables to set inside the container in the
       #
-      #   @param exposed_ports [Hash{Symbol=>Hash{Symbol=>Object}}, nil] An object mapping ports to an empty object in the form:
+      #   @param exposed_ports [Object, nil] An object mapping ports to an empty object in the form:
       #
       #   @param healthcheck [DockerEngineRuby::Models::Config::Healthcheck] A test to perform to check that the container is healthy.
       #
       #   @param hostname [String] The hostname to use for the container, as a valid RFC 1123 hostname.
       #
       #   @param image [String] The name (or reference) of the image to use when creating the container,
       #
-      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #   @param labels [Object] User-defined key/value metadata.
       #
       #   @param network_disabled [Boolean, nil] Disable networking for the container.
       #
@@ -219,7 +214,7 @@ class Config < DockerEngineRuby::Internal::Type::BaseModel
       #
       #   @param user [String] Commands run as this user inside the container. If omitted, commands
       #
-      #   @param volumes [Hash{Symbol=>Hash{Symbol=>Object}}] An object mapping mount point paths inside the container to empty
+      #   @param volumes [Object] An object mapping mount point paths inside the container to empty
       #
       #   @param working_dir [String] The working directory for commands to run in.
 

lib/docker_engine_ruby/models/config_spec.rb

@@ -15,8 +15,8 @@ class ConfigSpec < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute labels
       #   User-defined key/value metadata.
       #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+      #   @return [Object, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::Unknown, api_name: :Labels
 
       # @!attribute name
       #   User-defined name of the config.
@@ -36,7 +36,7 @@ class ConfigSpec < DockerEngineRuby::Internal::Type::BaseModel
       #
       #   @param data [String] Data is the data to store as a config, formatted as a standard base64-encoded
       #
-      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #   @param labels [Object] User-defined key/value metadata.
       #
       #   @param name [String] User-defined name of the config.
       #
@@ -53,15 +53,15 @@ class Templating < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute options
         #   Key/value map of driver-specific options.
         #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+        #   @return [Object, nil]
+        optional :options, DockerEngineRuby::Internal::Type::Unknown, api_name: :Options
 
         # @!method initialize(name:, options: nil)
         #   Driver represents a driver (network, logging, secrets).
         #
         #   @param name [String] Name of the driver.
         #
-        #   @param options [Hash{Symbol=>String}] Key/value map of driver-specific options.
+        #   @param options [Object] Key/value map of driver-specific options.
       end
     end
   end

lib/docker_engine_ruby/models/connect_request.rb

@@ -49,11 +49,8 @@ class EndpointConfig < DockerEngineRuby::Internal::Type::BaseModel
         #   DriverOpts is a mapping of driver options and values. These options are passed
         #   directly to the driver and are driver specific.
         #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :driver_opts,
-                 DockerEngineRuby::Internal::Type::HashOf[String],
-                 api_name: :DriverOpts,
-                 nil?: true
+        #   @return [Object, nil]
+        optional :driver_opts, DockerEngineRuby::Internal::Type::Unknown, api_name: :DriverOpts, nil?: true
 
         # @!attribute endpoint_id
         #   Unique ID for the service endpoint in a Sandbox.
@@ -142,7 +139,7 @@ class EndpointConfig < DockerEngineRuby::Internal::Type::BaseModel
         #
         #   @param dns_names [Array<String>] List of all DNS names an endpoint has on a specific network. This
         #
-        #   @param driver_opts [Hash{Symbol=>String}, nil] DriverOpts is a mapping of driver options and values. These options
+        #   @param driver_opts [Object, nil] DriverOpts is a mapping of driver options and values. These options
         #
         #   @param endpoint_id [String] Unique ID for the service endpoint in a Sandbox.
         #