docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/service_create_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ServiceCreateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ServiceCreateParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # User modifiable configuration for a service.
+      sig { returns(DockerEngineAPI::ServiceCreateParams::Spec) }
+      attr_reader :spec
+
+      sig do
+        params(spec: DockerEngineAPI::ServiceCreateParams::Spec::OrHash).void
+      end
+      attr_writer :spec
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_registry_auth
+
+      sig { params(x_registry_auth: String).void }
+      attr_writer :x_registry_auth
+
+      sig do
+        params(
+          spec: DockerEngineAPI::ServiceCreateParams::Spec::OrHash,
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # User modifiable configuration for a service.
+        spec:,
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            spec: DockerEngineAPI::ServiceCreateParams::Spec,
+            x_registry_auth: String,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Spec < DockerEngineAPI::Models::Spec
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineAPI::ServiceCreateParams::Spec,
+              DockerEngineAPI::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_api/models/service_delete_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ServiceDeleteParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ServiceDeleteParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngineAPI::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/service_inspect_params.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ServiceInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ServiceInspectParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Fill empty fields with default values.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :insert_defaults
+
+      sig { params(insert_defaults: T::Boolean).void }
+      attr_writer :insert_defaults
+
+      sig do
+        params(
+          insert_defaults: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Fill empty fields with default values.
+        insert_defaults: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            insert_defaults: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/service_list_params.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ServiceListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ServiceListParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        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
+
+      sig { params(status: T::Boolean).void }
+      attr_writer :status
+
+      sig do
+        params(
+          filters: String,
+          status: T::Boolean,
+          request_options: DockerEngineAPI::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: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            filters: String,
+            status: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/service_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    ServiceListResponse =
+      T.let(
+        DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Service],
+        DockerEngineAPI::Internal::Type::Converter
+      )
+  end
+end

data/rbi/docker_engine_api/models/service_logs_params.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ServiceLogsParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ServiceLogsParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        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
+
+      sig { params(timestamps: T::Boolean).void }
+      attr_writer :timestamps
+
+      sig do
+        params(
+          details: T::Boolean,
+          follow: T::Boolean,
+          since: Integer,
+          stderr: T::Boolean,
+          stdout: T::Boolean,
+          tail: String,
+          timestamps: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).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: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            details: T::Boolean,
+            follow: T::Boolean,
+            since: Integer,
+            stderr: T::Boolean,
+            stdout: T::Boolean,
+            tail: String,
+            timestamps: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/service_update_params.rbi

@@ -0,0 +1,168 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ServiceUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ServiceUpdateParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The version number of the service object being updated. This is required to
+      # avoid conflicting writes. This version number should be the value as currently
+      # set on the service _before_ the update. You can find the current version by
+      # calling `GET /services/{id}`
+      sig { returns(Integer) }
+      attr_accessor :version
+
+      # User modifiable configuration for a service.
+      sig { returns(DockerEngineAPI::ServiceUpdateParams::Spec) }
+      attr_reader :spec
+
+      sig do
+        params(spec: DockerEngineAPI::ServiceUpdateParams::Spec::OrHash).void
+      end
+      attr_writer :spec
+
+      # If the `X-Registry-Auth` header is not specified, this parameter indicates where
+      # to find registry authorization credentials.
+      sig do
+        returns(
+          T.nilable(
+            DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::OrSymbol
+          )
+        )
+      end
+      attr_reader :registry_auth_from
+
+      sig do
+        params(
+          registry_auth_from:
+            DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::OrSymbol
+        ).void
+      end
+      attr_writer :registry_auth_from
+
+      # Set to this parameter to `previous` to cause a server-side rollback to the
+      # previous service spec. The supplied spec will be ignored in this case.
+      sig { returns(T.nilable(String)) }
+      attr_reader :rollback
+
+      sig { params(rollback: String).void }
+      attr_writer :rollback
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_registry_auth
+
+      sig { params(x_registry_auth: String).void }
+      attr_writer :x_registry_auth
+
+      sig do
+        params(
+          version: Integer,
+          spec: DockerEngineAPI::ServiceUpdateParams::Spec::OrHash,
+          registry_auth_from:
+            DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::OrSymbol,
+          rollback: String,
+          x_registry_auth: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The version number of the service object being updated. This is required to
+        # avoid conflicting writes. This version number should be the value as currently
+        # set on the service _before_ the update. You can find the current version by
+        # calling `GET /services/{id}`
+        version:,
+        # User modifiable configuration for a service.
+        spec:,
+        # If the `X-Registry-Auth` header is not specified, this parameter indicates where
+        # to find registry authorization credentials.
+        registry_auth_from: nil,
+        # Set to this parameter to `previous` to cause a server-side rollback to the
+        # previous service spec. The supplied spec will be ignored in this case.
+        rollback: nil,
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            version: Integer,
+            spec: DockerEngineAPI::ServiceUpdateParams::Spec,
+            registry_auth_from:
+              DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::OrSymbol,
+            rollback: String,
+            x_registry_auth: String,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Spec < DockerEngineAPI::Models::Spec
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineAPI::ServiceUpdateParams::Spec,
+              DockerEngineAPI::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
+
+      # If the `X-Registry-Auth` header is not specified, this parameter indicates where
+      # to find registry authorization credentials.
+      module RegistryAuthFrom
+        extend DockerEngineAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SPEC =
+          T.let(
+            :spec,
+            DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::TaggedSymbol
+          )
+        PREVIOUS_SPEC =
+          T.let(
+            :"previous-spec",
+            DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              DockerEngineAPI::ServiceUpdateParams::RegistryAuthFrom::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end