docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/models/image_list_params.rbi

@@ -14,46 +14,30 @@ module DockerEngineRuby
           )
         end
 
-      # Show all images. Only images from a final layer (no children) are shown by
-      # default.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :all
 
       sig { params(all: T::Boolean).void }
       attr_writer :all
 
-      # Show digest information as a `RepoDigests` field on each image.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :digests
 
       sig { params(digests: T::Boolean).void }
       attr_writer :digests
 
-      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      # images list.
-      #
-      # Available filters:
-      #
-      # - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
-      # - `dangling=true`
-      # - `label=key` or `label="key=value"` of an image label
-      # - `reference`=(`<image-name>[:<tag>]`)
-      # - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
-      # - `until=<timestamp>`
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
       sig { params(filters: String).void }
       attr_writer :filters
 
-      # Include `Manifests` in the image summary.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :manifests
 
       sig { params(manifests: T::Boolean).void }
       attr_writer :manifests
 
-      # Compute and show shared size as a `SharedSize` field on each image.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :shared_size
 
@@ -71,26 +55,10 @@ module DockerEngineRuby
         ).returns(T.attached_class)
       end
       def self.new(
-        # Show all images. Only images from a final layer (no children) are shown by
-        # default.
         all: nil,
-        # Show digest information as a `RepoDigests` field on each image.
         digests: nil,
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # images list.
-        #
-        # Available filters:
-        #
-        # - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
-        # - `dangling=true`
-        # - `label=key` or `label="key=value"` of an image label
-        # - `reference`=(`<image-name>[:<tag>]`)
-        # - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
-        # - `until=<timestamp>`
         filters: nil,
-        # Include `Manifests` in the image summary.
         manifests: nil,
-        # Compute and show shared size as a `SharedSize` field on each image.
         shared_size: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/image_list_response.rbi

@@ -4,7 +4,9 @@ module DockerEngineRuby
   module Models
     ImageListResponse =
       T.let(
-        DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Summary],
+        DockerEngineRuby::Internal::Type::ArrayOf[
+          DockerEngineRuby::ImageSummary
+        ],
         DockerEngineRuby::Internal::Type::Converter
       )
   end

data/rbi/docker_engine_ruby/models/image_load_params.rbi

@@ -17,18 +17,12 @@ module DockerEngineRuby
       sig { returns(DockerEngineRuby::Internal::FileInput) }
       attr_accessor :body
 
-      # JSON encoded OCI platform(s) which will be used to select the platform-specific
-      # image(s) to load if the image is multi-platform. If not provided, the full
-      # multi-platform image will be loaded.
-      #
-      # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :platform
 
       sig { params(platform: T::Array[String]).void }
       attr_writer :platform
 
-      # Suppress progress details during load.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :quiet
 
@@ -43,18 +37,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        body:,
-        # JSON encoded OCI platform(s) which will be used to select the platform-specific
-        # image(s) to load if the image is multi-platform. If not provided, the full
-        # multi-platform image will be loaded.
-        #
-        # Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`
-        platform: nil,
-        # Suppress progress details during load.
-        quiet: nil,
-        request_options: {}
-      )
+      def self.new(body:, platform: nil, quiet: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_prune_params.rbi

@@ -14,17 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      # Available filters:
-      #
-      # - `dangling=<boolean>` When set to `true` (or `1`), prune only unused _and_
-      #   untagged images. When set to `false` (or `0`), all unused images are pruned.
-      # - `until=<string>` Prune images created before this timestamp. The `<timestamp>`
-      #   can be Unix timestamps, date formatted timestamps, or Go duration strings
-      #   (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
-      # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-      #   `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is
-      #   used) the specified labels.
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
@@ -37,21 +26,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-        # Available filters:
-        #
-        # - `dangling=<boolean>` When set to `true` (or `1`), prune only unused _and_
-        #   untagged images. When set to `false` (or `0`), all unused images are pruned.
-        # - `until=<string>` Prune images created before this timestamp. The `<timestamp>`
-        #   can be Unix timestamps, date formatted timestamps, or Go duration strings
-        #   (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
-        # - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-        #   `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is
-        #   used) the specified labels.
-        filters: nil,
-        request_options: {}
-      )
+      def self.new(filters: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_prune_response.rbi

@@ -11,7 +11,6 @@ module DockerEngineRuby
           )
         end
 
-      # Images that were deleted
       sig { returns(T.nilable(T::Array[DockerEngineRuby::DeleteItem])) }
       attr_reader :images_deleted
 
@@ -22,7 +21,6 @@ module DockerEngineRuby
       end
       attr_writer :images_deleted
 
