docker-engine-api 0.2.1

data/lib/docker_engine_api/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Internal
+    extend DockerEngineAPI::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{DockerEngineAPI::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, DockerEngineAPI::FilePart) }
+    end
+  end
+end

data/lib/docker_engine_api/models/auth_login_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Auth#login
+    class AuthLoginParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute password
+      #
+      #   @return [String, nil]
+      optional :password, String
+
+      # @!attribute serveraddress
+      #
+      #   @return [String, nil]
+      optional :serveraddress, String
+
+      # @!attribute username
+      #
+      #   @return [String, nil]
+      optional :username, String
+
+      # @!method initialize(password: nil, serveraddress: nil, username: nil, request_options: {})
+      #   @param password [String]
+      #   @param serveraddress [String]
+      #   @param username [String]
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/auth_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Auth#login
+    class AuthResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute status
+      #   The status of the authentication
+      #
+      #   @return [String]
+      required :status, String, api_name: :Status
+
+      # @!attribute identity_token
+      #   An opaque token used to authenticate a user after a successful login
+      #
+      #   @return [String, nil]
+      optional :identity_token, String, api_name: :IdentityToken
+
+      # @!method initialize(status:, identity_token: nil)
+      #   An identity token was generated successfully.
+      #
+      #   @param status [String] The status of the authentication
+      #
+      #   @param identity_token [String] An opaque token used to authenticate a user after a successful login
+    end
+  end
+end

data/lib/docker_engine_api/models/config.rb

