docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/models/secret_spec.rbi

@@ -0,0 +1,181 @@
+# typed: strong
+
+module DockerEngineRuby
+  module Models
+    class SecretSpec < DockerEngineRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineRuby::SecretSpec,
+            DockerEngineRuby::Internal::AnyHash
+          )
+        end
+
+      # Data is the data to store as a secret, formatted as a standard base64-encoded
+      # ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. It must be
+      # empty if the Driver field is set, in which case the data is loaded from an
+      # external secret store. The maximum allowed size is 500KB, as defined in
+      # [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+      sig { returns(T.nilable(String)) }
+      attr_reader :data
+
+      sig { params(data: String).void }
+      attr_writer :data
+
+      # Driver represents a driver (network, logging, secrets).
+      sig { returns(T.nilable(DockerEngineRuby::SecretSpec::Driver)) }
+      attr_reader :driver
+
+      sig { params(driver: DockerEngineRuby::SecretSpec::Driver::OrHash).void }
+      attr_writer :driver
+
+      # User-defined key/value metadata.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :labels
+
+      sig { params(labels: T::Hash[Symbol, String]).void }
+      attr_writer :labels
+
+      # User-defined name of the secret.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Driver represents a driver (network, logging, secrets).
+      sig { returns(T.nilable(DockerEngineRuby::SecretSpec::Templating)) }
+      attr_reader :templating
+
+      sig do
+        params(
+          templating: DockerEngineRuby::SecretSpec::Templating::OrHash
+        ).void
+      end
+      attr_writer :templating
+
+      sig do
+        params(
+          data: String,
+          driver: DockerEngineRuby::SecretSpec::Driver::OrHash,
+          labels: T::Hash[Symbol, String],
+          name: String,
+          templating: DockerEngineRuby::SecretSpec::Templating::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Data is the data to store as a secret, formatted as a standard base64-encoded
+        # ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. It must be
+        # empty if the Driver field is set, in which case the data is loaded from an
+        # external secret store. The maximum allowed size is 500KB, as defined in
+        # [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+        data: nil,
+        # Driver represents a driver (network, logging, secrets).
+        driver: nil,
+        # User-defined key/value metadata.
+        labels: nil,
+        # User-defined name of the secret.
+        name: nil,
+        # Driver represents a driver (network, logging, secrets).
+        templating: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: String,
+            driver: DockerEngineRuby::SecretSpec::Driver,
+            labels: T::Hash[Symbol, String],
+            name: String,
+            templating: DockerEngineRuby::SecretSpec::Templating
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Driver < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::SecretSpec::Driver,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        # Name of the driver.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Key/value map of driver-specific options.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :options
+
+        sig { params(options: T::Hash[Symbol, String]).void }
+        attr_writer :options
+
+        # Driver represents a driver (network, logging, secrets).
+        sig do
+          params(name: String, options: T::Hash[Symbol, String]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Name of the driver.
+          name:,
+          # Key/value map of driver-specific options.
+          options: nil
+        )
+        end
+
+        sig do
+          override.returns({ name: String, options: T::Hash[Symbol, String] })
+        end
+        def to_hash
+        end
+      end
+
+      class Templating < DockerEngineRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineRuby::SecretSpec::Templating,
+              DockerEngineRuby::Internal::AnyHash
+            )
+          end
+
+        # Name of the driver.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Key/value map of driver-specific options.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :options
+
+        sig { params(options: T::Hash[Symbol, String]).void }
+        attr_writer :options
+
+        # Driver represents a driver (network, logging, secrets).
+        sig do
+          params(name: String, options: T::Hash[Symbol, String]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Name of the driver.
+          name:,
+          # Key/value map of driver-specific options.
+          options: nil
+        )
+        end
+
+        sig do
+          override.returns({ name: String, options: T::Hash[Symbol, String] })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_ruby/models/secret_update_params.rbi

@@ -14,8 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # The version number of the secret object being updated. This is required to avoid
-      # conflicting writes.
       sig { returns(Integer) }
       attr_accessor :version
 
