docker-engine-ruby 0.2.2 → 0.4.0

data/lib/docker_engine_ruby/models/plugin_privileges_params.rb

@@ -8,18 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute remote
-      #   The name of the plugin. The `:latest` tag is optional, and is the default if
-      #   omitted.
       #
       #   @return [String]
       required :remote, String
 
       # @!method initialize(remote:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::PluginPrivilegesParams} for more details.
-      #
-      #   @param remote [String] The name of the plugin. The `:latest` tag is optional, and is the
-      #
+      #   @param remote [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/plugin_pull_params.rb

@@ -8,43 +8,30 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute remote
-      #   Remote reference for plugin to install.
-      #
-      #   The `:latest` tag is optional, and is used as the default if omitted.
       #
       #   @return [String]
       required :remote, String
 
-      # @!attribute name
-      #   Local name for the pulled plugin.
+      # @!attribute body
       #
-      #   The `:latest` tag is optional, and is used as the default if omitted.
+      #   @return [Array<DockerEngineRuby::Models::Privilege>]
+      required :body, -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Privilege] }
+
+      # @!attribute name
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!attribute body
-      #
-      #   @return [Array<DockerEngineRuby::Models::Privilege>, nil]
-      optional :body, -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Privilege] }
-
       # @!attribute x_registry_auth
       #
       #   @return [String, nil]
       optional :x_registry_auth, String
 
-      # @!method initialize(remote:, name: nil, body: nil, x_registry_auth: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::PluginPullParams} for more details.
-      #
-      #   @param remote [String] Remote reference for plugin to install.
-      #
-      #   @param name [String] Local name for the pulled plugin.
-      #
+      # @!method initialize(remote:, body:, name: nil, x_registry_auth: nil, request_options: {})
+      #   @param remote [String]
       #   @param body [Array<DockerEngineRuby::Models::Privilege>]
-      #
+      #   @param name [String]
       #   @param x_registry_auth [String]
-      #
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/plugin_set_params.rb

@@ -9,10 +9,10 @@ module DockerEngineRuby
 
       # @!attribute body
       #
-      #   @return [Array<String>, nil]
-      optional :body, DockerEngineRuby::Internal::Type::ArrayOf[String]
+      #   @return [Array<String>]
+      required :body, DockerEngineRuby::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(body: nil, request_options: {})
+      # @!method initialize(body:, request_options: {})
       #   @param body [Array<String>]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/docker_engine_ruby/models/plugin_upgrade_params.rb

@@ -8,33 +8,24 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute remote
-      #   Remote reference to upgrade to.
-      #
-      #   The `:latest` tag is optional, and is used as the default if omitted.
       #
       #   @return [String]
       required :remote, String
 
       # @!attribute body
       #
-      #   @return [Array<DockerEngineRuby::Models::Privilege>, nil]
-      optional :body, -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Privilege] }
+      #   @return [Array<DockerEngineRuby::Models::Privilege>]
+      required :body, -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Privilege] }
 
       # @!attribute x_registry_auth
       #
       #   @return [String, nil]
       optional :x_registry_auth, String
 
-      # @!method initialize(remote:, body: nil, x_registry_auth: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::PluginUpgradeParams} for more details.
-      #
-      #   @param remote [String] Remote reference to upgrade to.
-      #
+      # @!method initialize(remote:, body:, x_registry_auth: nil, request_options: {})
+      #   @param remote [String]
       #   @param body [Array<DockerEngineRuby::Models::Privilege>]
-      #
       #   @param x_registry_auth [String]
-      #
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/secret.rb

@@ -6,8 +6,8 @@ module DockerEngineRuby
     class Secret < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute created_at
       #
-      #   @return [String, nil]
-      optional :created_at, String, api_name: :CreatedAt
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :CreatedAt
 
       # @!attribute id
       #
@@ -16,13 +16,13 @@ module DockerEngineRuby
 
       # @!attribute spec
       #
-      #   @return [DockerEngineRuby::Models::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::Spec }, api_name: :Spec
+      #   @return [DockerEngineRuby::Models::SecretSpec, nil]
+      optional :spec, -> { DockerEngineRuby::SecretSpec }, api_name: :Spec
 
       # @!attribute updated_at
       #
-      #   @return [String, nil]
-      optional :updated_at, String, api_name: :UpdatedAt
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :UpdatedAt
 
       # @!attribute version
       #   The version number of the object such as node, service, etc. This is needed to
