docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/resources/swarm.rbi

@@ -7,7 +7,7 @@ module DockerEngineRuby
       sig do
         params(
           version: Integer,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::SwarmSpec::OrHash,
           rotate_manager_token: T::Boolean,
           rotate_manager_unlock_key: T::Boolean,
           rotate_worker_token: T::Boolean,
@@ -15,16 +15,15 @@ module DockerEngineRuby
         ).void
       end
       def update(
-        # Query param: The version number of the swarm object being updated. This is
-        # required to avoid conflicting writes.
+        # Query param
         version:,
         # Body param: User modifiable swarm configuration.
         spec:,
-        # Query param: Rotate the manager join token.
+        # Query param
         rotate_manager_token: nil,
-        # Query param: Rotate the manager unlock key.
+        # Query param
         rotate_manager_unlock_key: nil,
-        # Query param: Rotate the worker join token.
+        # Query param
         rotate_worker_token: nil,
         request_options: {}
       )
@@ -39,45 +38,20 @@ module DockerEngineRuby
           default_addr_pool: T::Array[String],
           force_new_cluster: T::Boolean,
           listen_addr: String,
-          spec: DockerEngineRuby::Spec::OrHash,
+          spec: DockerEngineRuby::SwarmSpec::OrHash,
           subnet_size: Integer,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(String)
       end
       def init(
-        # Externally reachable address advertised to other nodes. This can either be an
-        # address/port combination in the form `192.168.1.1:4567`, or an interface
-        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-        # port number from the listen address is used. If `AdvertiseAddr` is not
-        # specified, it will be automatically detected when possible.
         advertise_addr: nil,
-        # Address or interface to use for data path traffic (format: `<ip|interface>`),
-        # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
-        # unspecified, the same address as `AdvertiseAddr` is used.
-        #
-        # The `DataPathAddr` specifies the address that global scope network drivers will
-        # publish towards other nodes in order to reach the containers running on this
-        # node. Using this parameter it is possible to separate the container data traffic
-        # from the management traffic of the cluster.
         data_path_addr: nil,
-        # DataPathPort specifies the data path port number for data traffic. Acceptable
-        # port range is 1024 to 49151. if no port is set or is set to 0, default port 4789
-        # will be used.
         data_path_port: nil,
-        # Default Address Pool specifies default subnet pools for global scope networks.
         default_addr_pool: nil,
-        # Force creation of a new swarm.
         force_new_cluster: nil,
-        # Listen address used for inter-manager communication, as well as determining the
-        # networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either
-        # be an address/port combination in the form `192.168.1.1:4567`, or an interface
-        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-        # default swarm listening port is used.
         listen_addr: nil,
         # User modifiable swarm configuration.
         spec: nil,
-        # SubnetSize specifies the subnet size of the networks created from the default
-        # subnet pool.
         subnet_size: nil,
         request_options: {}
       )
@@ -104,28 +78,10 @@ module DockerEngineRuby
         ).void
       end
       def join(
-        # Externally reachable address advertised to other nodes. This can either be an
-        # address/port combination in the form `192.168.1.1:4567`, or an interface
-        # followed by a port number, like `eth0:4567`. If the port number is omitted, the
-        # port number from the listen address is used. If `AdvertiseAddr` is not
-        # specified, it will be automatically detected when possible.
         advertise_addr: nil,
-        # Address or interface to use for data path traffic (format: `<ip|interface>`),
-        # for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
-        # unspecified, the same address as `AdvertiseAddr` is used.
-        #
-        # The `DataPathAddr` specifies the address that global scope network drivers will
-        # publish towards other nodes in order to reach the containers running on this
-        # node. Using this parameter it is possible to separate the container data traffic
-        # from the management traffic of the cluster.
         data_path_addr: nil,
-        # Secret token for joining this swarm.
         join_token: nil,
-        # Listen address used for inter-manager communication if the node gets promoted to
-        # manager, as well as determining the networking interface used for the VXLAN
-        # Tunnel Endpoint (VTEP).
         listen_addr: nil,
-        # Addresses of manager nodes already participating in the swarm.
         remote_addrs: nil,
         request_options: {}
       )
