docker-engine-ruby 0.2.2 → 0.4.0

data/lib/docker_engine_ruby/models/system_events_params.rb

@@ -8,50 +8,24 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute filters
-      #   A JSON encoded value of filters (a `map[string][]string`) to process on the
-      #   event list. Available filters:
-      #
-      #   - `config=<string>` config name or ID
-      #   - `container=<string>` container name or ID
-      #   - `daemon=<string>` daemon name or ID
-      #   - `event=<string>` event type
-      #   - `image=<string>` image name or ID
-      #   - `label=<string>` image or container label
-      #   - `network=<string>` network name or ID
-      #   - `node=<string>` node ID
-      #   - `plugin`=<string> plugin name or ID
-      #   - `scope`=<string> local or swarm
-      #   - `secret=<string>` secret name or ID
-      #   - `service=<string>` service name or ID
-      #   - `type=<string>` object to filter by, one of `container`, `image`, `volume`,
-      #     `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`
-      #   - `volume=<string>` volume name
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!attribute since
-      #   Show events created since this timestamp then stream new events.
       #
       #   @return [String, nil]
       optional :since, String
 
       # @!attribute until_
-      #   Show events created until this timestamp then stop streaming.
       #
       #   @return [String, nil]
       optional :until_, String
 
       # @!method initialize(filters: nil, since: nil, until_: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::SystemEventsParams} for more details.
-      #
-      #   @param filters [String] A JSON encoded value of filters (a `map[string][]string`) to process on the even
-      #
-      #   @param since [String] Show events created since this timestamp then stream new events.
-      #
-      #   @param until_ [String] Show events created until this timestamp then stop streaming.
-      #
+      #   @param filters [String]
+      #   @param since [String]
+      #   @param until_ [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/system_events_response.rb

@@ -75,9 +75,6 @@ module DockerEngineRuby
         optional :id, String, api_name: :ID
 
         # @!method initialize(attributes: nil, id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {DockerEngineRuby::Models::SystemEventsResponse::Actor} for more details.
-        #
         #   Actor describes something that generates events, like a container, network, or a
         #   volume.
         #

data/lib/docker_engine_ruby/models/task.rb

@@ -5,8 +5,6 @@ module DockerEngineRuby
     # @see DockerEngineRuby::Resources::Tasks#inspect_
     class Task < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute assigned_generic_resources
-      #   User-defined resources can be either Integer resources (e.g, `SSD=3`) or String
-      #   resources (e.g, `GPU=UUID1`).
       #
       #   @return [Array<DockerEngineRuby::Models::Task::AssignedGenericResource>, nil]
       optional :assigned_generic_resources,
@@ -17,8 +15,8 @@ module DockerEngineRuby
 
       # @!attribute created_at
       #
-      #   @return [String, nil]
-      optional :created_at, String, api_name: :CreatedAt
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :CreatedAt
 
       # @!attribute desired_state
       #
@@ -77,8 +75,8 @@ module DockerEngineRuby
       # @!attribute spec
       #   User modifiable task configuration.
       #
-      #   @return [DockerEngineRuby::Models::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::Spec }, api_name: :Spec
+      #   @return [DockerEngineRuby::Models::TaskSpec, nil]
+      optional :spec, -> { DockerEngineRuby::TaskSpec }, api_name: :Spec
 
       # @!attribute status
       #   represents the status of a task.
@@ -88,8 +86,8 @@ module DockerEngineRuby
 
       # @!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
@@ -109,9 +107,9 @@ module DockerEngineRuby
       #   Some parameter documentations has been truncated, see
       #   {DockerEngineRuby::Models::Task} for more details.
       #
-      #   @param assigned_generic_resources [Array<DockerEngineRuby::Models::Task::AssignedGenericResource>] User-defined resources can be either Integer resources (e.g, `SSD=3`) or
+      #   @param assigned_generic_resources [Array<DockerEngineRuby::Models::Task::AssignedGenericResource>]
       #
-      #   @param created_at [String]
+      #   @param created_at [Time]
       #
       #   @param desired_state [Symbol, DockerEngineRuby::Models::Task::DesiredState]
       #
