docker-engine-api 0.2.1

data/sig/docker_engine_api/models/version.rbs

@@ -0,0 +1,127 @@
+module DockerEngineAPI
+  module Models
+    type version =
+      {
+        api_version: String,
+        arch: String,
+        build_time: String,
+        components: ::Array[DockerEngineAPI::Version::Component],
+        experimental: bool,
+        git_commit: String,
+        go_version: String,
+        kernel_version: String,
+        min_api_version: String,
+        os: String,
+        platform: DockerEngineAPI::Version::Platform,
+        version: String
+      }
+
+    class Version < DockerEngineAPI::Internal::Type::BaseModel
+      attr_reader api_version: String?
+
+      def api_version=: (String) -> String
+
+      attr_reader arch: String?
+
+      def arch=: (String) -> String
+
+      attr_reader build_time: String?
+
+      def build_time=: (String) -> String
+
+      attr_reader components: ::Array[DockerEngineAPI::Version::Component]?
+
+      def components=: (
+        ::Array[DockerEngineAPI::Version::Component]
+      ) -> ::Array[DockerEngineAPI::Version::Component]
+
+      attr_reader experimental: bool?
+
+      def experimental=: (bool) -> bool
+
+      attr_reader git_commit: String?
+
+      def git_commit=: (String) -> String
+
+      attr_reader go_version: String?
+
+      def go_version=: (String) -> String
+
+      attr_reader kernel_version: String?
+
+      def kernel_version=: (String) -> String
+
+      attr_reader min_api_version: String?
+
+      def min_api_version=: (String) -> String
+
+      attr_reader os: String?
+
+      def os=: (String) -> String
+
+      attr_reader platform: DockerEngineAPI::Version::Platform?
+
+      def platform=: (
+        DockerEngineAPI::Version::Platform
+      ) -> DockerEngineAPI::Version::Platform
+
+      attr_reader version: String?
+
+      def version=: (String) -> String
+
+      def initialize: (
+        ?api_version: String,
+        ?arch: String,
+        ?build_time: String,
+        ?components: ::Array[DockerEngineAPI::Version::Component],
+        ?experimental: bool,
+        ?git_commit: String,
+        ?go_version: String,
+        ?kernel_version: String,
+        ?min_api_version: String,
+        ?os: String,
+        ?platform: DockerEngineAPI::Version::Platform,
+        ?version: String
+      ) -> void
+
+      def to_hash: -> {
+        api_version: String,
+        arch: String,
+        build_time: String,
+        components: ::Array[DockerEngineAPI::Version::Component],
+        experimental: bool,
+        git_commit: String,
+        go_version: String,
+        kernel_version: String,
+        min_api_version: String,
+        os: String,
+        platform: DockerEngineAPI::Version::Platform,
+        version: String
+      }
+
+      type component = { name: String, version: String, details: top? }
+
+      class Component < DockerEngineAPI::Internal::Type::BaseModel
+        attr_accessor name: String
+
+        attr_accessor version: String
+
+        attr_accessor details: top?
+
+        def initialize: (name: String, version: String, ?details: top?) -> void
+
+        def to_hash: -> { name: String, version: String, details: top? }
+      end
+
+      type platform = { name: String }
+
+      class Platform < DockerEngineAPI::Internal::Type::BaseModel
+        attr_accessor name: String
+
+        def initialize: (name: String) -> void
+
+        def to_hash: -> { name: String }
+      end
+    end
+  end
+end

data/sig/docker_engine_api/models/volume.rbs

