docker-engine 0.1.1

data/lib/docker_engine/models/image_delete_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#delete
+    class ImageDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute force
+      #   Remove the image even if it is being used by stopped containers or has other
+      #   tags
+      #
+      #   @return [Boolean, nil]
+      optional :force, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute noprune
+      #   Do not delete untagged parent images
+      #
+      #   @return [Boolean, nil]
+      optional :noprune, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute platforms
+      #   Select platform-specific content to delete. Multiple values are accepted. Each
+      #   platform is a OCI platform encoded as a JSON string.
+      #
+      #   @return [Array<String>, nil]
+      optional :platforms, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(force: nil, noprune: nil, platforms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageDeleteParams} for more details.
+      #
+      #   @param force [Boolean] Remove the image even if it is being used by stopped containers or has other tag
+      #
+      #   @param noprune [Boolean] Do not delete untagged parent images
+      #
+      #   @param platforms [Array<String>] Select platform-specific content to delete.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_delete_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class ImageDeleteResponseItem < DockerEngine::Internal::Type::BaseModel
+      # @!attribute deleted
+      #   The image ID of an image that was deleted
+      #
+      #   @return [String, nil]
+      optional :deleted, String, api_name: :Deleted
+
+      # @!attribute untagged
+      #   The image ID of an image that was untagged
+      #
+      #   @return [String, nil]
+      optional :untagged, String, api_name: :Untagged
+
+      # @!method initialize(deleted: nil, untagged: nil)
+      #   @param deleted [String] The image ID of an image that was deleted
+      #
+      #   @param untagged [String] The image ID of an image that was untagged
+    end
+
+    # @type [DockerEngine::Internal::Type::Converter]
+    ImageDeleteResponse =
+      DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::Models::ImageDeleteResponseItem }]
+  end
+end

data/lib/docker_engine/models/image_inspect_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#inspect_
+    class ImageInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute manifests
+      #   Include Manifests in the image summary.
+      #
+      #   @return [Boolean, nil]
+      optional :manifests, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(manifests: nil, request_options: {})
+      #   @param manifests [Boolean] Include Manifests in the image summary.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#list
+    class ImageListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute all
+      #   Show all images. Only images from a final layer (no children) are shown by
+      #   default.
+      #
+      #   @return [Boolean, nil]
+      optional :all, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute digests
+      #   Show digest information as a `RepoDigests` field on each image.
+      #
+      #   @return [Boolean, nil]
+      optional :digests, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute filters
+      #   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>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!attribute manifests
+      #   Include `Manifests` in the image summary.
+      #
+      #   @return [Boolean, nil]
+      optional :manifests, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute shared_size
+      #   Compute and show shared size as a `SharedSize` field on each image.
+      #
+      #   @return [Boolean, nil]
+      optional :shared_size, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(all: nil, digests: nil, filters: nil, manifests: nil, shared_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageListParams} for more details.
+      #
+      #   @param all [Boolean] Show all images. Only images from a final layer (no children) are shown by defau
+      #
+      #   @param digests [Boolean] Show digest information as a `RepoDigests` field on each image.
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param manifests [Boolean] Include `Manifests` in the image summary.
+      #
+      #   @param shared_size [Boolean] Compute and show shared size as a `SharedSize` field on each image.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_list_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @type [DockerEngine::Internal::Type::Converter]
+    ImageListResponse = DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::Summary }]
+  end
+end

