docker-api-ng 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +202 -0
  3. data/NOTICE +12 -0
  4. data/README.md +278 -0
  5. data/docker-api-ng.gemspec +42 -0
  6. data/docs/building-images.md +98 -0
  7. data/docs/connecting.md +111 -0
  8. data/docs/errors.md +89 -0
  9. data/docs/exec.md +100 -0
  10. data/docs/extending.md +109 -0
  11. data/docs/migrating-from-docker-api.md +156 -0
  12. data/docs/streaming.md +91 -0
  13. data/lib/docker/api/auth.rb +154 -0
  14. data/lib/docker/api/body.rb +47 -0
  15. data/lib/docker/api/client.rb +117 -0
  16. data/lib/docker/api/collection.rb +60 -0
  17. data/lib/docker/api/collections/containers.rb +78 -0
  18. data/lib/docker/api/collections/images.rb +221 -0
  19. data/lib/docker/api/collections/networks.rb +85 -0
  20. data/lib/docker/api/collections/system.rb +98 -0
  21. data/lib/docker/api/collections/volumes.rb +54 -0
  22. data/lib/docker/api/config.rb +163 -0
  23. data/lib/docker/api/connection.rb +333 -0
  24. data/lib/docker/api/context.rb +124 -0
  25. data/lib/docker/api/errors.rb +159 -0
  26. data/lib/docker/api/operations.rb +3064 -0
  27. data/lib/docker/api/path.rb +33 -0
  28. data/lib/docker/api/platform.rb +68 -0
  29. data/lib/docker/api/query.rb +76 -0
  30. data/lib/docker/api/resource.rb +174 -0
  31. data/lib/docker/api/resources/container.rb +378 -0
  32. data/lib/docker/api/resources/exec.rb +48 -0
  33. data/lib/docker/api/resources/image.rb +209 -0
  34. data/lib/docker/api/resources/network.rb +90 -0
  35. data/lib/docker/api/resources/volume.rb +51 -0
  36. data/lib/docker/api/response.rb +110 -0
  37. data/lib/docker/api/session.rb +70 -0
  38. data/lib/docker/api/stream.rb +142 -0
  39. data/lib/docker/api/tar.rb +157 -0
  40. data/lib/docker/api/transport/base.rb +62 -0
  41. data/lib/docker/api/transport/fake.rb +154 -0
  42. data/lib/docker/api/transport/named_pipe.rb +58 -0
  43. data/lib/docker/api/transport/tcp.rb +49 -0
  44. data/lib/docker/api/transport/tls.rb +84 -0
  45. data/lib/docker/api/transport/unix.rb +35 -0
  46. data/lib/docker/api/transport.rb +113 -0
  47. data/lib/docker/api/version.rb +21 -0
  48. data/lib/docker/api.rb +68 -0
  49. data/sig/docker/api/core.rbs +109 -0
  50. data/sig/docker/api/operations.rbs +123 -0
  51. metadata +97 -0