@@ -0,0 +1,478 @@
+module DockerEngineAPI
+  module Models
+    type volume =
+      {
+        driver: String,
+        labels: ::Hash[Symbol, String],
+        mountpoint: String,
+        name: String,
+        options: ::Hash[Symbol, String],
+        scope: DockerEngineAPI::Models::Volume::scope,
+        cluster_volume: DockerEngineAPI::Volume::ClusterVolume,
+        created_at: String,
+        status: ::Hash[Symbol, top],
+        usage_data: DockerEngineAPI::Volume::UsageData?
+      }
+
+    class Volume < DockerEngineAPI::Internal::Type::BaseModel
+      attr_accessor driver: String
+
+      attr_accessor labels: ::Hash[Symbol, String]
+
+      attr_accessor mountpoint: String
+
+      attr_accessor name: String
+
+      attr_accessor options: ::Hash[Symbol, String]
+
+      attr_accessor scope: DockerEngineAPI::Models::Volume::scope
+
+      attr_reader cluster_volume: DockerEngineAPI::Volume::ClusterVolume?
+
+      def cluster_volume=: (
+        DockerEngineAPI::Volume::ClusterVolume
+      ) -> DockerEngineAPI::Volume::ClusterVolume
+
+      attr_reader created_at: String?
+
+      def created_at=: (String) -> String
+
+      attr_reader status: ::Hash[Symbol, top]?
+
+      def status=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_accessor usage_data: DockerEngineAPI::Volume::UsageData?
+
+      def initialize: (
+        driver: String,
+        labels: ::Hash[Symbol, String],
+        mountpoint: String,
+        name: String,
+        options: ::Hash[Symbol, String],
+        scope: DockerEngineAPI::Models::Volume::scope,
+        ?cluster_volume: DockerEngineAPI::Volume::ClusterVolume,
+        ?created_at: String,
+        ?status: ::Hash[Symbol, top],
+        ?usage_data: DockerEngineAPI::Volume::UsageData?
+      ) -> void
+
+      def to_hash: -> {
+        driver: String,
+        labels: ::Hash[Symbol, String],
+        mountpoint: String,
+        name: String,
+        options: ::Hash[Symbol, String],
+        scope: DockerEngineAPI::Models::Volume::scope,
+        cluster_volume: DockerEngineAPI::Volume::ClusterVolume,
+        created_at: String,
+        status: ::Hash[Symbol, top],
+        usage_data: DockerEngineAPI::Volume::UsageData?
+      }
+
+      type scope = :local | :global
+
+      module Scope
+        extend DockerEngineAPI::Internal::Type::Enum
+
+        LOCAL: :local
+        GLOBAL: :global
+
+        def self?.values: -> ::Array[DockerEngineAPI::Models::Volume::scope]
+      end
+
+      type cluster_volume =
+        {
+          created_at: String,
+          id: String,
+          info: DockerEngineAPI::Volume::ClusterVolume::Info,
+          publish_status: ::Array[DockerEngineAPI::Volume::ClusterVolume::PublishStatus],
+          spec: DockerEngineAPI::Volume::ClusterVolume::Spec,
+          updated_at: String,
+          version: DockerEngineAPI::Volume::ClusterVolume::Version
+        }
+
+      class ClusterVolume < DockerEngineAPI::Internal::Type::BaseModel
+        attr_reader created_at: String?
+
+        def created_at=: (String) -> String
+
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader info: DockerEngineAPI::Volume::ClusterVolume::Info?
+
+        def info=: (
+          DockerEngineAPI::Volume::ClusterVolume::Info
+        ) -> DockerEngineAPI::Volume::ClusterVolume::Info
+
+        attr_reader publish_status: ::Array[DockerEngineAPI::Volume::ClusterVolume::PublishStatus]?
+
+        def publish_status=: (
+          ::Array[DockerEngineAPI::Volume::ClusterVolume::PublishStatus]
+        ) -> ::Array[DockerEngineAPI::Volume::ClusterVolume::PublishStatus]
+
+        attr_reader spec: DockerEngineAPI::Volume::ClusterVolume::Spec?
+
+        def spec=: (
+          DockerEngineAPI::Volume::ClusterVolume::Spec
+        ) -> DockerEngineAPI::Volume::ClusterVolume::Spec
+
+        attr_reader updated_at: String?
+
+        def updated_at=: (String) -> String
+
+        attr_reader version: DockerEngineAPI::Volume::ClusterVolume::Version?
+
+        def version=: (
+          DockerEngineAPI::Volume::ClusterVolume::Version
+        ) -> DockerEngineAPI::Volume::ClusterVolume::Version
+
+        def initialize: (
+          ?created_at: String,
+          ?id: String,
+          ?info: DockerEngineAPI::Volume::ClusterVolume::Info,
+          ?publish_status: ::Array[DockerEngineAPI::Volume::ClusterVolume::PublishStatus],
+          ?spec: DockerEngineAPI::Volume::ClusterVolume::Spec,
+          ?updated_at: String,
+          ?version: DockerEngineAPI::Volume::ClusterVolume::Version
+        ) -> void
+
+        def to_hash: -> {
+          created_at: String,
+          id: String,
+          info: DockerEngineAPI::Volume::ClusterVolume::Info,
+          publish_status: ::Array[DockerEngineAPI::Volume::ClusterVolume::PublishStatus],
+          spec: DockerEngineAPI::Volume::ClusterVolume::Spec,
+          updated_at: String,
+          version: DockerEngineAPI::Volume::ClusterVolume::Version
+        }
+
+        type info =
+          {
+            accessible_topology: ::Array[::Hash[Symbol, String]],
+            capacity_bytes: Integer,
+            volume_context: ::Hash[Symbol, String],
+            volume_id: String
+          }
+
+        class Info < DockerEngineAPI::Internal::Type::BaseModel
+          attr_reader accessible_topology: ::Array[::Hash[Symbol, String]]?
+
+          def accessible_topology=: (
+            ::Array[::Hash[Symbol, String]]
+          ) -> ::Array[::Hash[Symbol, String]]
+
+          attr_reader capacity_bytes: Integer?
+
+          def capacity_bytes=: (Integer) -> Integer
+
+          attr_reader volume_context: ::Hash[Symbol, String]?
+
+          def volume_context=: (
+            ::Hash[Symbol, String]
+          ) -> ::Hash[Symbol, String]
+
+          attr_reader volume_id: String?
+
+          def volume_id=: (String) -> String
+
+          def initialize: (
+            ?accessible_topology: ::Array[::Hash[Symbol, String]],
+            ?capacity_bytes: Integer,
+            ?volume_context: ::Hash[Symbol, String],
+            ?volume_id: String
+          ) -> void
+
+          def to_hash: -> {
+            accessible_topology: ::Array[::Hash[Symbol, String]],
+            capacity_bytes: Integer,
+            volume_context: ::Hash[Symbol, String],
+            volume_id: String
+          }
+        end
+
+        type publish_status =
+          {
+            node_id: String,
+            publish_context: ::Hash[Symbol, String],
+            state: DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state
+          }
+
+        class PublishStatus < DockerEngineAPI::Internal::Type::BaseModel
+          attr_reader node_id: String?
+
+          def node_id=: (String) -> String
+
+          attr_reader publish_context: ::Hash[Symbol, String]?
+
+          def publish_context=: (
+            ::Hash[Symbol, String]
+          ) -> ::Hash[Symbol, String]
+
+          attr_reader state: DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state?
+
+          def state=: (
+            DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state
+          ) -> DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state
+
+          def initialize: (
+            ?node_id: String,
+            ?publish_context: ::Hash[Symbol, String],
+            ?state: DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state
+          ) -> void
+
+          def to_hash: -> {
+            node_id: String,
+            publish_context: ::Hash[Symbol, String],
+            state: DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state
+          }
+
+          type state =
+            :"pending-publish"
+            | :published
+            | :"pending-node-unpublish"
+            | :"pending-controller-unpublish"
+
+          module State
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            PENDING_PUBLISH: :"pending-publish"
+            PUBLISHED: :published
+            PENDING_NODE_UNPUBLISH: :"pending-node-unpublish"
+            PENDING_CONTROLLER_UNPUBLISH: :"pending-controller-unpublish"
+
+            def self?.values: -> ::Array[DockerEngineAPI::Models::Volume::ClusterVolume::PublishStatus::state]
+          end
+        end
+
+        type spec =
+          {
+            access_mode: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode,
+            group: String
+          }
+
+        class Spec < DockerEngineAPI::Internal::Type::BaseModel
+          attr_reader access_mode: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode?
+
+          def access_mode=: (
+            DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode
+          ) -> DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode
+
+          attr_reader group: String?
+
+          def group=: (String) -> String
+
+          def initialize: (
+            ?access_mode: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode,
+            ?group: String
+          ) -> void
+
+          def to_hash: -> {
+            access_mode: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode,
+            group: String
+          }
+
+          type access_mode =
+            {
+              accessibility_requirements: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements,
+              availability: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability,
+              capacity_range: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::CapacityRange,
+              mount_volume: top,
+              scope: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope,
+              secrets: ::Array[DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::Secret],
+              sharing: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing
+            }
+
+          class AccessMode < DockerEngineAPI::Internal::Type::BaseModel
+            attr_reader accessibility_requirements: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements?
+
+            def accessibility_requirements=: (
+              DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements
+            ) -> DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements
+
+            attr_reader availability: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability?
+
+            def availability=: (
+              DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability
+            ) -> DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability
+
+            attr_reader capacity_range: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::CapacityRange?
+
+            def capacity_range=: (
+              DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::CapacityRange
+            ) -> DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::CapacityRange
+
+            attr_reader mount_volume: top?
+
+            def mount_volume=: (top) -> top
+
+            attr_reader scope: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope?
+
+            def scope=: (
+              DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope
+            ) -> DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope
+
+            attr_reader secrets: ::Array[DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::Secret]?
+
+            def secrets=: (
+              ::Array[DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::Secret]
+            ) -> ::Array[DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::Secret]
+
+            attr_reader sharing: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing?
+
+            def sharing=: (
+              DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing
+            ) -> DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing
+
+            def initialize: (
+              ?accessibility_requirements: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements,
+              ?availability: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability,
+              ?capacity_range: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::CapacityRange,
+              ?mount_volume: top,
+              ?scope: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope,
+              ?secrets: ::Array[DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::Secret],
+              ?sharing: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing
+            ) -> void
+
+            def to_hash: -> {
+              accessibility_requirements: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::AccessibilityRequirements,
+              availability: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability,
+              capacity_range: DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::CapacityRange,
+              mount_volume: top,
+              scope: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope,
+              secrets: ::Array[DockerEngineAPI::Volume::ClusterVolume::Spec::AccessMode::Secret],
+              sharing: DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing
+            }
+
+            type accessibility_requirements =
+              {
+                preferred: ::Array[::Hash[Symbol, String]],
+                requisite: ::Array[::Hash[Symbol, String]]
+              }
+
+            class AccessibilityRequirements < DockerEngineAPI::Internal::Type::BaseModel
+              attr_reader preferred: ::Array[::Hash[Symbol, String]]?
+
+              def preferred=: (
+                ::Array[::Hash[Symbol, String]]
+              ) -> ::Array[::Hash[Symbol, String]]
+
+              attr_reader requisite: ::Array[::Hash[Symbol, String]]?
+
+              def requisite=: (
+                ::Array[::Hash[Symbol, String]]
+              ) -> ::Array[::Hash[Symbol, String]]
+
+              def initialize: (
+                ?preferred: ::Array[::Hash[Symbol, String]],
+                ?requisite: ::Array[::Hash[Symbol, String]]
+              ) -> void
+
+              def to_hash: -> {
+                preferred: ::Array[::Hash[Symbol, String]],
+                requisite: ::Array[::Hash[Symbol, String]]
+              }
+            end
+
+            type availability = :active | :pause | :drain
+
+            module Availability
+              extend DockerEngineAPI::Internal::Type::Enum
+
+              ACTIVE: :active
+              PAUSE: :pause
+              DRAIN: :drain
+
+              def self?.values: -> ::Array[DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::availability]
+            end
+
+            type capacity_range =
+              { limit_bytes: Integer, required_bytes: Integer }
+
+            class CapacityRange < DockerEngineAPI::Internal::Type::BaseModel
+              attr_reader limit_bytes: Integer?
+
+              def limit_bytes=: (Integer) -> Integer
+
+              attr_reader required_bytes: Integer?
+
+              def required_bytes=: (Integer) -> Integer
+
+              def initialize: (
+                ?limit_bytes: Integer,
+                ?required_bytes: Integer
+              ) -> void
+
+              def to_hash: -> { limit_bytes: Integer, required_bytes: Integer }
+            end
+
+            type scope = :single | :multi
+
+            module Scope
+              extend DockerEngineAPI::Internal::Type::Enum
+
+              SINGLE: :single
+              MULTI: :multi
+
+              def self?.values: -> ::Array[DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::scope]
+            end
+
+            type secret = { key: String, secret: String }
+
+            class Secret < DockerEngineAPI::Internal::Type::BaseModel
+              attr_reader key: String?
+
+              def key=: (String) -> String
+
+              attr_reader secret: String?
+
+              def secret=: (String) -> String
+
+              def initialize: (?key: String, ?secret: String) -> void
+
+              def to_hash: -> { key: String, secret: String }
+            end
+
+            type sharing = :none | :readonly | :onewriter | :all
+
+            module Sharing
+              extend DockerEngineAPI::Internal::Type::Enum
+
+              NONE: :none
+              READONLY: :readonly
+              ONEWRITER: :onewriter
+              ALL: :all
+
+              def self?.values: -> ::Array[DockerEngineAPI::Models::Volume::ClusterVolume::Spec::AccessMode::sharing]
+            end
+          end
+        end
+
+        type version = { index: Integer }
+
+        class Version < DockerEngineAPI::Internal::Type::BaseModel
+          attr_reader index: Integer?
+
+          def index=: (Integer) -> Integer
+
+          def initialize: (?index: Integer) -> void
+
+          def to_hash: -> { index: Integer }
+        end
+      end
+
+      type usage_data = { ref_count: Integer, size: Integer }
+
+      class UsageData < DockerEngineAPI::Internal::Type::BaseModel
+        attr_accessor ref_count: Integer
+
+        attr_accessor size: Integer
+
+        def initialize: (ref_count: Integer, size: Integer) -> void
+
+        def to_hash: -> { ref_count: Integer, size: Integer }
+      end
+    end
+  end
+end

