docker-engine-ruby 0.2.2 → 0.3.0

data/rbi/docker_engine_ruby/models/image_build_params.rbi

@@ -17,211 +17,150 @@ module DockerEngineRuby
       sig { returns(DockerEngineRuby::Internal::FileInput) }
       attr_accessor :body
 
-      # JSON map of string pairs for build-time variables. Users pass these values at
-      # build-time. Docker uses the buildargs as the environment context for commands
-      # run via the `Dockerfile` RUN instruction, or for variable expansion in other
-      # `Dockerfile` instructions. This is not meant for passing secret values.
-      #
-      # For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This
-      # would result in the query parameter `buildargs={"FOO":"bar"}`. Note that
-      # `{"FOO":"bar"}` should be URI component encoded.
-      #
-      # [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
       sig { returns(T.nilable(String)) }
       attr_reader :buildargs
 
       sig { params(buildargs: String).void }
       attr_writer :buildargs
 
-      # JSON array of images used for build cache resolution.
       sig { returns(T.nilable(String)) }
       attr_reader :cachefrom
 
       sig { params(cachefrom: String).void }
       attr_writer :cachefrom
 
-      # The length of a CPU period in microseconds.
       sig { returns(T.nilable(Integer)) }
       attr_reader :cpuperiod
 
       sig { params(cpuperiod: Integer).void }
       attr_writer :cpuperiod
 
-      # Microseconds of CPU time that the container can get in a CPU period.
       sig { returns(T.nilable(Integer)) }
       attr_reader :cpuquota
 
       sig { params(cpuquota: Integer).void }
       attr_writer :cpuquota
 
-      # CPUs in which to allow execution (e.g., `0-3`, `0,1`).
       sig { returns(T.nilable(String)) }
       attr_reader :cpusetcpus
 
       sig { params(cpusetcpus: String).void }
       attr_writer :cpusetcpus
 
-      # CPU shares (relative weight).
       sig { returns(T.nilable(Integer)) }
       attr_reader :cpushares
 
       sig { params(cpushares: Integer).void }
       attr_writer :cpushares
 
-      # Path within the build context to the `Dockerfile`. This is ignored if `remote`
-      # is specified and points to an external `Dockerfile`.
       sig { returns(T.nilable(String)) }
       attr_reader :dockerfile
 
       sig { params(dockerfile: String).void }
       attr_writer :dockerfile
 
-      # Extra hosts to add to /etc/hosts
       sig { returns(T.nilable(String)) }
       attr_reader :extrahosts
 
       sig { params(extrahosts: String).void }
       attr_writer :extrahosts
 
-      # Always remove intermediate containers, even upon failure.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :forcerm
 
       sig { params(forcerm: T::Boolean).void }
       attr_writer :forcerm
 
-      # Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
       sig { returns(T.nilable(String)) }
       attr_reader :labels
 
       sig { params(labels: String).void }
       attr_writer :labels
 
-      # Set memory limit for build.
       sig { returns(T.nilable(Integer)) }
       attr_reader :memory
 
       sig { params(memory: Integer).void }
       attr_writer :memory
 
-      # Total memory (memory + swap). Set as `-1` to disable swap.
       sig { returns(T.nilable(Integer)) }
       attr_reader :memswap
 
       sig { params(memswap: Integer).void }
       attr_writer :memswap
 
-      # Sets the networking mode for the run commands during build. Supported standard
-      # values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value
-      # is taken as a custom network's name or ID to which this container should connect
-      # to.
       sig { returns(T.nilable(String)) }
       attr_reader :networkmode
 
       sig { params(networkmode: String).void }
       attr_writer :networkmode
 
-      # Do not use the cache when building the image.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :nocache
 
       sig { params(nocache: T::Boolean).void }
       attr_writer :nocache
 
-      # BuildKit output configuration in the format of a stringified JSON array of
-      # objects. Each object must have two top-level properties: `Type` and `Attrs`. The
-      # `Type` property must be set to 'moby'. The `Attrs` property is a map of
-      # attributes for the BuildKit output configuration. See
-      # https://docs.docker.com/build/exporters/oci-docker/ for more information.
-      #
-      # Example:
-      #
-      # ```
-      # [{"Type":"moby","Attrs":{"type":"image","force-compression":"true","compression":"zstd"}}]
-      # ```
       sig { returns(T.nilable(String)) }
       attr_reader :outputs
 
       sig { params(outputs: String).void }
       attr_writer :outputs
 
-      # Platform in the format os[/arch[/variant]]
       sig { returns(T.nilable(String)) }
       attr_reader :platform
 
       sig { params(platform: String).void }
       attr_writer :platform
 