@@ -25,12 +23,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # The version number of the secret object being updated. This is required to avoid
-        # conflicting writes.
-        version:,
-        request_options: {}
-      )
+      def self.new(version:, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/service.rbi

@@ -8,10 +8,10 @@ module DockerEngineRuby
           T.any(DockerEngineRuby::Service, DockerEngineRuby::Internal::AnyHash)
         end
 
-      sig { returns(T.nilable(String)) }
+      sig { returns(T.nilable(Time)) }
       attr_reader :created_at
 
-      sig { params(created_at: String).void }
+      sig { params(created_at: Time).void }
       attr_writer :created_at
 
       sig { returns(T.nilable(DockerEngineRuby::Service::Endpoint)) }
@@ -51,16 +51,16 @@ module DockerEngineRuby
       attr_writer :service_status
 
       # User modifiable configuration for a service.
-      sig { returns(T.nilable(DockerEngineRuby::Spec)) }
+      sig { returns(T.nilable(DockerEngineRuby::ServiceSpec)) }
       attr_reader :spec
 
-      sig { params(spec: DockerEngineRuby::Spec::OrHash).void }
+      sig { params(spec: DockerEngineRuby::ServiceSpec::OrHash).void }
       attr_writer :spec
 
-      sig { returns(T.nilable(String)) }
+      sig { returns(T.nilable(Time)) }
       attr_reader :updated_at
 
-      sig { params(updated_at: String).void }
+      sig { params(updated_at: Time).void }
       attr_writer :updated_at
 
       # The status of a service update.
@@ -91,13 +91,13 @@ module DockerEngineRuby
 
       sig do
         params(
-          created_at: String,
+          created_at: Time,
           endpoint: DockerEngineRuby::Service::Endpoint::OrHash,
           id: String,
           job_status: DockerEngineRuby::Service::JobStatus::OrHash,
           service_status: DockerEngineRuby::Service::ServiceStatus::OrHash,
-          spec: DockerEngineRuby::Spec::OrHash,
-          updated_at: String,
+          spec: DockerEngineRuby::ServiceSpec::OrHash,
+          updated_at: Time,
           update_status: DockerEngineRuby::Service::UpdateStatus::OrHash,
           version: DockerEngineRuby::Service::Version::OrHash
         ).returns(T.attached_class)
@@ -135,13 +135,13 @@ module DockerEngineRuby
       sig do
         override.returns(
           {
-            created_at: String,
+            created_at: Time,
             endpoint: DockerEngineRuby::Service::Endpoint,
             id: String,
             job_status: DockerEngineRuby::Service::JobStatus,
             service_status: DockerEngineRuby::Service::ServiceStatus,
-            spec: DockerEngineRuby::Spec,
-            updated_at: String,
+            spec: DockerEngineRuby::ServiceSpec,
+            updated_at: Time,
             update_status: DockerEngineRuby::Service::UpdateStatus,
             version: DockerEngineRuby::Service::Version
           }
@@ -799,11 +799,10 @@ module DockerEngineRuby
         end
         attr_writer :job_iteration
 
-        # The last time, as observed by the server, that this job was started.
-        sig { returns(T.nilable(String)) }
+        sig { returns(T.nilable(Time)) }
         attr_reader :last_execution
 
-        sig { params(last_execution: String).void }
+        sig { params(last_execution: Time).void }
         attr_writer :last_execution
 
         # The status of the service when it is in one of ReplicatedJob or GlobalJob modes.
@@ -814,7 +813,7 @@ module DockerEngineRuby
           params(
             job_iteration:
               DockerEngineRuby::Service::JobStatus::JobIteration::OrHash,
-            last_execution: String
+            last_execution: Time
           ).returns(T.attached_class)
         end
         def self.new(
@@ -828,7 +827,6 @@ module DockerEngineRuby
           # of the requests can succeed. As a result, two separate update requests that
           # happen at the same time will not unintentionally overwrite each other.
           job_iteration: nil,
-          # The last time, as observed by the server, that this job was started.
           last_execution: nil
         )
         end
@@ -837,7 +835,7 @@ module DockerEngineRuby
           override.returns(
             {
               job_iteration: DockerEngineRuby::Service::JobStatus::JobIteration,
-              last_execution: String
+              last_execution: Time
             }
           )
         end
@@ -887,27 +885,18 @@ module DockerEngineRuby
             )
           end
 
-        # The number of tasks for a job that are in the Completed state. This field must
-        # be cross-referenced with the service type, as the value of 0 may mean the
-        # service is not in a job mode, or it may mean the job-mode service has no tasks
-        # yet Completed.
         sig { returns(T.nilable(Integer)) }
         attr_reader :completed_tasks
 
         sig { params(completed_tasks: Integer).void }
         attr_writer :completed_tasks
 
-        # The number of tasks for the service desired to be running. For replicated
-        # services, this is the replica count from the service spec. For global services,
-        # this is computed by taking count of all tasks for the service with a Desired
-        # State other than Shutdown.
         sig { returns(T.nilable(Integer)) }
         attr_reader :desired_tasks
 
         sig { params(desired_tasks: Integer).void }
         attr_writer :desired_tasks
 
-        # The number of tasks for the service currently in the Running state.
         sig { returns(T.nilable(Integer)) }
         attr_reader :running_tasks
 
@@ -924,17 +913,8 @@ module DockerEngineRuby
           ).returns(T.attached_class)
         end
         def self.new(
-          # The number of tasks for a job that are in the Completed state. This field must
-          # be cross-referenced with the service type, as the value of 0 may mean the
-          # service is not in a job mode, or it may mean the job-mode service has no tasks
-          # yet Completed.
           completed_tasks: nil,
-          # The number of tasks for the service desired to be running. For replicated
-          # services, this is the replica count from the service spec. For global services,
-          # this is computed by taking count of all tasks for the service with a Desired
-          # State other than Shutdown.
           desired_tasks: nil,
-          # The number of tasks for the service currently in the Running state.
           running_tasks: nil
         )
         end