@@ -42,13 +42,13 @@ module DockerEngineRuby
       #   Some parameter documentations has been truncated, see
       #   {DockerEngineRuby::Models::Secret} for more details.
       #
-      #   @param created_at [String]
+      #   @param created_at [Time]
       #
       #   @param id [String]
       #
-      #   @param spec [DockerEngineRuby::Models::Spec]
+      #   @param spec [DockerEngineRuby::Models::SecretSpec]
       #
-      #   @param updated_at [String]
+      #   @param updated_at [Time]
       #
       #   @param version [DockerEngineRuby::Models::Secret::Version] The version number of the object such as node, service, etc. This is needed
 

data/lib/docker_engine_ruby/models/secret_create_params.rb

@@ -7,18 +7,8 @@ module DockerEngineRuby
       extend DockerEngineRuby::Internal::Type::RequestParameters::Converter
       include DockerEngineRuby::Internal::Type::RequestParameters
 
-      # @!attribute spec
-      #
-      #   @return [DockerEngineRuby::Models::SecretCreateParams::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::SecretCreateParams::Spec }
-
-      # @!method initialize(spec: nil, request_options: {})
-      #   @param spec [DockerEngineRuby::Models::SecretCreateParams::Spec]
+      # @!method initialize(request_options: {})
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
-
-      class Spec < DockerEngineRuby::Models::Spec
-        # @!method initialize
-      end
     end
   end
 end

data/lib/docker_engine_ruby/models/secret_list_params.rb

@@ -8,25 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute filters
-      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      #   secrets list.
-      #
-      #   Available filters:
-      #
-      #   - `id=<secret id>`
-      #   - `label=<key> or label=<key>=value`
-      #   - `name=<secret name>`
-      #   - `names=<secret name>`
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!method initialize(filters: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::SecretListParams} for more details.
-      #
-      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
-      #
+      #   @param filters [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/secret_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    class SecretSpec < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #   Data is the data to store as a secret, formatted as a standard base64-encoded
+      #   ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. It must be
+      #   empty if the Driver field is set, in which case the data is loaded from an
+      #   external secret store. The maximum allowed size is 500KB, as defined in
+      #   [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+      #
+      #   @return [String, nil]
+      optional :data, String, api_name: :Data
+
+      # @!attribute driver
+      #   Driver represents a driver (network, logging, secrets).
+      #
+      #   @return [DockerEngineRuby::Models::SecretSpec::Driver, nil]
+      optional :driver, -> { DockerEngineRuby::SecretSpec::Driver }, api_name: :Driver
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   User-defined name of the secret.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute templating
+      #   Driver represents a driver (network, logging, secrets).
+      #
+      #   @return [DockerEngineRuby::Models::SecretSpec::Templating, nil]
+      optional :templating, -> { DockerEngineRuby::SecretSpec::Templating }, api_name: :Templating
+
+      # @!method initialize(data: nil, driver: nil, labels: nil, name: nil, templating: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::SecretSpec} for more details.
+      #
+      #   @param data [String] Data is the data to store as a secret, formatted as a standard base64-encoded
+      #
+      #   @param driver [DockerEngineRuby::Models::SecretSpec::Driver] Driver represents a driver (network, logging, secrets).
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param name [String] User-defined name of the secret.
+      #
+      #   @param templating [DockerEngineRuby::Models::SecretSpec::Templating] Driver represents a driver (network, logging, secrets).
+
+      # @see DockerEngineRuby::Models::SecretSpec#driver
+      class Driver < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the driver.
+        #
+        #   @return [String]
+        required :name, String, api_name: :Name
+
+        # @!attribute options
+        #   Key/value map of driver-specific options.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(name:, options: nil)
+        #   Driver represents a driver (network, logging, secrets).
+        #
+        #   @param name [String] Name of the driver.
+        #
+        #   @param options [Hash{Symbol=>String}] Key/value map of driver-specific options.
+      end
+
+      # @see DockerEngineRuby::Models::SecretSpec#templating
+      class Templating < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the driver.
+        #
+        #   @return [String]
+        required :name, String, api_name: :Name
+
+        # @!attribute options
+        #   Key/value map of driver-specific options.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(name:, options: nil)
+        #   Driver represents a driver (network, logging, secrets).
+        #
+        #   @param name [String] Name of the driver.
+        #
+        #   @param options [Hash{Symbol=>String}] Key/value map of driver-specific options.
+      end
+    end
+  end
+end

data/lib/docker_engine_ruby/models/secret_update_params.rb