@@ -0,0 +1,123 @@
1
+ # GENERATED -- do not edit.
2
+ #
3
+ # Source: data/swagger/v1.55.yaml (Docker Engine API v1.55)
4
+ # Generator: tools/generator/rbs_emitter.rb
5
+ # Regenerate: bundle exec rake api:generate
6
+
7
+ module Docker
8
+ module API
9
+ class Operations
10
+ attr_reader connection: Docker::API::Connection
11
+ def initialize: (Docker::API::Connection connection) -> void
12
+
13
+ def config_create: (?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
14
+ def config_delete: (id: String) ?{ (String) -> void } -> Docker::API::Response
15
+ def config_inspect: (id: String) ?{ (String) -> void } -> Docker::API::Response
16
+ def config_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
17
+ def config_update: (id: String, version: Integer, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
18
+ def container_archive: (id: String, path: String) ?{ (String) -> void } -> Docker::API::Response
19
+ def container_archive_info: (id: String, path: String) ?{ (String) -> void } -> Docker::API::Response
20
+ def container_attach: (id: String, ?detach_keys: String?, ?logs: bool?, ?stream: bool?, ?stdin: bool?, ?stdout: bool?, ?stderr: bool?) ?{ (String) -> void } -> Docker::API::Response
21
+ def container_attach_websocket: (id: String, ?detach_keys: String?, ?logs: bool?, ?stream: bool?, ?stdin: bool?, ?stdout: bool?, ?stderr: bool?) ?{ (String) -> void } -> Docker::API::Response
22
+ def container_changes: (id: String) ?{ (String) -> void } -> Docker::API::Response
23
+ def container_create: (body: Hash[String, untyped] | String | IO, ?name: String?, ?platform: String?) ?{ (String) -> void } -> Docker::API::Response
24
+ def container_delete: (id: String, ?v: bool?, ?force: bool?, ?link: bool?) ?{ (String) -> void } -> Docker::API::Response
25
+ def container_export: (id: String) ?{ (String) -> void } -> Docker::API::Response
26
+ def container_inspect: (id: String, ?size: bool?) ?{ (String) -> void } -> Docker::API::Response
27
+ def container_kill: (id: String, ?signal: String?) ?{ (String) -> void } -> Docker::API::Response
28
+ def container_list: (?all: bool?, ?limit: Integer?, ?size: bool?, ?filters: String?) ?{ (String) -> void } -> Docker::API::Response
29
+ def container_logs: (id: String, ?follow: bool?, ?stdout: bool?, ?stderr: bool?, ?since: Integer?, ?until_: Integer?, ?timestamps: bool?, ?tail: String?) ?{ (String) -> void } -> Docker::API::Response
30
+ def container_pause: (id: String) ?{ (String) -> void } -> Docker::API::Response
31
+ def container_prune: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
32
+ def container_rename: (id: String, name: String) ?{ (String) -> void } -> Docker::API::Response
33
+ def container_resize: (id: String, h: Integer, w: Integer) ?{ (String) -> void } -> Docker::API::Response
34
+ def container_restart: (id: String, ?signal: String?, ?t: Integer?) ?{ (String) -> void } -> Docker::API::Response
35
+ def container_start: (id: String, ?detach_keys: String?) ?{ (String) -> void } -> Docker::API::Response
36
+ def container_stats: (id: String, ?stream: bool?, ?one_shot: bool?) ?{ (String) -> void } -> Docker::API::Response
37
+ def container_stop: (id: String, ?signal: String?, ?t: Integer?) ?{ (String) -> void } -> Docker::API::Response
38
+ def container_top: (id: String, ?ps_args: String?) ?{ (String) -> void } -> Docker::API::Response
39
+ def container_unpause: (id: String) ?{ (String) -> void } -> Docker::API::Response
40
+ def container_update: (id: String, body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
41
+ def container_wait: (id: String, ?condition: String?) ?{ (String) -> void } -> Docker::API::Response
42
+ def put_container_archive: (id: String, path: String, body: Hash[String, untyped] | String | IO, ?no_overwrite_dir_non_dir: String?, ?copy_uidgid: String?) ?{ (String) -> void } -> Docker::API::Response
43
+ def distribution_inspect: (name: String) ?{ (String) -> void } -> Docker::API::Response
44
+ def container_exec: (id: String, body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
45
+ def exec_inspect: (id: String) ?{ (String) -> void } -> Docker::API::Response
46
+ def exec_resize: (id: String, h: Integer, w: Integer) ?{ (String) -> void } -> Docker::API::Response
47
+ def exec_start: (id: String, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
48
+ def build_prune: (?reserved_space: Integer?, ?max_used_space: Integer?, ?min_free_space: Integer?, ?all: bool?, ?filters: String?) ?{ (String) -> void } -> Docker::API::Response
49
+ def image_attestations: (name: String, ?platform: Array[untyped]?, ?type: Array[untyped]?, ?statement: bool?) ?{ (String) -> void } -> Docker::API::Response
50
+ def image_build: (?dockerfile: String?, ?t: String?, ?extrahosts: String?, ?remote: String?, ?q: bool?, ?nocache: bool?, ?cachefrom: String?, ?pull: String?, ?rm: bool?, ?forcerm: bool?, ?memory: Integer?, ?memswap: Integer?, ?cpushares: Integer?, ?cpusetcpus: String?, ?cpuperiod: Integer?, ?cpuquota: Integer?, ?buildargs: String?, ?shmsize: Integer?, ?squash: bool?, ?labels: String?, ?networkmode: String?, ?platform: String?, ?target: String?, ?outputs: String?, ?version: String?, ?content_type: String?, ?x_registry_config: String?, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
51
+ def image_commit: (?container: String?, ?repo: String?, ?tag: String?, ?comment: String?, ?author: String?, ?pause: bool?, ?changes: String?, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
52
+ def image_create: (?from_image: String?, ?from_src: String?, ?repo: String?, ?tag: String?, ?message: String?, ?changes: Array[untyped]?, ?platform: String?, ?x_registry_auth: String?, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
53
+ def image_delete: (name: String, ?force: bool?, ?noprune: bool?, ?platforms: Array[untyped]?) ?{ (String) -> void } -> Docker::API::Response
54
+ def image_get: (name: String, ?platform: Array[untyped]?) ?{ (String) -> void } -> Docker::API::Response
55
+ def image_get_all: (?names: Array[untyped]?, ?platform: Array[untyped]?) ?{ (String) -> void } -> Docker::API::Response
56
+ def image_history: (name: String, ?platform: String?) ?{ (String) -> void } -> Docker::API::Response
57
+ def image_inspect: (name: String, ?manifests: bool?, ?platform: String?) ?{ (String) -> void } -> Docker::API::Response
58
+ def image_list: (?all: bool?, ?filters: String?, ?shared_size: bool?, ?digests: bool?, ?manifests: bool?, ?identity: bool?) ?{ (String) -> void } -> Docker::API::Response
59
+ def image_load: (?quiet: bool?, ?platform: Array[untyped]?, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
60
+ def image_prune: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
61
+ def image_push: (name: String, x_registry_auth: String, ?tag: String?, ?platform: String?) ?{ (String) -> void } -> Docker::API::Response
62
+ def image_search: (term: String, ?limit: Integer?, ?filters: String?) ?{ (String) -> void } -> Docker::API::Response
63
+ def image_tag: (name: String, ?repo: String?, ?tag: String?) ?{ (String) -> void } -> Docker::API::Response
64
+ def network_connect: (id: String, body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
65
+ def network_create: (body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
66
+ def network_delete: (id: String) ?{ (String) -> void } -> Docker::API::Response
67
+ def network_disconnect: (id: String, body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
68
+ def network_inspect: (id: String, ?verbose: bool?, ?scope: String?) ?{ (String) -> void } -> Docker::API::Response
69
+ def network_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
70
+ def network_prune: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
71
+ def node_delete: (id: String, ?force: bool?) ?{ (String) -> void } -> Docker::API::Response
72
+ def node_inspect: (id: String) ?{ (String) -> void } -> Docker::API::Response
73
+ def node_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
74
+ def node_update: (id: String, version: Integer, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
75
+ def get_plugin_privileges: (remote: String) ?{ (String) -> void } -> Docker::API::Response
76
+ def plugin_create: (name: String, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
77
+ def plugin_delete: (name: String, ?force: bool?) ?{ (String) -> void } -> Docker::API::Response
78
+ def plugin_disable: (name: String, ?force: bool?) ?{ (String) -> void } -> Docker::API::Response
79
+ def plugin_enable: (name: String, ?timeout: Integer?) ?{ (String) -> void } -> Docker::API::Response
80
+ def plugin_inspect: (name: String) ?{ (String) -> void } -> Docker::API::Response
81
+ def plugin_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
82
+ def plugin_pull: (remote: String, ?name: String?, ?x_registry_auth: String?, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
83
+ def plugin_push: (name: String) ?{ (String) -> void } -> Docker::API::Response
84
+ def plugin_set: (name: String, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
85
+ def plugin_upgrade: (name: String, remote: String, ?x_registry_auth: String?, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
86
+ def secret_create: (?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
87
+ def secret_delete: (id: String) ?{ (String) -> void } -> Docker::API::Response
88
+ def secret_inspect: (id: String) ?{ (String) -> void } -> Docker::API::Response
89
+ def secret_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
90
+ def secret_update: (id: String, version: Integer, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
91
+ def service_create: (body: Hash[String, untyped] | String | IO, ?x_registry_auth: String?) ?{ (String) -> void } -> Docker::API::Response
92
+ def service_delete: (id: String) ?{ (String) -> void } -> Docker::API::Response
93
+ def service_inspect: (id: String, ?insert_defaults: bool?) ?{ (String) -> void } -> Docker::API::Response
94
+ def service_list: (?filters: String?, ?status: bool?) ?{ (String) -> void } -> Docker::API::Response
95
+ def service_logs: (id: String, ?details: bool?, ?follow: bool?, ?stdout: bool?, ?stderr: bool?, ?since: Integer?, ?timestamps: bool?, ?tail: String?) ?{ (String) -> void } -> Docker::API::Response
96
+ def service_update: (id: String, body: Hash[String, untyped] | String | IO, version: Integer, ?registry_auth_from: String?, ?rollback: String?, ?x_registry_auth: String?) ?{ (String) -> void } -> Docker::API::Response
97
+ def session: () ?{ (String) -> void } -> Docker::API::Response
98
+ def swarm_init: (body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
99
+ def swarm_inspect: () ?{ (String) -> void } -> Docker::API::Response
100
+ def swarm_join: (body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
101
+ def swarm_leave: (?force: bool?) ?{ (String) -> void } -> Docker::API::Response
102
+ def swarm_unlock: (body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
103
+ def swarm_unlockkey: () ?{ (String) -> void } -> Docker::API::Response
104
+ def swarm_update: (body: Hash[String, untyped] | String | IO, version: Integer, ?rotate_worker_token: bool?, ?rotate_manager_token: bool?, ?rotate_manager_unlock_key: bool?) ?{ (String) -> void } -> Docker::API::Response
105
+ def system_auth: (?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
106
+ def system_data_usage: (?type: Array[untyped]?, ?verbose: bool?) ?{ (String) -> void } -> Docker::API::Response
107
+ def system_events: (?since: String?, ?until_: String?, ?filters: String?) ?{ (String) -> void } -> Docker::API::Response
108
+ def system_info: () ?{ (String) -> void } -> Docker::API::Response
109
+ def system_ping: () ?{ (String) -> void } -> Docker::API::Response
110
+ def system_ping_head: () ?{ (String) -> void } -> Docker::API::Response
111
+ def system_version: () ?{ (String) -> void } -> Docker::API::Response
112
+ def task_inspect: (id: String) ?{ (String) -> void } -> Docker::API::Response
113
+ def task_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
114
+ def task_logs: (id: String, ?details: bool?, ?follow: bool?, ?stdout: bool?, ?stderr: bool?, ?since: Integer?, ?timestamps: bool?, ?tail: String?) ?{ (String) -> void } -> Docker::API::Response
115
+ def volume_create: (body: Hash[String, untyped] | String | IO) ?{ (String) -> void } -> Docker::API::Response
116
+ def volume_delete: (name: String, ?force: bool?) ?{ (String) -> void } -> Docker::API::Response
117
+ def volume_inspect: (name: String) ?{ (String) -> void } -> Docker::API::Response
118
+ def volume_list: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
119
+ def volume_prune: (?filters: String?) ?{ (String) -> void } -> Docker::API::Response
120
+ def volume_update: (name: String, version: Integer, ?body: Hash[String, untyped] | String | IO?) ?{ (String) -> void } -> Docker::API::Response
121
+ end
122
+ end
123
+ end
metadata ADDED
@@ -0,0 +1,97 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: docker-api-ng
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.3.0
5
+ platform: ruby
6
+ authors:
7
+ - Tim Smith
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies: []
12
+ description: |
13
+ A dependency-free Ruby client for the Docker Engine API. The complete API
14
+ surface is generated from Docker's own OpenAPI specification, so keeping up
15
+ with the daemon is a reviewable diff rather than manual archaeology, and an
16
+ ergonomic hand-written layer sits on top of it.
17
+ email:
18
+ - tsmith84@proton.me
19
+ executables: []
20
+ extensions: []
21
+ extra_rdoc_files: []
22
+ files:
23
+ - LICENSE
24
+ - NOTICE
25
+ - README.md
26
+ - docker-api-ng.gemspec
27
+ - docs/building-images.md
28
+ - docs/connecting.md
29
+ - docs/errors.md
30
+ - docs/exec.md
31
+ - docs/extending.md
32
+ - docs/migrating-from-docker-api.md
33
+ - docs/streaming.md
34
+ - lib/docker/api.rb
35
+ - lib/docker/api/auth.rb
36
+ - lib/docker/api/body.rb
37
+ - lib/docker/api/client.rb
38
+ - lib/docker/api/collection.rb
39
+ - lib/docker/api/collections/containers.rb
40
+ - lib/docker/api/collections/images.rb
41
+ - lib/docker/api/collections/networks.rb
42
+ - lib/docker/api/collections/system.rb
43
+ - lib/docker/api/collections/volumes.rb
44
+ - lib/docker/api/config.rb
45
+ - lib/docker/api/connection.rb
46
+ - lib/docker/api/context.rb
47
+ - lib/docker/api/errors.rb
48
+ - lib/docker/api/operations.rb
49
+ - lib/docker/api/path.rb
50
+ - lib/docker/api/platform.rb
51
+ - lib/docker/api/query.rb
52
+ - lib/docker/api/resource.rb
53
+ - lib/docker/api/resources/container.rb
54
+ - lib/docker/api/resources/exec.rb
55
+ - lib/docker/api/resources/image.rb
56
+ - lib/docker/api/resources/network.rb
57
+ - lib/docker/api/resources/volume.rb
58
+ - lib/docker/api/response.rb
59
+ - lib/docker/api/session.rb
60
+ - lib/docker/api/stream.rb
61
+ - lib/docker/api/tar.rb
62
+ - lib/docker/api/transport.rb
63
+ - lib/docker/api/transport/base.rb
64
+ - lib/docker/api/transport/fake.rb
65
+ - lib/docker/api/transport/named_pipe.rb
66
+ - lib/docker/api/transport/tcp.rb
67
+ - lib/docker/api/transport/tls.rb
68
+ - lib/docker/api/transport/unix.rb
69
+ - lib/docker/api/version.rb
70
+ - sig/docker/api/core.rbs
71
+ - sig/docker/api/operations.rbs
72
+ homepage: https://github.com/test-kitchen/docker-api-ng
73
+ licenses:
74
+ - Apache-2.0
75
+ metadata:
76
+ bug_tracker_uri: https://github.com/test-kitchen/docker-api-ng/issues
77
+ changelog_uri: https://github.com/test-kitchen/docker-api-ng/blob/main/CHANGELOG.md
78
+ documentation_uri: https://github.com/test-kitchen/docker-api-ng/blob/main/README.md
79
+ source_code_uri: https://github.com/test-kitchen/docker-api-ng
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '3.1'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubygems_version: 4.0.17
95
+ specification_version: 4
96
+ summary: A Ruby client for the modern Docker Engine API
97
+ test_files: []