@@ -961,10 +941,10 @@ module DockerEngineRuby
             )
           end
 
-        sig { returns(T.nilable(String)) }
+        sig { returns(T.nilable(Time)) }
         attr_reader :completed_at
 
-        sig { params(completed_at: String).void }
+        sig { params(completed_at: Time).void }
         attr_writer :completed_at
 
         sig { returns(T.nilable(String)) }
@@ -973,10 +953,10 @@ module DockerEngineRuby
         sig { params(message: String).void }
         attr_writer :message
 
-        sig { returns(T.nilable(String)) }
+        sig { returns(T.nilable(Time)) }
         attr_reader :started_at
 
-        sig { params(started_at: String).void }
+        sig { params(started_at: Time).void }
         attr_writer :started_at
 
         sig do
@@ -998,9 +978,9 @@ module DockerEngineRuby
         # The status of a service update.
         sig do
           params(
-            completed_at: String,
+            completed_at: Time,
             message: String,
-            started_at: String,
+            started_at: Time,
             state: DockerEngineRuby::Service::UpdateStatus::State::OrSymbol
           ).returns(T.attached_class)
         end
@@ -1015,9 +995,9 @@ module DockerEngineRuby
         sig do
           override.returns(
             {
-              completed_at: String,
+              completed_at: Time,
               message: String,
-              started_at: String,
+              started_at: Time,
               state:
                 DockerEngineRuby::Service::UpdateStatus::State::TaggedSymbol
             }

data/rbi/docker_engine_ruby/models/service_create_params.rbi

@@ -14,15 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # User modifiable configuration for a service.
-      sig { returns(DockerEngineRuby::ServiceCreateParams::Spec) }
-      attr_reader :spec
-
-      sig do
-        params(spec: DockerEngineRuby::ServiceCreateParams::Spec::OrHash).void
-      end
-      attr_writer :spec
-
       sig { returns(T.nilable(String)) }
       attr_reader :x_registry_auth
 
@@ -31,23 +22,16 @@ module DockerEngineRuby
 
       sig do
         params(
-          spec: DockerEngineRuby::ServiceCreateParams::Spec::OrHash,
           x_registry_auth: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # User modifiable configuration for a service.
-        spec:,
-        x_registry_auth: nil,
-        request_options: {}
-      )
+      def self.new(x_registry_auth: nil, request_options: {})
       end
 
       sig do
         override.returns(
           {
-            spec: DockerEngineRuby::ServiceCreateParams::Spec,
             x_registry_auth: String,
             request_options: DockerEngineRuby::RequestOptions
           }
@@ -55,25 +39,6 @@ module DockerEngineRuby
       end
       def to_hash
       end
-
-      class Spec < DockerEngineRuby::Models::Spec
-        OrHash =
-          T.type_alias do
-            T.any(
-              DockerEngineRuby::ServiceCreateParams::Spec,
-              DockerEngineRuby::Internal::AnyHash
-            )
-          end
-
-        # User modifiable configuration for a service.
-        sig { returns(T.attached_class) }
-        def self.new
-        end
-
-        sig { override.returns({}) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/docker_engine_ruby/models/service_create_response.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module DockerEngineRuby
+  module Models
+    class ServiceCreateResponse < DockerEngineRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineRuby::ServiceCreateResponse,
+            DockerEngineRuby::Internal::AnyHash
+          )
+        end
+
+      # The ID of the created service.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Optional warning message.
+      #
+      # FIXME(thaJeztah): this should have "omitempty" in the generated type.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :warnings
+
+      # contains the information returned to a client on the creation of a new service.
+      sig do
+        params(id: String, warnings: T.nilable(T::Array[String])).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # The ID of the created service.
+        id: nil,
+        # Optional warning message.
+        #
+        # FIXME(thaJeztah): this should have "omitempty" in the generated type.
+        warnings: nil
+      )
+      end
+
+      sig do
+        override.returns({ id: String, warnings: T.nilable(T::Array[String]) })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_ruby/models/service_inspect_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Fill empty fields with default values.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :insert_defaults
 
@@ -27,11 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Fill empty fields with default values.
-        insert_defaults: nil,
-        request_options: {}
-      )
+      def self.new(insert_defaults: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/service_list_params.rbi

@@ -14,22 +14,12 @@ module DockerEngineRuby
           )
         end
 