@@ -8,18 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute version
-      #   The version number of the secret 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
-      #   {DockerEngineRuby::Models::SecretUpdateParams} for more details.
-      #
-      #   @param version [Integer] The version number of the secret object being updated. This is
-      #
+      #   @param version [Integer]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/service.rb

@@ -6,8 +6,8 @@ module DockerEngineRuby
     class Service < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute created_at
       #
-      #   @return [String, nil]
-      optional :created_at, String, api_name: :CreatedAt
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :CreatedAt
 
       # @!attribute endpoint
       #
@@ -38,13 +38,13 @@ module DockerEngineRuby
       # @!attribute spec
       #   User modifiable configuration for a service.
       #
-      #   @return [DockerEngineRuby::Models::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::Spec }, api_name: :Spec
+      #   @return [DockerEngineRuby::Models::ServiceSpec, nil]
+      optional :spec, -> { DockerEngineRuby::ServiceSpec }, api_name: :Spec
 
       # @!attribute updated_at
       #
-      #   @return [String, nil]
-      optional :updated_at, String, api_name: :UpdatedAt
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :UpdatedAt
 
       # @!attribute update_status
       #   The status of a service update.
@@ -70,7 +70,7 @@ module DockerEngineRuby
       #   Some parameter documentations has been truncated, see
       #   {DockerEngineRuby::Models::Service} for more details.
       #
-      #   @param created_at [String]
+      #   @param created_at [Time]
       #
       #   @param endpoint [DockerEngineRuby::Models::Service::Endpoint]
       #
@@ -80,9 +80,9 @@ module DockerEngineRuby
       #
       #   @param service_status [DockerEngineRuby::Models::Service::ServiceStatus] The status of the service's tasks. Provided only when requested as
       #
-      #   @param spec [DockerEngineRuby::Models::Spec] User modifiable configuration for a service.
+      #   @param spec [DockerEngineRuby::Models::ServiceSpec] User modifiable configuration for a service.
       #
-      #   @param updated_at [String]
+      #   @param updated_at [Time]
       #
       #   @param update_status [DockerEngineRuby::Models::Service::UpdateStatus] The status of a service update.
       #
@@ -374,10 +374,9 @@ module DockerEngineRuby
                  api_name: :JobIteration
 
         # @!attribute last_execution
-        #   The last time, as observed by the server, that this job was started.
         #
-        #   @return [String, nil]
-        optional :last_execution, String, api_name: :LastExecution
+        #   @return [Time, nil]
+        optional :last_execution, Time, api_name: :LastExecution
 
         # @!method initialize(job_iteration: nil, last_execution: nil)
         #   Some parameter documentations has been truncated, see
@@ -390,7 +389,7 @@ module DockerEngineRuby
         #
         #   @param job_iteration [DockerEngineRuby::Models::Service::JobStatus::JobIteration] The version number of the object such as node, service, etc. This is needed
         #
-        #   @param last_execution [String] The last time, as observed by the server, that this job was
+        #   @param last_execution [Time]
 
         # @see DockerEngineRuby::Models::Service::JobStatus#job_iteration
         class JobIteration < DockerEngineRuby::Internal::Type::BaseModel
@@ -417,49 +416,35 @@ module DockerEngineRuby
       # @see DockerEngineRuby::Models::Service#service_status
       class ServiceStatus < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute completed_tasks
-        #   The number of tasks for a job that are in the Completed state. This field must
-        #   be cross-referenced with the service type, as the value of 0 may mean the
-        #   service is not in a job mode, or it may mean the job-mode service has no tasks
-        #   yet Completed.
         #
         #   @return [Integer, nil]
         optional :completed_tasks, Integer, api_name: :CompletedTasks
 
         # @!attribute desired_tasks
-        #   The number of tasks for the service desired to be running. For replicated
-        #   services, this is the replica count from the service spec. For global services,
-        #   this is computed by taking count of all tasks for the service with a Desired
-        #   State other than Shutdown.
         #
         #   @return [Integer, nil]
         optional :desired_tasks, Integer, api_name: :DesiredTasks
 
         # @!attribute running_tasks
-        #   The number of tasks for the service currently in the Running state.
         #
         #   @return [Integer, nil]
         optional :running_tasks, Integer, api_name: :RunningTasks
 
         # @!method initialize(completed_tasks: nil, desired_tasks: nil, running_tasks: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {DockerEngineRuby::Models::Service::ServiceStatus} for more details.
-        #
         #   The status of the service's tasks. Provided only when requested as part of a
         #   ServiceList operation.
         #