-      # Disk space reclaimed in bytes
       sig { returns(T.nilable(Integer)) }
       attr_reader :space_reclaimed
 
@@ -35,12 +33,7 @@ module DockerEngineRuby
           space_reclaimed: Integer
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Images that were deleted
-        images_deleted: nil,
-        # Disk space reclaimed in bytes
-        space_reclaimed: nil
-      )
+      def self.new(images_deleted: nil, space_reclaimed: nil)
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_pull_params.rbi

@@ -14,89 +14,51 @@ module DockerEngineRuby
           )
         end
 
-      # Apply `Dockerfile` instructions to the image that is created, for example:
-      # `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component
-      # encoded.
-      #
-      # Supported `Dockerfile` instructions:
-      # `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
+      sig { returns(String) }
+      attr_accessor :body
+
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :changes
 
       sig { params(changes: T::Array[String]).void }
       attr_writer :changes
 
-      # Name of the image to pull. If the name includes a tag or digest, specific
-      # behavior applies:
-      #
-      # - If only `fromImage` includes a tag, that tag is used.
-      # - If both `fromImage` and `tag` are provided, `tag` takes precedence.
-      # - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is
-      #   ignored.
-      # - If neither a tag nor digest is specified, all tags are pulled.
       sig { returns(T.nilable(String)) }
       attr_reader :from_image
 
       sig { params(from_image: String).void }
       attr_writer :from_image
 
-      # Source to import. The value may be a URL from which the image can be retrieved
-      # or `-` to read the image from the request body. This parameter may only be used
-      # when importing an image.
       sig { returns(T.nilable(String)) }
       attr_reader :from_src
 
       sig { params(from_src: String).void }
       attr_writer :from_src
 
-      # Set commit message for imported image.
       sig { returns(T.nilable(String)) }
       attr_reader :message
 
       sig { params(message: String).void }
       attr_writer :message
 
-      # Platform in the format os[/arch[/variant]].
-      #
-      # When used in combination with the `fromImage` option, the daemon checks if the
-      # given image is present in the local image cache with the given OS and
-      # Architecture, and otherwise attempts to pull the image. If the option is not
-      # set, the host's native OS and Architecture are used. If the given image does not
-      # exist in the local image cache, the daemon attempts to pull the image with the
-      # host's native OS and Architecture. If the given image does exists in the local
-      # image cache, but its OS or architecture does not match, a warning is produced.
-      #
-      # When used with the `fromSrc` option to import an image from an archive, this
-      # option sets the platform information for the imported image. If the option is
-      # not set, the host's native OS and Architecture are used for the imported image.
       sig { returns(T.nilable(String)) }
       attr_reader :platform
 
       sig { params(platform: String).void }
       attr_writer :platform
 
-      # Repository name given to an image when it is imported. The repo may include a
-      # tag. This parameter may only be used when importing an image.
       sig { returns(T.nilable(String)) }
       attr_reader :repo
 
       sig { params(repo: String).void }
       attr_writer :repo
 
-      # Tag or digest. If empty when pulling an image, this causes all tags for the
-      # given image to be pulled.
       sig { returns(T.nilable(String)) }
       attr_reader :tag
 
       sig { params(tag: String).void }
       attr_writer :tag
 
-      sig { returns(T.nilable(String)) }
-      attr_reader :body
-
-      sig { params(body: String).void }
-      attr_writer :body
-
       sig { returns(T.nilable(String)) }
       attr_reader :x_registry_auth
 