-      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      # services list.
-      #
-      # Available filters:
-      #
-      # - `id=<service id>`
-      # - `label=<service label>`
-      # - `mode=["replicated"|"global"]`
-      # - `name=<service name>`
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
       sig { params(filters: String).void }
       attr_writer :filters
 
-      # Include service status, with count of running and desired tasks.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :status
 
@@ -43,21 +33,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # services list.
-        #
-        # Available filters:
-        #
-        # - `id=<service id>`
-        # - `label=<service label>`
-        # - `mode=["replicated"|"global"]`
-        # - `name=<service name>`
-        filters: nil,
-        # Include service status, with count of running and desired tasks.
-        status: nil,
-        request_options: {}
-      )
+      def self.new(filters: nil, status: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/service_logs_params.rbi

@@ -14,50 +14,42 @@ module DockerEngineRuby
           )
         end
 
-      # Show service context and extra details provided to logs.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :details
 
       sig { params(details: T::Boolean).void }
       attr_writer :details
 
-      # Keep connection after returning logs.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :follow
 
       sig { params(follow: T::Boolean).void }
       attr_writer :follow
 
-      # Only return logs since this time, as a UNIX timestamp
       sig { returns(T.nilable(Integer)) }
       attr_reader :since
 
       sig { params(since: Integer).void }
       attr_writer :since
 
-      # Return logs from `stderr`
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :stderr
 
       sig { params(stderr: T::Boolean).void }
       attr_writer :stderr
 
-      # Return logs from `stdout`
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :stdout
 
       sig { params(stdout: T::Boolean).void }
       attr_writer :stdout
 
-      # Only return this number of log lines from the end of the logs. Specify as an
-      # integer or `all` to output all log lines.
       sig { returns(T.nilable(String)) }
       attr_reader :tail
 
       sig { params(tail: String).void }
       attr_writer :tail
 
-      # Add timestamps to every log line
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :timestamps
 
@@ -77,20 +69,12 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Show service context and extra details provided to logs.
         details: nil,
-        # Keep connection after returning logs.
         follow: nil,
-        # Only return logs since this time, as a UNIX timestamp
         since: nil,
-        # Return logs from `stderr`
         stderr: nil,
-        # Return logs from `stdout`
         stdout: nil,
-        # Only return this number of log lines from the end of the logs. Specify as an
-        # integer or `all` to output all log lines.
         tail: nil,
-        # Add timestamps to every log line
         timestamps: nil,
         request_options: {}
       )