-        #   @param completed_tasks [Integer] The number of tasks for a job that are in the Completed state.
-        #
-        #   @param desired_tasks [Integer] The number of tasks for the service desired to be running.
-        #
-        #   @param running_tasks [Integer] The number of tasks for the service currently in the Running state.
+        #   @param completed_tasks [Integer]
+        #   @param desired_tasks [Integer]
+        #   @param running_tasks [Integer]
       end
 
       # @see DockerEngineRuby::Models::Service#update_status
       class UpdateStatus < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute completed_at
         #
-        #   @return [String, nil]
-        optional :completed_at, String, api_name: :CompletedAt
+        #   @return [Time, nil]
+        optional :completed_at, Time, api_name: :CompletedAt
 
         # @!attribute message
         #
@@ -468,8 +453,8 @@ module DockerEngineRuby
 
         # @!attribute started_at
         #
-        #   @return [String, nil]
-        optional :started_at, String, api_name: :StartedAt
+        #   @return [Time, nil]
+        optional :started_at, Time, api_name: :StartedAt
 
         # @!attribute state
         #
@@ -479,9 +464,9 @@ module DockerEngineRuby
         # @!method initialize(completed_at: nil, message: nil, started_at: nil, state: nil)
         #   The status of a service update.
         #
-        #   @param completed_at [String]
+        #   @param completed_at [Time]
         #   @param message [String]
-        #   @param started_at [String]
+        #   @param started_at [Time]
         #   @param state [Symbol, DockerEngineRuby::Models::Service::UpdateStatus::State]
 
         # @see DockerEngineRuby::Models::Service::UpdateStatus#state

data/lib/docker_engine_ruby/models/service_create_params.rb

@@ -7,28 +7,14 @@ module DockerEngineRuby
       extend DockerEngineRuby::Internal::Type::RequestParameters::Converter
       include DockerEngineRuby::Internal::Type::RequestParameters
 
-      # @!attribute spec
-      #   User modifiable configuration for a service.
-      #
-      #   @return [DockerEngineRuby::Models::ServiceCreateParams::Spec]
-      required :spec, -> { DockerEngineRuby::ServiceCreateParams::Spec }
-
       # @!attribute x_registry_auth
       #
       #   @return [String, nil]
       optional :x_registry_auth, String
 
-      # @!method initialize(spec:, x_registry_auth: nil, request_options: {})
-      #   @param spec [DockerEngineRuby::Models::ServiceCreateParams::Spec] User modifiable configuration for a service.
-      #
+      # @!method initialize(x_registry_auth: nil, request_options: {})
       #   @param x_registry_auth [String]
-      #
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
-
-      class Spec < DockerEngineRuby::Models::Spec
-        # @!method initialize
-        #   User modifiable configuration for a service.
-      end
     end
   end
 end

data/lib/docker_engine_ruby/models/service_create_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    # @see DockerEngineRuby::Resources::Services#create
+    class ServiceCreateResponse < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the created service.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute warnings
+      #   Optional warning message.
+      #
+      #   FIXME(thaJeztah): this should have "omitempty" in the generated type.
+      #
+      #   @return [Array<String>, nil]
+      optional :warnings, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Warnings, nil?: true
+
+      # @!method initialize(id: nil, warnings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::ServiceCreateResponse} for more details.
+      #
+      #   contains the information returned to a client on the creation of a new service.
+      #
+      #   @param id [String] The ID of the created service.
+      #
+      #   @param warnings [Array<String>, nil] Optional warning message.
+    end
+  end
+end

data/lib/docker_engine_ruby/models/service_inspect_params.rb

@@ -8,14 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute insert_defaults
-      #   Fill empty fields with default values.
       #
       #   @return [Boolean, nil]
       optional :insert_defaults, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(insert_defaults: nil, request_options: {})
-      #   @param insert_defaults [Boolean] Fill empty fields with default values.
-      #
+      #   @param insert_defaults [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/service_list_params.rb

@@ -8,33 +8,18 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute filters
-      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
-      #   services list.
-      #
-      #   Available filters:
-      #
-      #   - `id=<service id>`
-      #   - `label=<service label>`
-      #   - `mode=["replicated"|"global"]`
-      #   - `name=<service name>`
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!attribute status
-      #   Include service status, with count of running and desired tasks.
       #
       #   @return [Boolean, nil]
       optional :status, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(filters: nil, status: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::ServiceListParams} for more details.
-      #
-      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
-      #
-      #   @param status [Boolean] Include service status, with count of running and desired tasks.
-      #
+      #   @param filters [String]
+      #   @param status [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end