@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class Config < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute args_escaped
+      #   Command is already escaped (Windows only)
+      #
+      #   @return [Boolean, nil]
+      optional :args_escaped, DockerEngineAPI::Internal::Type::Boolean, api_name: :ArgsEscaped, nil?: true
+
+      # @!attribute attach_stderr
+      #   Whether to attach to `stderr`.
+      #
+      #   @return [Boolean, nil]
+      optional :attach_stderr, DockerEngineAPI::Internal::Type::Boolean, api_name: :AttachStderr
+
+      # @!attribute attach_stdin
+      #   Whether to attach to `stdin`.
+      #
+      #   @return [Boolean, nil]
+      optional :attach_stdin, DockerEngineAPI::Internal::Type::Boolean, api_name: :AttachStdin
+
+      # @!attribute attach_stdout
+      #   Whether to attach to `stdout`.
+      #
+      #   @return [Boolean, nil]
+      optional :attach_stdout, DockerEngineAPI::Internal::Type::Boolean, api_name: :AttachStdout
+
+      # @!attribute cmd
+      #   Command to run specified as a string or an array of strings.
+      #
+      #   @return [Array<String>, nil]
+      optional :cmd, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Cmd
+
+      # @!attribute domainname
+      #   The domain name to use for the container.
+      #
+      #   @return [String, nil]
+      optional :domainname, String, api_name: :Domainname
+
+      # @!attribute entrypoint
+      #   The entry point for the container as a string or an array of strings.
+      #
+      #   If the array consists of exactly one empty string (`[""]`) then the entry point
+      #   is reset to system default (i.e., the entry point used by docker when there is
+      #   no `ENTRYPOINT` instruction in the `Dockerfile`).
+      #
+      #   @return [Array<String>, nil]
+      optional :entrypoint, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Entrypoint
+
+      # @!attribute env
+      #   A list of environment variables to set inside the container in the form
+      #   `["VAR=value", ...]`. A variable without `=` is removed from the environment,
+      #   rather than to have an empty value.
+      #
+      #   @return [Array<String>, nil]
+      optional :env, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Env
+
+      # @!attribute exposed_ports
+      #   An object mapping ports to an empty object in the form:
+      #
+      #   `{"<port>/<tcp|udp|sctp>": {}}`
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :exposed_ports,
+               DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Internal::Type::Unknown],
+               api_name: :ExposedPorts,
+               nil?: true
+
+      # @!attribute healthcheck
+      #   A test to perform to check that the container is healthy. Healthcheck commands
+      #   should be side-effect free.
+      #
+      #   @return [DockerEngineAPI::Models::Config::Healthcheck, nil]
+      optional :healthcheck, -> { DockerEngineAPI::Config::Healthcheck }, api_name: :Healthcheck
+
+      # @!attribute hostname
+      #   The hostname to use for the container, as a valid RFC 1123 hostname.
+      #
+      #   @return [String, nil]
+      optional :hostname, String, api_name: :Hostname
+
+      # @!attribute image
+      #   The name (or reference) of the image to use when creating the container, or
+      #   which was used when the container was created.
+      #
+      #   @return [String, nil]
+      optional :image, String, api_name: :Image
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute network_disabled
+      #   Disable networking for the container.
+      #
+      #   @return [Boolean, nil]
+      optional :network_disabled,
+               DockerEngineAPI::Internal::Type::Boolean,
+               api_name: :NetworkDisabled,
+               nil?: true
+
+      # @!attribute on_build
+      #   `ONBUILD` metadata that were defined in the image's `Dockerfile`.
+      #
+      #   @return [Array<String>, nil]
+      optional :on_build, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :OnBuild, nil?: true
+
+      # @!attribute open_stdin
+      #   Open `stdin`
+      #
+      #   @return [Boolean, nil]
+      optional :open_stdin, DockerEngineAPI::Internal::Type::Boolean, api_name: :OpenStdin
+
+      # @!attribute shell
+      #   Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
+      #
+      #   @return [Array<String>, nil]
+      optional :shell, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Shell, nil?: true
+
+      # @!attribute stdin_once
+      #   Close `stdin` after one attached client disconnects
+      #
+      #   @return [Boolean, nil]
+      optional :stdin_once, DockerEngineAPI::Internal::Type::Boolean, api_name: :StdinOnce
+
+      # @!attribute stop_signal
+      #   Signal to stop a container as a string or unsigned integer.
+      #
+      #   @return [String, nil]
+      optional :stop_signal, String, api_name: :StopSignal, nil?: true
+
+      # @!attribute stop_timeout
+      #   Timeout to stop a container in seconds.
+      #
+      #   @return [Integer, nil]
+      optional :stop_timeout, Integer, api_name: :StopTimeout, nil?: true
+
+      # @!attribute tty
+      #   Attach standard streams to a TTY, including `stdin` if it is not closed.
+      #
+      #   @return [Boolean, nil]
+      optional :tty, DockerEngineAPI::Internal::Type::Boolean, api_name: :Tty
+
+      # @!attribute user
+      #   Commands run as this user inside the container. If omitted, commands run as the
+      #   user specified in the image the container was started from.
+      #
+      #   Can be either user-name or UID, and optional group-name or GID, separated by a
+      #   colon (`<user-name|UID>[<:group-name|GID>]`).
+      #
+      #   @return [String, nil]
+      optional :user, String, api_name: :User
+
+      # @!attribute volumes
+      #   An object mapping mount point paths inside the container to empty objects.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :volumes,
+               DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Internal::Type::Unknown],
+               api_name: :Volumes
+
+      # @!attribute working_dir
+      #   The working directory for commands to run in.
+      #
+      #   @return [String, nil]
+      optional :working_dir, String, api_name: :WorkingDir
+
+      # @!method initialize(args_escaped: nil, attach_stderr: nil, attach_stdin: nil, attach_stdout: nil, cmd: nil, domainname: nil, entrypoint: nil, env: nil, exposed_ports: nil, healthcheck: nil, hostname: nil, image: nil, labels: nil, network_disabled: nil, on_build: nil, open_stdin: nil, shell: nil, stdin_once: nil, stop_signal: nil, stop_timeout: nil, tty: nil, user: nil, volumes: nil, working_dir: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::Config} for more details.
+      #
+      #   Configuration for a container that is portable between hosts.
+      #
+      #   @param args_escaped [Boolean, nil] Command is already escaped (Windows only)
+      #
+      #   @param attach_stderr [Boolean] Whether to attach to `stderr`.
+      #
+      #   @param attach_stdin [Boolean] Whether to attach to `stdin`.
+      #
+      #   @param attach_stdout [Boolean] Whether to attach to `stdout`.
+      #
+      #   @param cmd [Array<String>] Command to run specified as a string or an array of strings.
+      #
+      #   @param domainname [String] The domain name to use for the container.
+      #
+      #   @param entrypoint [Array<String>] The entry point for the container as a string or an array of strings.
+      #
+      #   @param env [Array<String>] A list of environment variables to set inside the container in the
+      #
+      #   @param exposed_ports [Hash{Symbol=>Object}, nil] An object mapping ports to an empty object in the form:
+      #
+      #   @param healthcheck [DockerEngineAPI::Models::Config::Healthcheck] A test to perform to check that the container is healthy.
+      #
+      #   @param hostname [String] The hostname to use for the container, as a valid RFC 1123 hostname.
+      #
+      #   @param image [String] The name (or reference) of the image to use when creating the container,
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param network_disabled [Boolean, nil] Disable networking for the container.
+      #
+      #   @param on_build [Array<String>, nil] `ONBUILD` metadata that were defined in the image's `Dockerfile`.
+      #
+      #   @param open_stdin [Boolean] Open `stdin`
+      #
+      #   @param shell [Array<String>, nil] Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
+      #
+      #   @param stdin_once [Boolean] Close `stdin` after one attached client disconnects
+      #
+      #   @param stop_signal [String, nil] Signal to stop a container as a string or unsigned integer.
+      #
+      #   @param stop_timeout [Integer, nil] Timeout to stop a container in seconds.
+      #
+      #   @param tty [Boolean] Attach standard streams to a TTY, including `stdin` if it is not closed.
+      #
+      #   @param user [String] Commands run as this user inside the container. If omitted, commands
+      #
+      #   @param volumes [Hash{Symbol=>Object}] An object mapping mount point paths inside the container to empty
+      #
+      #   @param working_dir [String] The working directory for commands to run in.
+
+      # @see DockerEngineAPI::Models::Config#healthcheck
+      class Healthcheck < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute interval
+        #   The time to wait between checks in nanoseconds. It should be 0 or at least
+        #   1000000 (1 ms). 0 means inherit.
+        #
+        #   @return [Integer, nil]
+        optional :interval, Integer, api_name: :Interval
+
+        # @!attribute retries
+        #   The number of consecutive failures needed to consider a container as unhealthy.
+        #   0 means inherit.
+        #
+        #   @return [Integer, nil]
+        optional :retries, Integer, api_name: :Retries
+
+        # @!attribute start_interval
+        #   The time to wait between checks in nanoseconds during the start period. It
+        #   should be 0 or at least 1000000 (1 ms). 0 means inherit.
+        #
+        #   @return [Integer, nil]
+        optional :start_interval, Integer, api_name: :StartInterval
+
+        # @!attribute start_period
+        #   Start period for the container to initialize before starting health-retries
+        #   countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means
+        #   inherit.
+        #
+        #   @return [Integer, nil]
+        optional :start_period, Integer, api_name: :StartPeriod
+
+        # @!attribute test_
+        #   The test to perform. Possible values are:
+        #
+        #   - `[]` inherit healthcheck from image or parent image
+        #   - `["NONE"]` disable healthcheck
+        #   - `["CMD", args...]` exec arguments directly
+        #   - `["CMD-SHELL", command]` run command with system's default shell
+        #
+        #   A non-zero exit code indicates a failed healthcheck:
+        #
+        #   - `0` healthy
+        #   - `1` unhealthy
+        #   - `2` reserved (treated as unhealthy)
+        #   - other values: error running probe
+        #
+        #   @return [Array<String>, nil]
+        optional :test_, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Test
+
+        # @!attribute timeout
+        #   The time to wait before considering the check to have hung. It should be 0 or at
+        #   least 1000000 (1 ms). 0 means inherit.
+        #
+        #   If the health check command does not complete within this timeout, the check is
+        #   considered failed and the health check process is forcibly terminated without a
+        #   graceful shutdown.
+        #
+        #   @return [Integer, nil]
+        optional :timeout, Integer, api_name: :Timeout
+
+        # @!method initialize(interval: nil, retries: nil, start_interval: nil, start_period: nil, test_: nil, timeout: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::Config::Healthcheck} for more details.
+        #
+        #   A test to perform to check that the container is healthy. Healthcheck commands
+        #   should be side-effect free.
+        #
+        #   @param interval [Integer] The time to wait between checks in nanoseconds. It should be 0 or at
+        #
+        #   @param retries [Integer] The number of consecutive failures needed to consider a container as
+        #
+        #   @param start_interval [Integer] The time to wait between checks in nanoseconds during the start period.
+        #
+        #   @param start_period [Integer] Start period for the container to initialize before starting
+        #
+        #   @param test_ [Array<String>] The test to perform. Possible values are:
+        #
+        #   @param timeout [Integer] The time to wait before considering the check to have hung. It should
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/config_create_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Configs#create
+    class ConfigCreateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngineAPI::Models::ConfigCreateParams::Spec, nil]
+      optional :spec, -> { DockerEngineAPI::ConfigCreateParams::Spec }
+
+      # @!method initialize(spec: nil, request_options: {})
+      #   @param spec [DockerEngineAPI::Models::ConfigCreateParams::Spec]
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      class Spec < DockerEngineAPI::Models::Spec
+        # @!method initialize
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/config_create_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Configs#create
+    class ConfigCreateResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the newly created object.
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:)
+      #   Response to an API call that returns just an Id
+      #
+      #   @param id [String] The id of the newly created object.
+    end
+  end
+end

data/lib/docker_engine_api/models/config_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Configs#delete
+    class ConfigDeleteParams < DockerEngineAPI::Internal::Type::BaseModel
+      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

data/lib/docker_engine_api/models/config_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Configs#inspect_
+    class ConfigInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      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

data/lib/docker_engine_api/models/config_list_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Configs#list
+    class ConfigListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   configs list.
+      #
+      #   Available filters:
+      #
+      #   - `id=<config id>`
+      #   - `label=<key> or label=<key>=value`
+      #   - `name=<config name>`
+      #   - `names=<config name>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::ConfigListParams} for more details.
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/config_list_response.rb

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

data/lib/docker_engine_api/models/config_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Configs#update
+    class ConfigUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   The version number of the config object being updated. This is required to avoid
+      #   conflicting writes.
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!method initialize(version:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::ConfigUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the config object being updated. This is
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end