@@ -138,12 +94,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def leave(
-        # Force leave swarm, even if this is the last manager or that it will break the
-        # cluster.
-        force: nil,
-        request_options: {}
-      )
+      def leave(force: nil, request_options: {})
       end
 
       # Unlock a locked manager
@@ -153,11 +104,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def unlock(
-        # The swarm's unlock key.
-        unlock_key: nil,
-        request_options: {}
-      )
+      def unlock(unlock_key: nil, request_options: {})
       end
 
       # Get the unlock key

data/rbi/docker_engine_ruby/resources/system.rbi

@@ -7,49 +7,20 @@ module DockerEngineRuby
       sig do
         params(
           type:
-            T::Array[DockerEngineRuby::SystemDataUsageParams::Type::OrSymbol],
+            T.any(
+              DockerEngineRuby::SystemDataUsageParams::Type::OrSymbol,
+              T::Array[
+                DockerEngineRuby::SystemDataUsageParams::Type::UnionMember1::OrSymbol
+              ]
+            ),
           verbose: T::Boolean,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::SystemDataUsageResponse)
       end
-      def data_usage(
-        # Object types, for which to compute and return data.
-        type: nil,
-        # Show detailed information on space usage.
-        verbose: nil,
-        request_options: {}
-      )
+      def data_usage(type: nil, verbose: nil, request_options: {})
       end
 
-      # Stream real-time events from the server.
-      #
-      # Various objects within Docker report events when something happens to them.
-      #
-      # Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`,
-      # `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`,
-      # `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`,
-      # `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`
-      #
-      # Images report these events: `create`, `delete`, `import`, `load`, `pull`,
-      # `push`, `save`, `tag`, `untag`, and `prune`
-      #
-      # Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and
-      # `prune`
-      #
-      # Networks report these events: `create`, `connect`, `disconnect`, `destroy`,
-      # `update`, `remove`, and `prune`
-      #
-      # The Docker daemon reports these events: `reload`
-      #
-      # Services report these events: `create`, `update`, and `remove`
-      #
-      # Nodes report these events: `create`, `update`, and `remove`
-      #
-      # Secrets report these events: `create`, `update`, and `remove`
-      #
-      # Configs report these events: `create`, `update`, and `remove`
-      #
-      # The Builder reports `prune` events
+      # Monitor events
       sig do
         params(
           filters: String,
@@ -58,32 +29,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::SystemEventsResponse)
       end
-      def events(
-        # A JSON encoded value of filters (a `map[string][]string`) to process on the
-        # event list. Available filters:
-        #
-        # - `config=<string>` config name or ID
-        # - `container=<string>` container name or ID
-        # - `daemon=<string>` daemon name or ID
-        # - `event=<string>` event type
-        # - `image=<string>` image name or ID
-        # - `label=<string>` image or container label
-        # - `network=<string>` network name or ID
-        # - `node=<string>` node ID
-        # - `plugin`=<string> plugin name or ID
-        # - `scope`=<string> local or swarm
-        # - `secret=<string>` secret name or ID
-        # - `service=<string>` service name or ID
-        # - `type=<string>` object to filter by, one of `container`, `image`, `volume`,
-        #   `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`
-        # - `volume=<string>` volume name
-        filters: nil,
-        # Show events created since this timestamp then stream new events.
-        since: nil,
-        # Show events created until this timestamp then stop streaming.
-        until_: nil,
-        request_options: {}
-      )
+      def events(filters: nil, since: nil, until_: nil, request_options: {})
       end
 
       # Get system information
@@ -95,7 +41,7 @@ module DockerEngineRuby
       def info(request_options: {})
       end
 