@@ -105,6 +67,7 @@ module DockerEngineRuby
 
       sig do
         params(
+          body: String,
           changes: T::Array[String],
           from_image: String,
           from_src: String,
@@ -112,55 +75,19 @@ module DockerEngineRuby
           platform: String,
           repo: String,
           tag: String,
-          body: String,
           x_registry_auth: String,
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Apply `Dockerfile` instructions to the image that is created, for example:
-        # `changes=ENV DEBUG=true`. Note that `ENV DEBUG=true` should be URI component
-        # encoded.
-        #
-        # Supported `Dockerfile` instructions:
-        # `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
+        body:,
         changes: nil,
-        # Name of the image to pull. If the name includes a tag or digest, specific
-        # behavior applies:
-        #
-        # - If only `fromImage` includes a tag, that tag is used.
-        # - If both `fromImage` and `tag` are provided, `tag` takes precedence.
-        # - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is
-        #   ignored.
-        # - If neither a tag nor digest is specified, all tags are pulled.
         from_image: nil,
-        # Source to import. The value may be a URL from which the image can be retrieved
-        # or `-` to read the image from the request body. This parameter may only be used
-        # when importing an image.
         from_src: nil,
-        # Set commit message for imported image.
         message: nil,
-        # Platform in the format os[/arch[/variant]].
-        #
-        # When used in combination with the `fromImage` option, the daemon checks if the
-        # given image is present in the local image cache with the given OS and
-        # Architecture, and otherwise attempts to pull the image. If the option is not
-        # set, the host's native OS and Architecture are used. If the given image does not
-        # exist in the local image cache, the daemon attempts to pull the image with the
-        # host's native OS and Architecture. If the given image does exists in the local
-        # image cache, but its OS or architecture does not match, a warning is produced.
-        #
-        # When used with the `fromSrc` option to import an image from an archive, this
-        # option sets the platform information for the imported image. If the option is
-        # not set, the host's native OS and Architecture are used for the imported image.
         platform: nil,
-        # Repository name given to an image when it is imported. The repo may include a
-        # tag. This parameter may only be used when importing an image.
         repo: nil,
-        # Tag or digest. If empty when pulling an image, this causes all tags for the
-        # given image to be pulled.
         tag: nil,
-        body: nil,
         x_registry_auth: nil,
         request_options: {}
       )
@@ -169,6 +96,7 @@ module DockerEngineRuby
       sig do
         override.returns(
           {
+            body: String,
             changes: T::Array[String],
             from_image: String,
             from_src: String,
@@ -176,7 +104,6 @@ module DockerEngineRuby
             platform: String,
             repo: String,
             tag: String,
-            body: String,
             x_registry_auth: String,
             request_options: DockerEngineRuby::RequestOptions
           }

data/rbi/docker_engine_ruby/models/image_push_params.rbi

@@ -17,23 +17,12 @@ module DockerEngineRuby
       sig { returns(String) }
       attr_accessor :x_registry_auth
 
-      # JSON-encoded OCI platform to select the platform-variant to push. If not
-      # provided, all available variants will attempt to be pushed.
-      #
-      # If the daemon provides a multi-platform image store, this selects the
-      # platform-variant to push to the registry. 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
 
       sig { params(platform: String).void }
       attr_writer :platform
 
-      # Tag of the image to push. For example, `latest`. If no tag is provided, all tags
-      # of the given image that are present in the local image store are pushed.
       sig { returns(T.nilable(String)) }
       attr_reader :tag
 
@@ -50,18 +39,7 @@ module DockerEngineRuby
       end
       def self.new(
         x_registry_auth:,
-        # JSON-encoded OCI platform to select the platform-variant to push. If not
-        # provided, all available variants will attempt to be pushed.
-        #
-        # If the daemon provides a multi-platform image store, this selects the
-        # platform-variant to push to the registry. 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,
-        # Tag of the image to push. For example, `latest`. If no tag is provided, all tags
-        # of the given image that are present in the local image store are pushed.
         tag: nil,
         request_options: {}
       )

data/rbi/docker_engine_ruby/models/image_search_params.rbi

@@ -14,22 +14,15 @@ module DockerEngineRuby
           )
         end
 
-      # Term to search
       sig { returns(String) }
       attr_accessor :term
 
-      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      # images list. Available filters:
-      #
-      # - `is-official=(true|false)`
-      # - `stars=<number>` Matches images that has at least 'number' stars.
       sig { returns(T.nilable(String)) }
       attr_reader :filters
 
       sig { params(filters: String).void }
       attr_writer :filters
 
-      # Maximum number of results to return
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -44,19 +37,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Term to search
-        term:,
-        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
-        # images list. Available filters:
-        #
-        # - `is-official=(true|false)`
-        # - `stars=<number>` Matches images that has at least 'number' stars.
-        filters: nil,
-        # Maximum number of results to return
-        limit: nil,
-        request_options: {}
-      )
+      def self.new(term:, filters: nil, limit: nil, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/image_search_response.rbi

@@ -17,11 +17,6 @@ module DockerEngineRuby
       sig { params(description: String).void }
       attr_writer :description
 
-      # Whether this repository has automated builds enabled.
-      #
-      # <p><br /></p>
-      #
-      # > **Deprecated**: This field is deprecated and will always be "false".
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :is_automated
 
@@ -57,11 +52,6 @@ module DockerEngineRuby
       end
       def self.new(
         description: nil,
-        # Whether this repository has automated builds enabled.
-        #
-        # <p><br /></p>
-        #
-        # > **Deprecated**: This field is deprecated and will always be "false".
         is_automated: nil,
         is_official: nil,
         name: nil,