docker-engine-api 0.2.1

data/lib/docker_engine_api/models/plugin_privileges_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Plugins#privileges
+    class PluginPrivilegesParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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
+      #   {DockerEngineAPI::Models::PluginPrivilegesParams} for more details.
+      #
+      #   @param remote [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/plugin_privileges_response.rb

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

data/lib/docker_engine_api/models/plugin_pull_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Plugins#pull
+    class PluginPullParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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.
+      #
+      #   The `:latest` tag is optional, and is used as the default if omitted.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute body
+      #
+      #   @return [Array<DockerEngineAPI::Models::Privilege>, nil]
+      optional :body, -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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
+      #   {DockerEngineAPI::Models::PluginPullParams} for more details.
+      #
+      #   @param remote [String] Remote reference for plugin to install.
+      #
+      #   @param name [String] Local name for the pulled plugin.
+      #
+      #   @param body [Array<DockerEngineAPI::Models::Privilege>]
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/plugin_push_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Plugins#push
+    class PluginPushParams < 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/plugin_set_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Plugins#set
+    class PluginSetParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [Array<String>, nil]
+      optional :body, DockerEngineAPI::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(body: nil, request_options: {})
+      #   @param body [Array<String>]
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/plugin_upgrade_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Plugins#upgrade
+    class PluginUpgradeParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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<DockerEngineAPI::Models::Privilege>, nil]
+      optional :body, -> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::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
+      #   {DockerEngineAPI::Models::PluginUpgradeParams} for more details.
+      #
+      #   @param remote [String] Remote reference to upgrade to.
+      #
+      #   @param body [Array<DockerEngineAPI::Models::Privilege>]
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/privilege.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class Privilege < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, api_name: :Description
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute value
+      #
+      #   @return [Array<String>, nil]
+      optional :value, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Value
+
+      # @!method initialize(description: nil, name: nil, value: nil)
+      #   Describes a permission the user has to accept upon installing the plugin.
+      #
+      #   @param description [String]
+      #   @param name [String]
+      #   @param value [Array<String>]
+    end
+  end
+end

data/lib/docker_engine_api/models/secret.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#inspect_
+    class Secret < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute created_at
+      #
+      #   @return [String, nil]
+      optional :created_at, String, api_name: :CreatedAt
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngineAPI::Models::Spec, nil]
+      optional :spec, -> { DockerEngineAPI::Spec }, api_name: :Spec
+
+      # @!attribute updated_at
+      #
+      #   @return [String, nil]
+      optional :updated_at, String, api_name: :UpdatedAt
+
+      # @!attribute version
+      #   The version number of the object such as node, service, etc. This is needed to
+      #   avoid conflicting writes. The client must send the version number along with the
+      #   modified specification when updating these objects.
+      #
+      #   This approach ensures safe concurrency and determinism in that the change on the
+      #   object may not be applied if the version number has changed from the last read.
+      #   In other words, if two update requests specify the same base version, only one
+      #   of the requests can succeed. As a result, two separate update requests that
+      #   happen at the same time will not unintentionally overwrite each other.
+      #
+      #   @return [DockerEngineAPI::Models::Secret::Version, nil]
+      optional :version, -> { DockerEngineAPI::Secret::Version }, api_name: :Version
+
+      # @!method initialize(created_at: nil, id: nil, spec: nil, updated_at: nil, version: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::Secret} for more details.
+      #
+      #   @param created_at [String]
+      #
+      #   @param id [String]
+      #
+      #   @param spec [DockerEngineAPI::Models::Spec]
+      #
+      #   @param updated_at [String]
+      #
+      #   @param version [DockerEngineAPI::Models::Secret::Version] The version number of the object such as node, service, etc. This is needed
+
+      # @see DockerEngineAPI::Models::Secret#version
+      class Version < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute index
+        #
+        #   @return [Integer, nil]
+        optional :index, Integer, api_name: :Index
+
+        # @!method initialize(index: nil)
+        #   The version number of the object such as node, service, etc. This is needed to
+        #   avoid conflicting writes. The client must send the version number along with the
+        #   modified specification when updating these objects.
+        #
+        #   This approach ensures safe concurrency and determinism in that the change on the
+        #   object may not be applied if the version number has changed from the last read.
+        #   In other words, if two update requests specify the same base version, only one
+        #   of the requests can succeed. As a result, two separate update requests that
+        #   happen at the same time will not unintentionally overwrite each other.
+        #
+        #   @param index [Integer]
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/secret_create_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#create
+    class SecretCreateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngineAPI::Models::SecretCreateParams::Spec, nil]
+      optional :spec, -> { DockerEngineAPI::SecretCreateParams::Spec }
+
+      # @!method initialize(spec: nil, request_options: {})
+      #   @param spec [DockerEngineAPI::Models::SecretCreateParams::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/secret_create_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#create
+    class SecretCreateResponse < 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/secret_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#delete
+    class SecretDeleteParams < 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/secret_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#inspect_
+    class SecretInspectParams < 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/secret_list_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#list
+    class SecretListParams < 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
+      #   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
+      #   {DockerEngineAPI::Models::SecretListParams} 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/secret_list_response.rb

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

data/lib/docker_engine_api/models/secret_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Secrets#update
+    class SecretUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::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
+      #   {DockerEngineAPI::Models::SecretUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the secret object being updated. This is
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end