docker-engine-api 0.2.1

data/lib/docker_engine_api/models/inspect.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Distribution#inspect_
+    class Inspect < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute descriptor
+      #   A descriptor struct containing digest, media type, and size, as defined in the
+      #   [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
+      #
+      #   @return [DockerEngineAPI::Models::Inspect::Descriptor]
+      required :descriptor, -> { DockerEngineAPI::Inspect::Descriptor }, api_name: :Descriptor
+
+      # @!attribute platforms
+      #   An array containing all platforms supported by the image.
+      #
+      #   @return [Array<DockerEngineAPI::Models::Inspect::Platform, nil>]
+      required :platforms,
+               -> {
+                 DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Inspect::Platform, nil?: true]
+               },
+               api_name: :Platforms
+
+      # @!method initialize(descriptor:, platforms:)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::Inspect} for more details.
+      #
+      #   Describes the result obtained from contacting the registry to retrieve image
+      #   metadata.
+      #
+      #   @param descriptor [DockerEngineAPI::Models::Inspect::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
+      #
+      #   @param platforms [Array<DockerEngineAPI::Models::Inspect::Platform, nil>] An array containing all platforms supported by the image.
+
+      # @see DockerEngineAPI::Models::Inspect#descriptor
+      class Descriptor < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute annotations
+        #   Arbitrary metadata relating to the targeted content.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :annotations, DockerEngineAPI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute artifact_type
+        #   ArtifactType is the IANA media type of this artifact.
+        #
+        #   @return [String, nil]
+        optional :artifact_type, String, api_name: :artifactType, nil?: true
+
+        # @!attribute data
+        #   Data is an embedding of the targeted content. This is encoded as a base64 string
+        #   when marshalled to JSON (automatically, by encoding/json). If present, Data can
+        #   be used directly to avoid fetching the targeted content.
+        #
+        #   @return [String, nil]
+        optional :data, String, nil?: true
+
+        # @!attribute digest
+        #   The digest of the targeted content.
+        #
+        #   @return [String, nil]
+        optional :digest, String
+
+        # @!attribute media_type
+        #   The media type of the object this schema refers to.
+        #
+        #   @return [String, nil]
+        optional :media_type, String, api_name: :mediaType
+
+        # @!attribute platform
+        #   Describes the platform which the image in the manifest runs on, as defined in
+        #   the
+        #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
+        #
+        #   @return [DockerEngineAPI::Models::Inspect::Descriptor::Platform, nil]
+        optional :platform, -> { DockerEngineAPI::Inspect::Descriptor::Platform }, nil?: true
+
+        # @!attribute size
+        #   The size in bytes of the blob.
+        #
+        #   @return [Integer, nil]
+        optional :size, Integer
+
+        # @!attribute urls
+        #   List of URLs from which this object MAY be downloaded.
+        #
+        #   @return [Array<String>, nil]
+        optional :urls, DockerEngineAPI::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::Inspect::Descriptor} for more details.
+        #
+        #   A descriptor struct containing digest, media type, and size, as defined in the
+        #   [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
+        #
+        #   @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
+        #
+        #   @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
+        #
+        #   @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
+        #
+        #   @param digest [String] The digest of the targeted content.
+        #
+        #   @param media_type [String] The media type of the object this schema refers to.
+        #
+        #   @param platform [DockerEngineAPI::Models::Inspect::Descriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
+        #
+        #   @param size [Integer] The size in bytes of the blob.
+        #
+        #   @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
+
+        # @see DockerEngineAPI::Models::Inspect::Descriptor#platform
+        class Platform < DockerEngineAPI::Internal::Type::BaseModel
+          # @!attribute architecture
+          #   The CPU architecture, for example `amd64` or `ppc64`.
+          #
+          #   @return [String, nil]
+          optional :architecture, String
+
+          # @!attribute os
+          #   The operating system, for example `linux` or `windows`.
+          #
+          #   @return [String, nil]
+          optional :os, String
+
+          # @!attribute os_features
+          #   Optional field specifying an array of strings, each listing a required OS
+          #   feature (for example on Windows `win32k`).
+          #
+          #   @return [Array<String>, nil]
+          optional :os_features, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :"os.features"
+
+          # @!attribute os_version
+          #   Optional field specifying the operating system version, for example on Windows
+          #   `10.0.19041.1165`.
+          #
+          #   @return [String, nil]
+          optional :os_version, String, api_name: :"os.version"
+
+          # @!attribute variant
+          #   Optional field specifying a variant of the CPU, for example `v7` to specify
+          #   ARMv7 when architecture is `arm`.
+          #
+          #   @return [String, nil]
+          optional :variant, String
+
+          # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {DockerEngineAPI::Models::Inspect::Descriptor::Platform} for more details.
+          #
+          #   Describes the platform which the image in the manifest runs on, as defined in
+          #   the
+          #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
+          #
+          #   @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
+          #
+          #   @param os [String] The operating system, for example `linux` or `windows`.
+          #
+          #   @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
+          #
+          #   @param os_version [String] Optional field specifying the operating system version, for example on
+          #
+          #   @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
+        end
+      end
+
+      class Platform < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute architecture
+        #   The CPU architecture, for example `amd64` or `ppc64`.
+        #
+        #   @return [String, nil]
+        optional :architecture, String
+
+        # @!attribute os
+        #   The operating system, for example `linux` or `windows`.
+        #
+        #   @return [String, nil]
+        optional :os, String
+
+        # @!attribute os_features
+        #   Optional field specifying an array of strings, each listing a required OS
+        #   feature (for example on Windows `win32k`).
+        #
+        #   @return [Array<String>, nil]
+        optional :os_features, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :"os.features"
+
+        # @!attribute os_version
+        #   Optional field specifying the operating system version, for example on Windows
+        #   `10.0.19041.1165`.
+        #
+        #   @return [String, nil]
+        optional :os_version, String, api_name: :"os.version"
+
+        # @!attribute variant
+        #   Optional field specifying a variant of the CPU, for example `v7` to specify
+        #   ARMv7 when architecture is `arm`.
+        #
+        #   @return [String, nil]
+        optional :variant, String
+
+        # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::Inspect::Platform} for more details.
+        #
+        #   Describes the platform which the image in the manifest runs on, as defined in
+        #   the
+        #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
+        #
+        #   @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
+        #
+        #   @param os [String] The operating system, for example `linux` or `windows`.
+        #
+        #   @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
+        #
+        #   @param os_version [String] Optional field specifying the operating system version, for example on
+        #
+        #   @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/inspect_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class InspectResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute arguments
+      #
+      #   @return [Array<String>, nil]
+      optional :arguments, DockerEngineAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute entrypoint
+      #
+      #   @return [String, nil]
+      optional :entrypoint, String
+
+      # @!attribute privileged
+      #
+      #   @return [Boolean, nil]
+      optional :privileged, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!attribute tty
+      #
+      #   @return [Boolean, nil]
+      optional :tty, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!attribute user
+      #
+      #   @return [String, nil]
+      optional :user, String
+
+      # @!method initialize(arguments: nil, entrypoint: nil, privileged: nil, tty: nil, user: nil)
+      #   @param arguments [Array<String>]
+      #   @param entrypoint [String]
+      #   @param privileged [Boolean]
+      #   @param tty [Boolean]
+      #   @param user [String]
+    end
+  end
+end