-      # Attempt to pull the image even if an older image exists locally.
       sig { returns(T.nilable(String)) }
       attr_reader :pull
 
       sig { params(pull: String).void }
       attr_writer :pull
 
-      # Suppress verbose build output.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :q
 
       sig { params(q: T::Boolean).void }
       attr_writer :q
 
-      # A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single
-      # text file, the file’s contents are placed into a file called `Dockerfile` and
-      # the image is built from that file. If the URI points to a tarball, the file is
-      # downloaded by the daemon and the contents therein used as the context for the
-      # build. If the URI points to a tarball and the `dockerfile` parameter is also
-      # specified, there must be a file with the corresponding path inside the tarball.
       sig { returns(T.nilable(String)) }
       attr_reader :remote
 
       sig { params(remote: String).void }
       attr_writer :remote
 
-      # Remove intermediate containers after a successful build.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :rm
 
       sig { params(rm: T::Boolean).void }
       attr_writer :rm
 
-      # Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the
-      # system uses 64MB.
       sig { returns(T.nilable(Integer)) }
       attr_reader :shmsize
 
       sig { params(shmsize: Integer).void }
       attr_writer :shmsize
 
-      # Squash the resulting images layers into a single layer. _(Experimental release
-      # only.)_
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :squash
 
       sig { params(squash: T::Boolean).void }
       attr_writer :squash
 
-      # A name and optional tag to apply to the image in the `name:tag` format. If you
-      # omit the tag the default `latest` value is assumed. You can provide several `t`
-      # parameters.
       sig { returns(T.nilable(String)) }
       attr_reader :t
 
       sig { params(t: String).void }
       attr_writer :t
 
-      # Target build stage
       sig { returns(T.nilable(String)) }
       attr_reader :target
 
       sig { params(target: String).void }
       attr_writer :target
 
