docker-engine-ruby 0.3.0 → 0.4.0

data/rbi/docker_engine_ruby/models/secret.rbi

@@ -20,10 +20,10 @@ module DockerEngineRuby
       sig { params(id: String).void }
       attr_writer :id
 
-      sig { returns(T.nilable(DockerEngineRuby::Spec)) }
+      sig { returns(T.nilable(DockerEngineRuby::SecretSpec)) }
       attr_reader :spec
 
-      sig { params(spec: DockerEngineRuby::Spec::OrHash).void }
+      sig { params(spec: DockerEngineRuby::SecretSpec::OrHash).void }
       attr_writer :spec
 
       sig { returns(T.nilable(Time)) }
@@ -51,7 +51,7 @@ module DockerEngineRuby
         params(
           created_at: Time,
           id: String,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::SecretSpec::OrHash,
           updated_at: Time,
           version: DockerEngineRuby::Secret::Version::OrHash
         ).returns(T.attached_class)
@@ -79,7 +79,7 @@ module DockerEngineRuby
           {
             created_at: Time,
             id: String,
-            spec: DockerEngineRuby::Spec,
+            spec: DockerEngineRuby::SecretSpec,
             updated_at: Time,
             version: DockerEngineRuby::Secret::Version
           }

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/service.rbi

@@ -51,10 +51,10 @@ 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(Time)) }
@@ -96,7 +96,7 @@ module DockerEngineRuby
           id: String,
           job_status: DockerEngineRuby::Service::JobStatus::OrHash,
           service_status: DockerEngineRuby::Service::ServiceStatus::OrHash,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::ServiceSpec::OrHash,
           updated_at: Time,
           update_status: DockerEngineRuby::Service::UpdateStatus::OrHash,
           version: DockerEngineRuby::Service::Version::OrHash
@@ -140,7 +140,7 @@ module DockerEngineRuby
             id: String,
             job_status: DockerEngineRuby::Service::JobStatus,
             service_status: DockerEngineRuby::Service::ServiceStatus,
-            spec: DockerEngineRuby::Spec,
+            spec: DockerEngineRuby::ServiceSpec,
             updated_at: Time,
             update_status: DockerEngineRuby::Service::UpdateStatus,
             version: DockerEngineRuby::Service::Version

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