-      # This is a dummy endpoint you can use to test if the server is accessible.
+      # Ping
       sig do
         params(
           request_options: DockerEngineRuby::RequestOptions::OrHash
@@ -104,8 +50,7 @@ module DockerEngineRuby
       def ping(request_options: {})
       end
 
-      # Returns the version of Docker that is running and various information about the
-      # system that Docker is running on.
+      # Get version
       sig do
         params(
           request_options: DockerEngineRuby::RequestOptions::OrHash

data/rbi/docker_engine_ruby/resources/tasks.rbi

@@ -10,21 +10,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T::Array[DockerEngineRuby::Task])
       end
-      def list(
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # tasks list.
-        #
-        # Available filters:
-        #
-        # - `desired-state=(running | shutdown | accepted)`
-        # - `id=<task id>`
-        # - `label=key` or `label="key=value"`
-        # - `name=<task name>`
-        # - `node=<node id or name>`
-        # - `service=<service name>`
-        filters: nil,
-        request_options: {}
-      )
+      def list(filters: nil, request_options: {})
       end
 
       # Inspect a task
@@ -34,18 +20,10 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Task)
       end
-      def inspect_(
-        # ID of the task
-        id,
-        request_options: {}
-      )
+      def inspect_(id, request_options: {})
       end
 
-      # Get `stdout` and `stderr` logs from a task. See also
-      # [`/containers/{id}/logs`](#operation/ContainerLogs).
-      #
-      # **Note**: This endpoint works only for services with the `local`, `json-file` or
-      # `journald` logging drivers.
+      # Get task logs
       sig do
         params(
           id: String,
@@ -60,22 +38,13 @@ module DockerEngineRuby
         ).returns(StringIO)
       end
       def logs(
-        # ID of the task
         id,
-        # Show task 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: {}
       )

data/rbi/docker_engine_ruby/resources/volumes.rbi

@@ -27,10 +27,9 @@ module DockerEngineRuby
         ).void
       end
       def update(
-        # Path param: The name or ID of the volume
+        # Path param
         name,
-        # Query param: The version number of the volume being updated. This is required to
-        # avoid conflicting writes. Found in the volume's `ClusterVolume` field.
+        # Query param
         version:,
         # Body param: Cluster-specific options used to create the volume.
         spec: nil,
@@ -45,23 +44,10 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::ListResponse)
       end
-      def list(
-        # JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # volumes list. Available filters:
-        #
-        # - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
-        #   not in use by a container. When set to `false` (or `0`), only volumes that are
-        #   in use by one or more containers are returned.
-        # - `driver=<volume-driver-name>` Matches volumes based on their driver.
-        # - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
-        #   of a `label` alone or a `label` and a value.
-        # - `name=<volume-name>` Matches all or part of a volume name.
-        filters: nil,
-        request_options: {}
-      )
+      def list(filters: nil, request_options: {})
       end
 
-      # Instruct the driver to remove the volume.
+      # Remove a volume
       sig do
         params(
           name: String,
@@ -69,13 +55,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).void
       end
-      def delete(
-        # Volume name or ID
-        name,
-        # Force the removal of the volume
-        force: nil,
-        request_options: {}
-      )
+      def delete(name, force: nil, request_options: {})
       end
 
       # Inspect a volume
@@ -85,11 +65,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Volume)
       end
-      def inspect_(
-        # Volume name or ID
-        name,
-        request_options: {}
-      )
+      def inspect_(name, request_options: {})
       end
 
       # Delete unused volumes
@@ -99,19 +75,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(DockerEngineRuby::Models::VolumePruneResponse)
       end
-      def prune(
-        # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-        #
-        # Available filters:
-        #
-        # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-        #   `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...`
-        #   is used) the specified labels.
-        # - `all` (`all=true`) - Consider all (local) volumes for pruning and not just
-        #   anonymous volumes.
-        filters: nil,
-        request_options: {}
-      )
+      def prune(filters: nil, request_options: {})
       end
 
       # @api private

data/sig/docker_engine_ruby/models/config.rbs

@@ -10,7 +10,7 @@ module DockerEngineRuby
         domainname: String,
         entrypoint: ::Array[String],
         env: ::Array[String],
-        exposed_ports: ::Hash[Symbol, top]?,
+        exposed_ports: ::Hash[Symbol, ::Hash[Symbol, top]]?,
         healthcheck: DockerEngineRuby::Config::Healthcheck,
         hostname: String,
         image: String,
@@ -24,7 +24,7 @@ module DockerEngineRuby
         stop_timeout: Integer?,
         tty: bool,
         user: String,