data/sig/docker_engine_api/models/volume_create_params.rbs

@@ -0,0 +1,15 @@
+module DockerEngineAPI
+  module Models
+    type volume_create_params =
+      {  } & DockerEngineAPI::Internal::Type::request_parameters
+
+    class VolumeCreateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: DockerEngineAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: DockerEngineAPI::RequestOptions }
+    end
+  end
+end

data/sig/docker_engine_api/models/volume_delete_params.rbs

@@ -0,0 +1,25 @@
+module DockerEngineAPI
+  module Models
+    type volume_delete_params =
+      { force: bool } & DockerEngineAPI::Internal::Type::request_parameters
+
+    class VolumeDeleteParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      attr_reader force: bool?
+
+      def force=: (bool) -> bool
+
+      def initialize: (
+        ?force: bool,
+        ?request_options: DockerEngineAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        force: bool,
+        request_options: DockerEngineAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/docker_engine_api/models/volume_inspect_params.rbs

@@ -0,0 +1,15 @@
+module DockerEngineAPI
+  module Models
+    type volume_inspect_params =
+      {  } & DockerEngineAPI::Internal::Type::request_parameters
+
+    class VolumeInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: DockerEngineAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: DockerEngineAPI::RequestOptions }
+    end
+  end
+end

data/sig/docker_engine_api/models/volume_list_params.rbs

@@ -0,0 +1,25 @@
+module DockerEngineAPI
+  module Models
+    type volume_list_params =
+      { filters: String } & DockerEngineAPI::Internal::Type::request_parameters
+
+    class VolumeListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      attr_reader filters: String?
+
+      def filters=: (String) -> String
+
+      def initialize: (
+        ?filters: String,
+        ?request_options: DockerEngineAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        filters: String,
+        request_options: DockerEngineAPI::RequestOptions
+      }
+    end
+  end
+end