-      # Version of the builder backend to use.
-      #
-      # - `1` is the first generation classic (deprecated) builder in the Docker daemon
-      #   (default)
-      # - `2` is [BuildKit](https://github.com/moby/buildkit)
       sig do
         returns(
           T.nilable(DockerEngineRuby::ImageBuildParams::Version::OrSymbol)
@@ -276,91 +215,30 @@ module DockerEngineRuby
       end
       def self.new(
         body:,
-        # JSON map of string pairs for build-time variables. Users pass these values at
-        # build-time. Docker uses the buildargs as the environment context for commands
-        # run via the `Dockerfile` RUN instruction, or for variable expansion in other
-        # `Dockerfile` instructions. This is not meant for passing secret values.
-        #
-        # For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This
-        # would result in the query parameter `buildargs={"FOO":"bar"}`. Note that
-        # `{"FOO":"bar"}` should be URI component encoded.
-        #
-        # [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
         buildargs: nil,
-        # JSON array of images used for build cache resolution.
         cachefrom: nil,
-        # The length of a CPU period in microseconds.
         cpuperiod: nil,
-        # Microseconds of CPU time that the container can get in a CPU period.
         cpuquota: nil,
-        # CPUs in which to allow execution (e.g., `0-3`, `0,1`).
         cpusetcpus: nil,
-        # CPU shares (relative weight).
         cpushares: nil,
-        # Path within the build context to the `Dockerfile`. This is ignored if `remote`
-        # is specified and points to an external `Dockerfile`.
         dockerfile: nil,
-        # Extra hosts to add to /etc/hosts
         extrahosts: nil,
-        # Always remove intermediate containers, even upon failure.
         forcerm: nil,
-        # Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
         labels: nil,
-        # Set memory limit for build.
         memory: nil,
-        # Total memory (memory + swap). Set as `-1` to disable swap.
         memswap: nil,
-        # Sets the networking mode for the run commands during build. Supported standard
-        # values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value
-        # is taken as a custom network's name or ID to which this container should connect
-        # to.
         networkmode: nil,
-        # Do not use the cache when building the image.
         nocache: nil,
-        # BuildKit output configuration in the format of a stringified JSON array of
-        # objects. Each object must have two top-level properties: `Type` and `Attrs`. The
-        # `Type` property must be set to 'moby'. The `Attrs` property is a map of
-        # attributes for the BuildKit output configuration. See
-        # https://docs.docker.com/build/exporters/oci-docker/ for more information.
-        #
-        # Example:
-        #
-        # ```
-        # [{"Type":"moby","Attrs":{"type":"image","force-compression":"true","compression":"zstd"}}]
-        # ```
         outputs: nil,
-        # Platform in the format os[/arch[/variant]]
         platform: nil,
-        # Attempt to pull the image even if an older image exists locally.
         pull: nil,
-        # Suppress verbose build output.
         q: nil,
-        # A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single
-        # text file, the file’s contents are placed into a file called `Dockerfile` and
-        # the image is built from that file. If the URI points to a tarball, the file is
-        # downloaded by the daemon and the contents therein used as the context for the
-        # build. If the URI points to a tarball and the `dockerfile` parameter is also
-        # specified, there must be a file with the corresponding path inside the tarball.
         remote: nil,
-        # Remove intermediate containers after a successful build.
         rm: nil,
-        # Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the
-        # system uses 64MB.
         shmsize: nil,
-        # Squash the resulting images layers into a single layer. _(Experimental release
-        # only.)_
         squash: nil,
-        # A name and optional tag to apply to the image in the `name:tag` format. If you
-        # omit the tag the default `latest` value is assumed. You can provide several `t`
-        # parameters.
         t: nil,
-        # Target build stage
         target: nil,
-        # Version of the builder backend to use.
-        #
-        # - `1` is the first generation classic (deprecated) builder in the Docker daemon
-        #   (default)
-        # - `2` is [BuildKit](https://github.com/moby/buildkit)
         version: nil,
         x_registry_config: nil,
         request_options: {}
@@ -404,11 +282,6 @@ module DockerEngineRuby
       def to_hash
       end
 
-      # Version of the builder backend to use.
-      #
-      # - `1` is the first generation classic (deprecated) builder in the Docker daemon
-      #   (default)
-      # - `2` is [BuildKit](https://github.com/moby/buildkit)
       module Version
         extend DockerEngineRuby::Internal::Type::Enum
 

data/rbi/docker_engine_ruby/models/image_build_prune_params.rbi

@@ -14,49 +14,30 @@ module DockerEngineRuby
           )
         end
 
-      # Remove all types of build cache
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :all
 
       sig { params(all: T::Boolean).void }
       attr_writer :all
 
-      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      # list of build cache objects.
-      #
-      # Available filters:
-      #
-      # - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>`
-      #   can be Unix timestamps, date formatted timestamps, or Go duration strings
-      #   (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.
-      # - `id=<id>`
-      # - `parent=<id>`
-      # - `type=<string>`
-      # - `description=<string>`
-      # - `inuse`
-      # - `shared`
-      # - `private`
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
       sig { params(filters: String).void }
       attr_writer :filters
 
-      # Maximum amount of disk space allowed to keep for cache
       sig { returns(T.nilable(Integer)) }
       attr_reader :max_used_space
 
       sig { params(max_used_space: Integer).void }
       attr_writer :max_used_space
 
-      # Target amount of free disk space after pruning
       sig { returns(T.nilable(Integer)) }
       attr_reader :min_free_space
 
       sig { params(min_free_space: Integer).void }
       attr_writer :min_free_space
 
-      # Amount of disk space in bytes to keep for cache
       sig { returns(T.nilable(Integer)) }
       attr_reader :reserved_space
 
@@ -74,29 +55,10 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Remove all types of build cache
         all: nil,
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # list of build cache objects.
-        #
-        # Available filters:
-        #
-        # - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>`
-        #   can be Unix timestamps, date formatted timestamps, or Go duration strings
-        #   (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.
-        # - `id=<id>`
-        # - `parent=<id>`
-        # - `type=<string>`
-        # - `description=<string>`
-        # - `inuse`
-        # - `shared`
-        # - `private`
         filters: nil,
-        # Maximum amount of disk space allowed to keep for cache
         max_used_space: nil,
-        # Target amount of free disk space after pruning
         min_free_space: nil,
-        # Amount of disk space in bytes to keep for cache
         reserved_space: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/image_build_prune_response.rbi

@@ -17,7 +17,6 @@ module DockerEngineRuby
       sig { params(caches_deleted: T::Array[String]).void }
       attr_writer :caches_deleted
 
-      # Disk space reclaimed in bytes
       sig { returns(T.nilable(Integer)) }
       attr_reader :space_reclaimed
 
@@ -30,11 +29,7 @@ module DockerEngineRuby
           space_reclaimed: Integer
         ).returns(T.attached_class)
       end
-      def self.new(
-        caches_deleted: nil,
-        # Disk space reclaimed in bytes
-        space_reclaimed: nil
-      )
+      def self.new(caches_deleted: nil, space_reclaimed: nil)
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_commit_params.rbi

@@ -14,49 +14,42 @@ module DockerEngineRuby
           )
         end
 
-      # Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
       sig { returns(T.nilable(String)) }
       attr_reader :author
 
       sig { params(author: String).void }
       attr_writer :author
 
-      # `Dockerfile` instructions to apply while committing
       sig { returns(T.nilable(String)) }
       attr_reader :changes
 
       sig { params(changes: String).void }
       attr_writer :changes
 