-        volumes: ::Hash[Symbol, top],
+        volumes: ::Hash[Symbol, ::Hash[Symbol, top]],
         working_dir: String
       }
 
@@ -59,7 +59,7 @@ module DockerEngineRuby
 
       def env=: (::Array[String]) -> ::Array[String]
 
-      attr_accessor exposed_ports: ::Hash[Symbol, top]?
+      attr_accessor exposed_ports: ::Hash[Symbol, ::Hash[Symbol, top]]?
 
       attr_reader healthcheck: DockerEngineRuby::Config::Healthcheck?
 
@@ -105,9 +105,11 @@ module DockerEngineRuby
 
       def user=: (String) -> String
 
-      attr_reader volumes: ::Hash[Symbol, top]?
+      attr_reader volumes: ::Hash[Symbol, ::Hash[Symbol, top]]?
 
-      def volumes=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+      def volumes=: (
+        ::Hash[Symbol, ::Hash[Symbol, top]]
+      ) -> ::Hash[Symbol, ::Hash[Symbol, top]]
 
       attr_reader working_dir: String?
 
@@ -122,7 +124,7 @@ module DockerEngineRuby
         ?domainname: String,
         ?entrypoint: ::Array[String],
         ?env: ::Array[String],
-        ?exposed_ports: ::Hash[Symbol, top]?,
+        ?exposed_ports: ::Hash[Symbol, ::Hash[Symbol, top]]?,
         ?healthcheck: DockerEngineRuby::Config::Healthcheck,
         ?hostname: String,
         ?image: String,
@@ -136,7 +138,7 @@ module DockerEngineRuby
         ?stop_timeout: Integer?,
         ?tty: bool,
         ?user: String,
-        ?volumes: ::Hash[Symbol, top],
+        ?volumes: ::Hash[Symbol, ::Hash[Symbol, top]],
         ?working_dir: String
       ) -> void
 
@@ -149,7 +151,7 @@ module DockerEngineRuby
         domainname: String,
         entrypoint: ::Array[String],
         env: ::Array[String],
-        exposed_ports: ::Hash[Symbol, top]?,
+        exposed_ports: ::Hash[Symbol, ::Hash[Symbol, top]]?,
         healthcheck: DockerEngineRuby::Config::Healthcheck,
         hostname: String,
         image: String,
@@ -163,7 +165,7 @@ module DockerEngineRuby
         stop_timeout: Integer?,
         tty: bool,
         user: String,
-        volumes: ::Hash[Symbol, top],
+        volumes: ::Hash[Symbol, ::Hash[Symbol, top]],
         working_dir: String
       }
 

data/sig/docker_engine_ruby/models/config_create_params.rbs

@@ -1,36 +1,15 @@
 module DockerEngineRuby
   module Models
     type config_create_params =
-      { spec: DockerEngineRuby::ConfigCreateParams::Spec }
-      & DockerEngineRuby::Internal::Type::request_parameters
+      {  } & DockerEngineRuby::Internal::Type::request_parameters
 
     class ConfigCreateParams < DockerEngineRuby::Internal::Type::BaseModel
       extend DockerEngineRuby::Internal::Type::RequestParameters::Converter
       include DockerEngineRuby::Internal::Type::RequestParameters
 
-      attr_reader spec: DockerEngineRuby::ConfigCreateParams::Spec?
+      def initialize: (?request_options: DockerEngineRuby::request_opts) -> void
 
-      def spec=: (
-        DockerEngineRuby::ConfigCreateParams::Spec
-      ) -> DockerEngineRuby::ConfigCreateParams::Spec
-
-      def initialize: (
-        ?spec: DockerEngineRuby::ConfigCreateParams::Spec,
-        ?request_options: DockerEngineRuby::request_opts
-      ) -> void
-
-      def to_hash: -> {
-        spec: DockerEngineRuby::ConfigCreateParams::Spec,
-        request_options: DockerEngineRuby::RequestOptions
-      }
-
-      type spec = {  }
-
-      class Spec < DockerEngineRuby::Models::Spec
-        def initialize: -> void
-
-        def to_hash: -> {  }
-      end
+      def to_hash: -> { request_options: DockerEngineRuby::RequestOptions }
     end
   end
 end