data/lib/docker_engine_api/models/list_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#list
+    class ListResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute volumes
+      #   List of volumes
+      #
+      #   @return [Array<DockerEngineAPI::Models::Volume>, nil]
+      optional :volumes,
+               -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Volume] },
+               api_name: :Volumes
+
+      # @!attribute warnings
+      #   Warnings that occurred when fetching the list of volumes.
+      #
+      #   @return [Array<String>, nil]
+      optional :warnings, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Warnings
+
+      # @!method initialize(volumes: nil, warnings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::ListResponse} for more details.
+      #
+      #   Volume list response
+      #
+      #   @param volumes [Array<DockerEngineAPI::Models::Volume>] List of volumes
+      #
+      #   @param warnings [Array<String>] Warnings that occurred when fetching the list of volumes.
+    end
+  end
+end

data/lib/docker_engine_api/models/network.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class Network < DockerEngineAPI::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, DockerEngineAPI::Internal::Type::Boolean, api_name: :Attachable
+
+      # @!attribute config_from
+      #   The config-only network source to provide the configuration for this network.
+      #
+      #   @return [DockerEngineAPI::Models::Network::ConfigFrom, nil]
+      optional :config_from, -> { DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::Internal::Type::Boolean, api_name: :Ingress
+
+      # @!attribute internal
+      #   Whether the network is created to only allow internal networking connectivity.
+      #
+      #   @return [Boolean, nil]
+      optional :internal, DockerEngineAPI::Internal::Type::Boolean, api_name: :Internal
+
+      # @!attribute ipam
+      #
+      #   @return [DockerEngineAPI::Models::Network::Ipam, nil]
+      optional :ipam, -> { DockerEngineAPI::Network::Ipam }, api_name: :IPAM
+
+      # @!attribute labels
+      #   Metadata specific to the network being created.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineAPI::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, DockerEngineAPI::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<DockerEngineAPI::Models::Network::Peer>, nil]
+      optional :peers,
+               -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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
+      #   {DockerEngineAPI::Models::Network} for more details.
+      #
+      #   @param attachable [Boolean] Whether a global / swarm scope network is manually attachable by regular
+      #
+      #   @param config_from [DockerEngineAPI::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 [DockerEngineAPI::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<DockerEngineAPI::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 DockerEngineAPI::Models::Network#config_from
+      class ConfigFrom < DockerEngineAPI::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
+        #   {DockerEngineAPI::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 DockerEngineAPI::Models::Network#ipam
+      class Ipam < DockerEngineAPI::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<DockerEngineAPI::Models::Network::Ipam::Config>, nil]
+        optional :config,
+                 -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(config: nil, driver: nil, options: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::Network::Ipam} for more details.
+        #
+        #   @param config [Array<DockerEngineAPI::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 < DockerEngineAPI::Internal::Type::BaseModel
+          # @!attribute auxiliary_addresses
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :auxiliary_addresses,
+                   DockerEngineAPI::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 < DockerEngineAPI::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

data/lib/docker_engine_api/models/network_connect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#connect
+    class NetworkConnectParams < DockerEngineAPI::Models::ConnectRequest
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end