data/lib/docker_engine/models/image_pull_params.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#pull
+    class ImagePullParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute changes
+      #   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`
+      #
+      #   @return [Array<String>, nil]
+      optional :changes, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!attribute from_image
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :from_image, String
+
+      # @!attribute from_src
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :from_src, String
+
+      # @!attribute message
+      #   Set commit message for imported image.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute platform
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :platform, String
+
+      # @!attribute repo
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :repo, String
+
+      # @!attribute tag
+      #   Tag or digest. If empty when pulling an image, this causes all tags for the
+      #   given image to be pulled.
+      #
+      #   @return [String, nil]
+      optional :tag, String
+
+      # @!attribute body
+      #
+      #   @return [String, nil]
+      optional :body, String
+
+      # @!attribute x_registry_auth
+      #
+      #   @return [String, nil]
+      optional :x_registry_auth, String
+
+      # @!method initialize(changes: nil, from_image: nil, from_src: nil, message: nil, platform: nil, repo: nil, tag: nil, body: nil, x_registry_auth: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImagePullParams} for more details.
+      #
+      #   @param changes [Array<String>] Apply `Dockerfile` instructions to the image that is created,
+      #
+      #   @param from_image [String] Name of the image to pull. If the name includes a tag or digest, specific behavi
+      #
+      #   @param from_src [String] Source to import. The value may be a URL from which the image can be retrieved o
+      #
+      #   @param message [String] Set commit message for imported image.
+      #
+      #   @param platform [String] Platform in the format os[/arch[/variant]].
+      #
+      #   @param repo [String] Repository name given to an image when it is imported. The repo may include a ta
+      #
+      #   @param tag [String] Tag or digest. If empty when pulling an image, this causes all tags for the give
+      #
+      #   @param body [String]
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/network.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class Network < DockerEngine::Internal::Type::BaseModel
+      # @!attribute attachable
+      #   Whether a global / swarm scope network is manually attachable by regular
+      #   containers from workers in swarm mode.
+      #
+      #   @return [Boolean, nil]
+      optional :attachable, DockerEngine::Internal::Type::Boolean, api_name: :Attachable
+
+      # @!attribute config_from
+      #   The config-only network source to provide the configuration for this network.
+      #
+      #   @return [DockerEngine::Models::Network::ConfigFrom, nil]
+      optional :config_from, -> { DockerEngine::Network::ConfigFrom }, api_name: :ConfigFrom
+
+      # @!attribute config_only
+      #   Whether the network is a config-only network. Config-only networks are
+      #   placeholder networks for network configurations to be used by other networks.
+      #   Config-only networks cannot be used directly to run containers or services.
+      #
+      #   @return [Boolean, nil]
+      optional :config_only, DockerEngine::Internal::Type::Boolean, api_name: :ConfigOnly
+
+      # @!attribute created
+      #   Date and time at which the network was created in
+      #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+      #
+      #   @return [String, nil]
+      optional :created, String, api_name: :Created
+
+      # @!attribute driver
+      #   The name of the driver used to create the network (e.g. `bridge`, `overlay`).
+      #
+      #   @return [String, nil]
+      optional :driver, String, api_name: :Driver
+
+      # @!attribute enable_i_pv4
+      #   Whether the network was created with IPv4 enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv4, DockerEngine::Internal::Type::Boolean, api_name: :EnableIPv4
+
+      # @!attribute enable_i_pv6
+      #   Whether the network was created with IPv6 enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv6, DockerEngine::Internal::Type::Boolean, api_name: :EnableIPv6
+
+      # @!attribute id
+      #   ID that uniquely identifies a network on a single machine.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :Id
+
+      # @!attribute ingress
+      #   Whether the network is providing the routing-mesh for the swarm cluster.
+      #
+      #   @return [Boolean, nil]
+      optional :ingress, DockerEngine::Internal::Type::Boolean, api_name: :Ingress
+
+      # @!attribute internal
+      #   Whether the network is created to only allow internal networking connectivity.
+      #
+      #   @return [Boolean, nil]
+      optional :internal, DockerEngine::Internal::Type::Boolean, api_name: :Internal
+
+      # @!attribute ipam
+      #
+      #   @return [DockerEngine::Models::Network::Ipam, nil]
+      optional :ipam, -> { DockerEngine::Network::Ipam }, api_name: :IPAM
+
+      # @!attribute labels
+      #   Metadata specific to the network being created.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngine::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   Name of the network.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute options
+      #   Network-specific options uses when creating the network.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :options, DockerEngine::Internal::Type::HashOf[String], api_name: :Options
+
+      # @!attribute peers
+      #   List of peer nodes for an overlay network. This field is only present for
+      #   overlay networks, and omitted for other network types.
+      #
+      #   @return [Array<DockerEngine::Models::Network::Peer>, nil]
+      optional :peers,
+               -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Network::Peer] },
+               api_name: :Peers
+
+      # @!attribute scope
+      #   The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
+      #   for machine level)
+      #
+      #   @return [String, nil]
+      optional :scope, String, api_name: :Scope
+
+      # @!method initialize(attachable: nil, config_from: nil, config_only: nil, created: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, id: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, name: nil, options: nil, peers: nil, scope: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::Network} for more details.
+      #
+      #   @param attachable [Boolean] Whether a global / swarm scope network is manually attachable by regular
+      #
+      #   @param config_from [DockerEngine::Models::Network::ConfigFrom] The config-only network source to provide the configuration for
+      #
+      #   @param config_only [Boolean] Whether the network is a config-only network. Config-only networks are
+      #
+      #   @param created [String] Date and time at which the network was created in
+      #
+      #   @param driver [String] The name of the driver used to create the network (e.g. `bridge`,
+      #
+      #   @param enable_i_pv4 [Boolean] Whether the network was created with IPv4 enabled.
+      #
+      #   @param enable_i_pv6 [Boolean] Whether the network was created with IPv6 enabled.
+      #
+      #   @param id [String] ID that uniquely identifies a network on a single machine.
+      #
+      #   @param ingress [Boolean] Whether the network is providing the routing-mesh for the swarm cluster.
+      #
+      #   @param internal [Boolean] Whether the network is created to only allow internal networking
+      #
+      #   @param ipam [DockerEngine::Models::Network::Ipam]
+      #
+      #   @param labels [Hash{Symbol=>String}] Metadata specific to the network being created.
+      #
+      #   @param name [String] Name of the network.
+      #
+      #   @param options [Hash{Symbol=>String}] Network-specific options uses when creating the network.
+      #
+      #   @param peers [Array<DockerEngine::Models::Network::Peer>] List of peer nodes for an overlay network. This field is only present
+      #
+      #   @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
+
+      # @see DockerEngine::Models::Network#config_from
+      class ConfigFrom < DockerEngine::Internal::Type::BaseModel
+        # @!attribute network
+        #   The name of the config-only network that provides the network's configuration.
+        #   The specified network must be an existing config-only network. Only network
+        #   names are allowed, not network IDs.
+        #
+        #   @return [String, nil]
+        optional :network, String, api_name: :Network
+
+        # @!method initialize(network: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::Network::ConfigFrom} for more details.
+        #
+        #   The config-only network source to provide the configuration for this network.
+        #
+        #   @param network [String] The name of the config-only network that provides the network's
+      end
+
+      # @see DockerEngine::Models::Network#ipam
+      class Ipam < DockerEngine::Internal::Type::BaseModel
+        # @!attribute config
+        #   List of IPAM configuration options, specified as a map:
+        #
+        #   ```
+        #   {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
+        #   ```
+        #
+        #   @return [Array<DockerEngine::Models::Network::Ipam::Config>, nil]
+        optional :config,
+                 -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Network::Ipam::Config] },
+                 api_name: :Config
+
+        # @!attribute driver
+        #   Name of the IPAM driver to use.
+        #
+        #   @return [String, nil]
+        optional :driver, String, api_name: :Driver
+
+        # @!attribute options
+        #   Driver-specific options, specified as a map.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngine::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(config: nil, driver: nil, options: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::Network::Ipam} for more details.
+        #
+        #   @param config [Array<DockerEngine::Models::Network::Ipam::Config>] List of IPAM configuration options, specified as a map:
+        #
+        #   @param driver [String] Name of the IPAM driver to use.
+        #
+        #   @param options [Hash{Symbol=>String}] Driver-specific options, specified as a map.
+
+        class Config < DockerEngine::Internal::Type::BaseModel
+          # @!attribute auxiliary_addresses
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :auxiliary_addresses,
+                   DockerEngine::Internal::Type::HashOf[String],
+                   api_name: :AuxiliaryAddresses
+
+          # @!attribute gateway
+          #
+          #   @return [String, nil]
+          optional :gateway, String, api_name: :Gateway
+
+          # @!attribute ip_range
+          #
+          #   @return [String, nil]
+          optional :ip_range, String, api_name: :IPRange
+
+          # @!attribute subnet
+          #
+          #   @return [String, nil]
+          optional :subnet, String, api_name: :Subnet
+
+          # @!method initialize(auxiliary_addresses: nil, gateway: nil, ip_range: nil, subnet: nil)
+          #   @param auxiliary_addresses [Hash{Symbol=>String}]
+          #   @param gateway [String]
+          #   @param ip_range [String]
+          #   @param subnet [String]
+        end
+      end
+
+      class Peer < DockerEngine::Internal::Type::BaseModel
+        # @!attribute ip
+        #   IP-address of the peer-node in the Swarm cluster.
+        #
+        #   @return [String, nil]
+        optional :ip, String, api_name: :IP
+
+        # @!attribute name
+        #   ID of the peer-node in the Swarm cluster.
+        #
+        #   @return [String, nil]
+        optional :name, String, api_name: :Name
+
+        # @!method initialize(ip: nil, name: nil)
+        #   represents one peer of an overlay network.
+        #
+        #   @param ip [String] IP-address of the peer-node in the Swarm cluster.
+        #
+        #   @param name [String] ID of the peer-node in the Swarm cluster.
+      end
+    end
+  end
+end