@@ -129,11 +127,11 @@ module DockerEngineRuby
       #
       #   @param slot [Integer]
       #
-      #   @param spec [DockerEngineRuby::Models::Spec] User modifiable task configuration.
+      #   @param spec [DockerEngineRuby::Models::TaskSpec] User modifiable task configuration.
       #
       #   @param status [DockerEngineRuby::Models::Task::Status] represents the status of a task.
       #
-      #   @param updated_at [String]
+      #   @param updated_at [Time]
       #
       #   @param version [DockerEngineRuby::Models::Task::Version] The version number of the object such as node, service, etc. This is needed
 
@@ -270,8 +268,8 @@ module DockerEngineRuby
 
         # @!attribute timestamp
         #
-        #   @return [String, nil]
-        optional :timestamp, String, api_name: :Timestamp
+        #   @return [Time, nil]
+        optional :timestamp, Time, api_name: :Timestamp
 
         # @!method initialize(container_status: nil, err: nil, message: nil, port_status: nil, state: nil, timestamp: nil)
         #   Some parameter documentations has been truncated, see
@@ -289,7 +287,7 @@ module DockerEngineRuby
         #
         #   @param state [Symbol, DockerEngineRuby::Models::Task::Status::State]
         #
-        #   @param timestamp [String]
+        #   @param timestamp [Time]
 
         # @see DockerEngineRuby::Models::Task::Status#container_status
         class ContainerStatus < DockerEngineRuby::Internal::Type::BaseModel

data/lib/docker_engine_ruby/models/task_list_params.rb

@@ -8,27 +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
-      #   tasks list.
-      #
-      #   Available filters:
-      #
-      #   - `desired-state=(running | shutdown | accepted)`
-      #   - `id=<task id>`
-      #   - `label=key` or `label="key=value"`
-      #   - `name=<task name>`
-      #   - `node=<node id or name>`
-      #   - `service=<service name>`
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!method initialize(filters: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::TaskListParams} 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/task_logs_params.rb

@@ -8,66 +8,48 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute details
-      #   Show task context and extra details provided to logs.
       #
       #   @return [Boolean, nil]
       optional :details, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute follow
-      #   Keep connection after returning logs.
       #
       #   @return [Boolean, nil]
       optional :follow, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute since
-      #   Only return logs since this time, as a UNIX timestamp
       #
       #   @return [Integer, nil]
       optional :since, Integer
 
       # @!attribute stderr
-      #   Return logs from `stderr`
       #
       #   @return [Boolean, nil]
       optional :stderr, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute stdout
-      #   Return logs from `stdout`
       #
       #   @return [Boolean, nil]
       optional :stdout, DockerEngineRuby::Internal::Type::Boolean
 
       # @!attribute tail
-      #   Only return this number of log lines from the end of the logs. Specify as an
-      #   integer or `all` to output all log lines.
       #
       #   @return [String, nil]
       optional :tail, String
 
       # @!attribute timestamps
-      #   Add timestamps to every log line
       #
       #   @return [Boolean, nil]
       optional :timestamps, DockerEngineRuby::Internal::Type::Boolean
 
       # @!method initialize(details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::TaskLogsParams} for more details.
-      #
-      #   @param details [Boolean] Show task context and extra details provided to logs.
-      #
-      #   @param follow [Boolean] Keep connection after returning logs.
-      #
-      #   @param since [Integer] Only return logs since this time, as a UNIX timestamp
-      #
-      #   @param stderr [Boolean] Return logs from `stderr`
-      #
-      #   @param stdout [Boolean] Return logs from `stdout`
-      #
-      #   @param tail [String] Only return this number of log lines from the end of the logs.
-      #
-      #   @param timestamps [Boolean] Add timestamps to every log line
-      #
+      #   @param details [Boolean]
+      #   @param follow [Boolean]
+      #   @param since [Integer]
+      #   @param stderr [Boolean]
+      #   @param stdout [Boolean]
+      #   @param tail [String]
+      #   @param timestamps [Boolean]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end