-      # Commit message
       sig { returns(T.nilable(String)) }
       attr_reader :comment
 
       sig { params(comment: String).void }
       attr_writer :comment
 
-      # The ID or name of the container to commit
       sig { returns(T.nilable(String)) }
       attr_reader :container
 
       sig { params(container: String).void }
       attr_writer :container
 
-      # Whether to pause the container before committing
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :pause
 
       sig { params(pause: T::Boolean).void }
       attr_writer :pause
 
-      # Repository name for the created image
       sig { returns(T.nilable(String)) }
       attr_reader :repo
 
       sig { params(repo: String).void }
       attr_writer :repo
 
-      # Tag name for the create image
       sig { returns(T.nilable(String)) }
       attr_reader :tag
 
@@ -76,19 +69,12 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
         author: nil,
-        # `Dockerfile` instructions to apply while committing
         changes: nil,
-        # Commit message
         comment: nil,
-        # The ID or name of the container to commit
         container: nil,
-        # Whether to pause the container before committing
         pause: nil,
-        # Repository name for the created image
         repo: nil,
-        # Tag name for the create image
         tag: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/image_delete_params.rbi

@@ -14,23 +14,18 @@ module DockerEngineRuby
           )
         end
 
-      # Remove the image even if it is being used by stopped containers or has other
-      # tags
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :force
 
       sig { params(force: T::Boolean).void }
       attr_writer :force
 
-      # Do not delete untagged parent images
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :noprune
 
       sig { params(noprune: T::Boolean).void }
       attr_writer :noprune
 
-      # Select platform-specific content to delete. Multiple values are accepted. Each
-      # platform is a OCI platform encoded as a JSON string.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :platforms
 
@@ -46,13 +41,8 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Remove the image even if it is being used by stopped containers or has other
-        # tags
         force: nil,
-        # Do not delete untagged parent images
         noprune: nil,
-        # Select platform-specific content to delete. Multiple values are accepted. Each
-        # platform is a OCI platform encoded as a JSON string.
         platforms: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/image_get_all_params.rbi

@@ -14,18 +14,12 @@ module DockerEngineRuby
           )
         end
 
-      # Image names to filter by
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :names
 
       sig { params(names: T::Array[String]).void }
       attr_writer :names
 
-      # JSON encoded OCI platform(s) which will be used to select the platform-specific
-      # image(s) to be saved if the image is multi-platform. If not provided, the full
-      # multi-platform image will be saved.
-      #
-      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :platform
 
@@ -39,17 +33,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Image names to filter by
-        names: nil,
-        # JSON encoded OCI platform(s) which will be used to select the platform-specific
-        # image(s) to be saved if the image is multi-platform. If not provided, the full
-        # multi-platform image will be saved.
-        #
-        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
-        platform: nil,
-        request_options: {}
-      )
+      def self.new(names: nil, platform: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_get_params.rbi

@@ -14,11 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # JSON encoded OCI platform describing a platform which will be used to select a
-      # platform-specific image to be saved if the image is multi-platform. If not
-      # provided, the full multi-platform image will be saved.
-      #
-      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :platform
 
@@ -31,15 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # JSON encoded OCI platform describing a platform which will be used to select a
-        # platform-specific image to be saved if the image is multi-platform. If not
-        # provided, the full multi-platform image will be saved.
-        #
-        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
-        platform: nil,
-        request_options: {}
-      )
+      def self.new(platform: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_history_params.rbi

@@ -14,16 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # JSON-encoded OCI platform to select the platform-variant. If omitted, it
-      # defaults to any locally available platform, prioritizing the daemon's host
-      # platform.
-      #
-      # If the daemon provides a multi-platform image store, this selects the
-      # platform-variant to show the history for. If the image is a single-platform
-      # image, or if the multi-platform image does not provide a variant matching the
-      # given platform, an error is returned.
-      #
-      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
       sig { returns(T.nilable(String)) }
       attr_reader :platform
 
@@ -36,20 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # JSON-encoded OCI platform to select the platform-variant. If omitted, it
-        # defaults to any locally available platform, prioritizing the daemon's host
-        # platform.
-        #
-        # If the daemon provides a multi-platform image store, this selects the
-        # platform-variant to show the history for. If the image is a single-platform
-        # image, or if the multi-platform image does not provide a variant matching the
-        # given platform, an error is returned.
-        #
-        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
-        platform: nil,
-        request_options: {}
-      )
+      def self.new(platform: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_inspect_params.rbi

@@ -14,7 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Include Manifests in the image summary.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :manifests
 
@@ -27,11 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Include Manifests in the image summary.
-        manifests: nil,
-        request_options: {}
-      )
+      def self.new(manifests: nil, request_options: {})
       end
 
       sig do