data/sig/docker_engine_ruby/models/config_list_response.rbs

@@ -1,6 +1,6 @@
 module DockerEngineRuby
   module Models
-    type config_list_response = ::Array[DockerEngineRuby::Config]
+    type config_list_response = ::Array[DockerEngineRuby::ConfigObject]
 
     ConfigListResponse: DockerEngineRuby::Internal::Type::Converter
   end

data/sig/docker_engine_ruby/models/config_object.rbs

@@ -0,0 +1,64 @@
+module DockerEngineRuby
+  module Models
+    type config_object =
+      {
+        created_at: Time,
+        id: String,
+        spec: DockerEngineRuby::ConfigSpec,
+        updated_at: Time,
+        version: DockerEngineRuby::ConfigObject::Version
+      }
+
+    class ConfigObject < DockerEngineRuby::Internal::Type::BaseModel
+      attr_reader created_at: Time?
+
+      def created_at=: (Time) -> Time
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader spec: DockerEngineRuby::ConfigSpec?
+
+      def spec=: (DockerEngineRuby::ConfigSpec) -> DockerEngineRuby::ConfigSpec
+
+      attr_reader updated_at: Time?
+
+      def updated_at=: (Time) -> Time
+
+      attr_reader version: DockerEngineRuby::ConfigObject::Version?
+
+      def version=: (
+        DockerEngineRuby::ConfigObject::Version
+      ) -> DockerEngineRuby::ConfigObject::Version
+
+      def initialize: (
+        ?created_at: Time,
+        ?id: String,
+        ?spec: DockerEngineRuby::ConfigSpec,
+        ?updated_at: Time,
+        ?version: DockerEngineRuby::ConfigObject::Version
+      ) -> void
+
+      def to_hash: -> {
+        created_at: Time,
+        id: String,
+        spec: DockerEngineRuby::ConfigSpec,
+        updated_at: Time,
+        version: DockerEngineRuby::ConfigObject::Version
+      }
+
+      type version = { index: Integer }
+
+      class Version < DockerEngineRuby::Internal::Type::BaseModel
+        attr_reader index: Integer?
+
+        def index=: (Integer) -> Integer
+
+        def initialize: (?index: Integer) -> void
+
+        def to_hash: -> { index: Integer }
+      end
+    end
+  end
+end

data/sig/docker_engine_ruby/models/config_spec.rbs

@@ -0,0 +1,59 @@
+module DockerEngineRuby
+  module Models
+    type config_spec =
+      {
+        data: String,
+        labels: ::Hash[Symbol, String],
+        name: String,
+        templating: DockerEngineRuby::ConfigSpec::Templating
+      }
+
+    class ConfigSpec < DockerEngineRuby::Internal::Type::BaseModel
+      attr_reader data: String?
+
+      def data=: (String) -> String
+
+      attr_reader labels: ::Hash[Symbol, String]?
+
+      def labels=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      attr_reader templating: DockerEngineRuby::ConfigSpec::Templating?
+
+      def templating=: (
+        DockerEngineRuby::ConfigSpec::Templating
+      ) -> DockerEngineRuby::ConfigSpec::Templating
+
+      def initialize: (
+        ?data: String,
+        ?labels: ::Hash[Symbol, String],
+        ?name: String,
+        ?templating: DockerEngineRuby::ConfigSpec::Templating
+      ) -> void
+
+      def to_hash: -> {
+        data: String,
+        labels: ::Hash[Symbol, String],
+        name: String,
+        templating: DockerEngineRuby::ConfigSpec::Templating
+      }
+
+      type templating = { name: String, options: ::Hash[Symbol, String] }
+
+      class Templating < DockerEngineRuby::Internal::Type::BaseModel
+        attr_accessor name: String
+
+        attr_reader options: ::Hash[Symbol, String]?
+
+        def options=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+        def initialize: (name: String, ?options: ::Hash[Symbol, String]) -> void
+
+        def to_hash: -> { name: String, options: ::Hash[Symbol, String] }
+      end
+    end
+  end
+end