docker-engine-ruby 0.2.2 → 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 (289) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/docker_engine_ruby/models/config.rb +6 -6
  5. data/lib/docker_engine_ruby/models/config_create_params.rb +1 -11
  6. data/lib/docker_engine_ruby/models/config_list_params.rb +1 -14
  7. data/lib/docker_engine_ruby/models/config_update_params.rb +1 -7
  8. data/lib/docker_engine_ruby/models/connect_request.rb +5 -5
  9. data/lib/docker_engine_ruby/models/container.rb +61 -143
  10. data/lib/docker_engine_ruby/models/container_archive_params.rb +1 -3
  11. data/lib/docker_engine_ruby/models/container_attach_params.rb +6 -29
  12. data/lib/docker_engine_ruby/models/container_create_params.rb +3 -1701
  13. data/lib/docker_engine_ruby/models/container_delete_params.rb +3 -9
  14. data/lib/docker_engine_ruby/models/container_exec_params.rb +11 -39
  15. data/lib/docker_engine_ruby/models/container_inspect_params.rb +1 -3
  16. data/lib/docker_engine_ruby/models/container_kill_params.rb +1 -6
  17. data/lib/docker_engine_ruby/models/container_list_params.rb +4 -36
  18. data/lib/docker_engine_ruby/models/container_logs_params.rb +7 -25
  19. data/lib/docker_engine_ruby/models/container_prune_params.rb +1 -16
  20. data/lib/docker_engine_ruby/models/container_prune_response.rb +2 -5
  21. data/lib/docker_engine_ruby/models/container_rename_params.rb +1 -3
  22. data/lib/docker_engine_ruby/models/container_resize_params.rb +2 -6
  23. data/lib/docker_engine_ruby/models/container_restart_params.rb +2 -9
  24. data/lib/docker_engine_ruby/models/container_start_params.rb +1 -8
  25. data/lib/docker_engine_ruby/models/container_stats_params.rb +2 -11
  26. data/lib/docker_engine_ruby/models/container_stop_params.rb +2 -9
  27. data/lib/docker_engine_ruby/models/container_top_params.rb +1 -3
  28. data/lib/docker_engine_ruby/models/container_update_params.rb +4 -80
  29. data/lib/docker_engine_ruby/models/container_wait_params.rb +1 -11
  30. data/lib/docker_engine_ruby/models/create_request.rb +17 -121
  31. data/lib/docker_engine_ruby/models/exec_inspect_response.rb +1 -12
  32. data/lib/docker_engine_ruby/models/exec_resize_params.rb +2 -6
  33. data/lib/docker_engine_ruby/models/exec_start_params.rb +3 -9
  34. data/lib/docker_engine_ruby/models/filesystem_change.rb +3 -3
  35. data/lib/docker_engine_ruby/models/image.rb +33 -66
  36. data/lib/docker_engine_ruby/models/image_build_params.rb +25 -122
  37. data/lib/docker_engine_ruby/models/image_build_prune_params.rb +5 -32
  38. data/lib/docker_engine_ruby/models/image_build_prune_response.rb +1 -3
  39. data/lib/docker_engine_ruby/models/image_commit_params.rb +7 -21
  40. data/lib/docker_engine_ruby/models/image_delete_params.rb +3 -14
  41. data/lib/docker_engine_ruby/models/image_get_all_params.rb +2 -13
  42. data/lib/docker_engine_ruby/models/image_get_params.rb +1 -10
  43. data/lib/docker_engine_ruby/models/image_history_params.rb +1 -15
  44. data/lib/docker_engine_ruby/models/image_inspect_params.rb +1 -3
  45. data/lib/docker_engine_ruby/models/image_list_params.rb +5 -29
  46. data/lib/docker_engine_ruby/models/image_load_params.rb +2 -14
  47. data/lib/docker_engine_ruby/models/image_prune_params.rb +1 -16
  48. data/lib/docker_engine_ruby/models/image_prune_response.rb +2 -5
  49. data/lib/docker_engine_ruby/models/image_pull_params.rb +13 -60
  50. data/lib/docker_engine_ruby/models/image_push_params.rb +2 -19
  51. data/lib/docker_engine_ruby/models/image_search_params.rb +3 -16
  52. data/lib/docker_engine_ruby/models/image_search_response.rb +1 -13
  53. data/lib/docker_engine_ruby/models/image_tag_params.rb +2 -6
  54. data/lib/docker_engine_ruby/models/info.rb +24 -53
  55. data/lib/docker_engine_ruby/models/inspect.rb +5 -7
  56. data/lib/docker_engine_ruby/models/list_response.rb +0 -3
  57. data/lib/docker_engine_ruby/models/network.rb +7 -4
  58. data/lib/docker_engine_ruby/models/network_create_params.rb +11 -26
  59. data/lib/docker_engine_ruby/models/network_inspect_params.rb +2 -6
  60. data/lib/docker_engine_ruby/models/network_inspect_response.rb +219 -89
  61. data/lib/docker_engine_ruby/models/network_list_params.rb +1 -21
  62. data/lib/docker_engine_ruby/models/network_prune_params.rb +1 -16
  63. data/lib/docker_engine_ruby/models/network_prune_response.rb +1 -2
  64. data/lib/docker_engine_ruby/models/node.rb +9 -22
  65. data/lib/docker_engine_ruby/models/node_delete_params.rb +1 -3
  66. data/lib/docker_engine_ruby/models/node_list_params.rb +1 -15
  67. data/lib/docker_engine_ruby/models/node_update_params.rb +1 -7
  68. data/lib/docker_engine_ruby/models/plugin.rb +2 -24
  69. data/lib/docker_engine_ruby/models/plugin_create_params.rb +1 -8
  70. data/lib/docker_engine_ruby/models/plugin_delete_params.rb +1 -7
  71. data/lib/docker_engine_ruby/models/plugin_disable_params.rb +1 -6
  72. data/lib/docker_engine_ruby/models/plugin_enable_params.rb +1 -3
  73. data/lib/docker_engine_ruby/models/plugin_list_params.rb +1 -12
  74. data/lib/docker_engine_ruby/models/plugin_privileges_params.rb +1 -7
  75. data/lib/docker_engine_ruby/models/plugin_pull_params.rb +8 -21
  76. data/lib/docker_engine_ruby/models/plugin_set_params.rb +3 -3
  77. data/lib/docker_engine_ruby/models/plugin_upgrade_params.rb +4 -13
  78. data/lib/docker_engine_ruby/models/secret.rb +6 -6
  79. data/lib/docker_engine_ruby/models/secret_create_params.rb +1 -11
  80. data/lib/docker_engine_ruby/models/secret_list_params.rb +1 -14
  81. data/lib/docker_engine_ruby/models/secret_update_params.rb +1 -7
  82. data/lib/docker_engine_ruby/models/service.rb +18 -33
  83. data/lib/docker_engine_ruby/models/service_create_params.rb +1 -15
  84. data/lib/docker_engine_ruby/models/service_inspect_params.rb +1 -3
  85. data/lib/docker_engine_ruby/models/service_list_params.rb +2 -17
  86. data/lib/docker_engine_ruby/models/service_logs_params.rb +7 -25
  87. data/lib/docker_engine_ruby/models/service_update_params.rb +4 -34
  88. data/lib/docker_engine_ruby/models/spec.rb +25 -96
  89. data/lib/docker_engine_ruby/models/stats_response.rb +143 -68
  90. data/lib/docker_engine_ruby/models/summary.rb +12 -32
  91. data/lib/docker_engine_ruby/models/swarm.rb +6 -9
  92. data/lib/docker_engine_ruby/models/swarm_init_params.rb +7 -35
  93. data/lib/docker_engine_ruby/models/swarm_join_params.rb +5 -31
  94. data/lib/docker_engine_ruby/models/swarm_leave_params.rb +1 -7
  95. data/lib/docker_engine_ruby/models/swarm_unlock_key_response.rb +1 -2
  96. data/lib/docker_engine_ruby/models/swarm_unlock_params.rb +1 -3
  97. data/lib/docker_engine_ruby/models/swarm_update_params.rb +4 -16
  98. data/lib/docker_engine_ruby/models/system_data_usage_params.rb +43 -16
  99. data/lib/docker_engine_ruby/models/system_data_usage_response.rb +0 -19
  100. data/lib/docker_engine_ruby/models/system_events_params.rb +3 -29
  101. data/lib/docker_engine_ruby/models/system_events_response.rb +0 -3
  102. data/lib/docker_engine_ruby/models/task.rb +10 -12
  103. data/lib/docker_engine_ruby/models/task_list_params.rb +1 -16
  104. data/lib/docker_engine_ruby/models/task_logs_params.rb +7 -25
  105. data/lib/docker_engine_ruby/models/version.rb +8 -17
  106. data/lib/docker_engine_ruby/models/volume.rb +38 -194
  107. data/lib/docker_engine_ruby/models/volume_delete_params.rb +1 -3
  108. data/lib/docker_engine_ruby/models/volume_list_params.rb +1 -15
  109. data/lib/docker_engine_ruby/models/volume_prune_params.rb +1 -14
  110. data/lib/docker_engine_ruby/models/volume_prune_response.rb +2 -5
  111. data/lib/docker_engine_ruby/models/volume_update_params.rb +18 -127
  112. data/lib/docker_engine_ruby/resources/auth.rb +1 -2
  113. data/lib/docker_engine_ruby/resources/configs.rb +9 -18
  114. data/lib/docker_engine_ruby/resources/containers.rb +88 -337
  115. data/lib/docker_engine_ruby/resources/distribution.rb +2 -3
  116. data/lib/docker_engine_ruby/resources/exec.rb +11 -22
  117. data/lib/docker_engine_ruby/resources/images.rb +98 -228
  118. data/lib/docker_engine_ruby/resources/networks.rb +22 -41
  119. data/lib/docker_engine_ruby/resources/nodes.rb +7 -17
  120. data/lib/docker_engine_ruby/resources/plugins.rb +27 -74
  121. data/lib/docker_engine_ruby/resources/secrets.rb +9 -18
  122. data/lib/docker_engine_ruby/resources/services.rb +23 -52
  123. data/lib/docker_engine_ruby/resources/swarm.rb +26 -38
  124. data/lib/docker_engine_ruby/resources/system.rb +8 -49
  125. data/lib/docker_engine_ruby/resources/tasks.rb +12 -32
  126. data/lib/docker_engine_ruby/resources/volumes.rb +8 -22
  127. data/lib/docker_engine_ruby/version.rb +1 -1
  128. data/rbi/docker_engine_ruby/models/config.rbi +9 -7
  129. data/rbi/docker_engine_ruby/models/config_create_params.rbi +2 -34
  130. data/rbi/docker_engine_ruby/models/config_list_params.rbi +1 -22
  131. data/rbi/docker_engine_ruby/models/config_update_params.rbi +1 -8
  132. data/rbi/docker_engine_ruby/models/connect_request.rbi +7 -12
  133. data/rbi/docker_engine_ruby/models/container.rbi +73 -194
  134. data/rbi/docker_engine_ruby/models/container_archive_params.rbi +1 -6
  135. data/rbi/docker_engine_ruby/models/container_attach_params.rbi +0 -28
  136. data/rbi/docker_engine_ruby/models/container_create_params.rbi +1 -3250
  137. data/rbi/docker_engine_ruby/models/container_delete_params.rbi +1 -12
  138. data/rbi/docker_engine_ruby/models/container_exec_params.rbi +0 -28
  139. data/rbi/docker_engine_ruby/models/container_inspect_params.rbi +1 -6
  140. data/rbi/docker_engine_ruby/models/container_kill_params.rbi +1 -6
  141. data/rbi/docker_engine_ruby/models/container_list_params.rbi +0 -50
  142. data/rbi/docker_engine_ruby/models/container_logs_params.rbi +0 -16
  143. data/rbi/docker_engine_ruby/models/container_prune_params.rbi +1 -26
  144. data/rbi/docker_engine_ruby/models/container_prune_response.rbi +1 -8
  145. data/rbi/docker_engine_ruby/models/container_rename_params.rbi +1 -6
  146. data/rbi/docker_engine_ruby/models/container_resize_params.rbi +1 -9
  147. data/rbi/docker_engine_ruby/models/container_restart_params.rbi +1 -9
  148. data/rbi/docker_engine_ruby/models/container_start_params.rbi +1 -10
  149. data/rbi/docker_engine_ruby/models/container_stats_params.rbi +1 -13
  150. data/rbi/docker_engine_ruby/models/container_stop_params.rbi +1 -9
  151. data/rbi/docker_engine_ruby/models/container_top_params.rbi +1 -6
  152. data/rbi/docker_engine_ruby/models/container_update_params.rbi +1 -170
  153. data/rbi/docker_engine_ruby/models/container_wait_params.rbi +1 -13
  154. data/rbi/docker_engine_ruby/models/create_request.rbi +7 -139
  155. data/rbi/docker_engine_ruby/models/exec_inspect_response.rbi +0 -2
  156. data/rbi/docker_engine_ruby/models/exec_resize_params.rbi +1 -9
  157. data/rbi/docker_engine_ruby/models/exec_start_params.rbi +0 -6
  158. data/rbi/docker_engine_ruby/models/filesystem_change.rbi +10 -13
  159. data/rbi/docker_engine_ruby/models/image.rbi +48 -106
  160. data/rbi/docker_engine_ruby/models/image_build_params.rbi +0 -127
  161. data/rbi/docker_engine_ruby/models/image_build_prune_params.rbi +0 -38
  162. data/rbi/docker_engine_ruby/models/image_build_prune_response.rbi +1 -6
  163. data/rbi/docker_engine_ruby/models/image_commit_params.rbi +0 -14
  164. data/rbi/docker_engine_ruby/models/image_delete_params.rbi +0 -10
  165. data/rbi/docker_engine_ruby/models/image_get_all_params.rbi +1 -17
  166. data/rbi/docker_engine_ruby/models/image_get_params.rbi +1 -14
  167. data/rbi/docker_engine_ruby/models/image_history_params.rbi +1 -24
  168. data/rbi/docker_engine_ruby/models/image_inspect_params.rbi +1 -6
  169. data/rbi/docker_engine_ruby/models/image_list_params.rbi +0 -32
  170. data/rbi/docker_engine_ruby/models/image_load_params.rbi +1 -18
  171. data/rbi/docker_engine_ruby/models/image_prune_params.rbi +1 -26
  172. data/rbi/docker_engine_ruby/models/image_prune_response.rbi +1 -8
  173. data/rbi/docker_engine_ruby/models/image_pull_params.rbi +6 -79
  174. data/rbi/docker_engine_ruby/models/image_push_params.rbi +0 -22
  175. data/rbi/docker_engine_ruby/models/image_search_params.rbi +1 -20
  176. data/rbi/docker_engine_ruby/models/image_search_response.rbi +0 -10
  177. data/rbi/docker_engine_ruby/models/image_tag_params.rbi +1 -9
  178. data/rbi/docker_engine_ruby/models/info.rbi +29 -76
  179. data/rbi/docker_engine_ruby/models/inspect.rbi +6 -12
  180. data/rbi/docker_engine_ruby/models/network.rbi +7 -4
  181. data/rbi/docker_engine_ruby/models/network_create_params.rbi +0 -30
  182. data/rbi/docker_engine_ruby/models/network_inspect_params.rbi +1 -9
  183. data/rbi/docker_engine_ruby/models/network_inspect_response.rbi +345 -198
  184. data/rbi/docker_engine_ruby/models/network_list_params.rbi +1 -36
  185. data/rbi/docker_engine_ruby/models/network_prune_params.rbi +1 -26
  186. data/rbi/docker_engine_ruby/models/network_prune_response.rbi +1 -5
  187. data/rbi/docker_engine_ruby/models/node.rbi +11 -17
  188. data/rbi/docker_engine_ruby/models/node_delete_params.rbi +1 -6
  189. data/rbi/docker_engine_ruby/models/node_list_params.rbi +1 -24
  190. data/rbi/docker_engine_ruby/models/node_update_params.rbi +1 -8
  191. data/rbi/docker_engine_ruby/models/plugin.rbi +1 -11
  192. data/rbi/docker_engine_ruby/models/plugin_create_params.rbi +1 -9
  193. data/rbi/docker_engine_ruby/models/plugin_delete_params.rbi +1 -8
  194. data/rbi/docker_engine_ruby/models/plugin_disable_params.rbi +1 -6
  195. data/rbi/docker_engine_ruby/models/plugin_enable_params.rbi +1 -6
  196. data/rbi/docker_engine_ruby/models/plugin_list_params.rbi +1 -18
  197. data/rbi/docker_engine_ruby/models/plugin_privileges_params.rbi +1 -8
  198. data/rbi/docker_engine_ruby/models/plugin_pull_params.rbi +6 -21
  199. data/rbi/docker_engine_ruby/models/plugin_set_params.rbi +3 -6
  200. data/rbi/docker_engine_ruby/models/plugin_upgrade_params.rbi +3 -17
  201. data/rbi/docker_engine_ruby/models/secret.rbi +8 -8
  202. data/rbi/docker_engine_ruby/models/secret_create_params.rbi +2 -34
  203. data/rbi/docker_engine_ruby/models/secret_list_params.rbi +1 -22
  204. data/rbi/docker_engine_ruby/models/secret_update_params.rbi +1 -8
  205. data/rbi/docker_engine_ruby/models/service.rbi +20 -40
  206. data/rbi/docker_engine_ruby/models/service_create_params.rbi +1 -36
  207. data/rbi/docker_engine_ruby/models/service_inspect_params.rbi +1 -6
  208. data/rbi/docker_engine_ruby/models/service_list_params.rbi +1 -25
  209. data/rbi/docker_engine_ruby/models/service_logs_params.rbi +0 -16
  210. data/rbi/docker_engine_ruby/models/service_update_params.rbi +0 -50
  211. data/rbi/docker_engine_ruby/models/spec.rbi +9 -82
  212. data/rbi/docker_engine_ruby/models/stats_response.rbi +213 -141
  213. data/rbi/docker_engine_ruby/models/summary.rbi +16 -53
  214. data/rbi/docker_engine_ruby/models/swarm.rbi +8 -8
  215. data/rbi/docker_engine_ruby/models/swarm_init_params.rbi +0 -50
  216. data/rbi/docker_engine_ruby/models/swarm_join_params.rbi +0 -36
  217. data/rbi/docker_engine_ruby/models/swarm_leave_params.rbi +1 -8
  218. data/rbi/docker_engine_ruby/models/swarm_unlock_key_response.rbi +1 -5
  219. data/rbi/docker_engine_ruby/models/swarm_unlock_params.rbi +1 -6
  220. data/rbi/docker_engine_ruby/models/swarm_update_params.rbi +0 -10
  221. data/rbi/docker_engine_ruby/models/system_data_usage_params.rbi +79 -27
  222. data/rbi/docker_engine_ruby/models/system_events_params.rbi +1 -46
  223. data/rbi/docker_engine_ruby/models/task.rbi +12 -16
  224. data/rbi/docker_engine_ruby/models/task_list_params.rbi +1 -26
  225. data/rbi/docker_engine_ruby/models/task_logs_params.rbi +0 -16
  226. data/rbi/docker_engine_ruby/models/version.rbi +8 -22
  227. data/rbi/docker_engine_ruby/models/volume.rbi +25 -225
  228. data/rbi/docker_engine_ruby/models/volume_delete_params.rbi +1 -6
  229. data/rbi/docker_engine_ruby/models/volume_list_params.rbi +1 -24
  230. data/rbi/docker_engine_ruby/models/volume_prune_params.rbi +1 -22
  231. data/rbi/docker_engine_ruby/models/volume_prune_response.rbi +1 -8
  232. data/rbi/docker_engine_ruby/models/volume_update_params.rbi +7 -143
  233. data/rbi/docker_engine_ruby/resources/auth.rbi +1 -2
  234. data/rbi/docker_engine_ruby/resources/configs.rbi +8 -29
  235. data/rbi/docker_engine_ruby/resources/containers.rbi +36 -388
  236. data/rbi/docker_engine_ruby/resources/distribution.rbi +2 -6
  237. data/rbi/docker_engine_ruby/resources/exec.rbi +5 -24
  238. data/rbi/docker_engine_ruby/resources/images.rbi +72 -365
  239. data/rbi/docker_engine_ruby/resources/networks.rbi +7 -76
  240. data/rbi/docker_engine_ruby/resources/nodes.rbi +6 -30
  241. data/rbi/docker_engine_ruby/resources/plugins.rbi +22 -91
  242. data/rbi/docker_engine_ruby/resources/secrets.rbi +8 -29
  243. data/rbi/docker_engine_ruby/resources/services.rbi +12 -60
  244. data/rbi/docker_engine_ruby/resources/swarm.rbi +6 -59
  245. data/rbi/docker_engine_ruby/resources/system.rbi +11 -66
  246. data/rbi/docker_engine_ruby/resources/tasks.rbi +3 -34
  247. data/rbi/docker_engine_ruby/resources/volumes.rbi +7 -43
  248. data/sig/docker_engine_ruby/models/config.rbs +11 -9
  249. data/sig/docker_engine_ruby/models/config_create_params.rbs +3 -24
  250. data/sig/docker_engine_ruby/models/connect_request.rbs +12 -12
  251. data/sig/docker_engine_ruby/models/container.rbs +62 -62
  252. data/sig/docker_engine_ruby/models/container_create_params.rbs +1 -1321
  253. data/sig/docker_engine_ruby/models/container_update_params.rbs +0 -51
  254. data/sig/docker_engine_ruby/models/create_request.rbs +5 -5
  255. data/sig/docker_engine_ruby/models/filesystem_change.rbs +1 -1
  256. data/sig/docker_engine_ruby/models/image.rbs +51 -53
  257. data/sig/docker_engine_ruby/models/image_pull_params.rbs +5 -7
  258. data/sig/docker_engine_ruby/models/info.rbs +54 -36
  259. data/sig/docker_engine_ruby/models/inspect.rbs +12 -8
  260. data/sig/docker_engine_ruby/models/network.rbs +5 -5
  261. data/sig/docker_engine_ruby/models/network_inspect_response.rbs +179 -90
  262. data/sig/docker_engine_ruby/models/node.rbs +18 -14
  263. data/sig/docker_engine_ruby/models/plugin_pull_params.rbs +5 -9
  264. data/sig/docker_engine_ruby/models/plugin_set_params.rbs +2 -4
  265. data/sig/docker_engine_ruby/models/plugin_upgrade_params.rbs +2 -6
  266. data/sig/docker_engine_ruby/models/secret.rbs +10 -10
  267. data/sig/docker_engine_ruby/models/secret_create_params.rbs +3 -24
  268. data/sig/docker_engine_ruby/models/service.rbs +25 -25
  269. data/sig/docker_engine_ruby/models/service_create_params.rbs +1 -16
  270. data/sig/docker_engine_ruby/models/service_update_params.rbs +0 -13
  271. data/sig/docker_engine_ruby/models/spec.rbs +10 -10
  272. data/sig/docker_engine_ruby/models/stats_response.rbs +188 -74
  273. data/sig/docker_engine_ruby/models/summary.rbs +20 -16
  274. data/sig/docker_engine_ruby/models/swarm.rbs +10 -10
  275. data/sig/docker_engine_ruby/models/system_data_usage_params.rbs +25 -10
  276. data/sig/docker_engine_ruby/models/task.rbs +15 -15
  277. data/sig/docker_engine_ruby/models/version.rbs +13 -4
  278. data/sig/docker_engine_ruby/models/volume.rbs +27 -25
  279. data/sig/docker_engine_ruby/models/volume_update_params.rbs +5 -5
  280. data/sig/docker_engine_ruby/resources/configs.rbs +2 -2
  281. data/sig/docker_engine_ruby/resources/containers.rbs +1 -2
  282. data/sig/docker_engine_ruby/resources/images.rbs +3 -3
  283. data/sig/docker_engine_ruby/resources/networks.rbs +1 -1
  284. data/sig/docker_engine_ruby/resources/nodes.rbs +1 -1
  285. data/sig/docker_engine_ruby/resources/plugins.rbs +3 -3
  286. data/sig/docker_engine_ruby/resources/secrets.rbs +2 -2
  287. data/sig/docker_engine_ruby/resources/services.rbs +2 -2
  288. data/sig/docker_engine_ruby/resources/system.rbs +1 -1
  289. metadata +1 -1
@@ -10,31 +10,31 @@ module DockerEngineRuby
10
10
  #
11
11
  # @overload create(name:, attachable: nil, config_from: nil, config_only: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, options: nil, scope: nil, request_options: {})
12
12
  #
13
- # @param name [String] The network's name.
13
+ # @param name [String]
14
14
  #
15
- # @param attachable [Boolean] Globally scoped network is manually attachable by regular
15
+ # @param attachable [Boolean]
16
16
  #
17
17
  # @param config_from [DockerEngineRuby::Models::NetworkCreateParams::ConfigFrom] The config-only network source to provide the configuration for
18
18
  #
19
- # @param config_only [Boolean] Creates a config-only network. Config-only networks are placeholder
19
+ # @param config_only [Boolean]
20
20
  #
21
- # @param driver [String] Name of the network driver plugin to use.
21
+ # @param driver [String]
22
22
  #
23
- # @param enable_i_pv4 [Boolean] Enable IPv4 on the network.
23
+ # @param enable_i_pv4 [Boolean]
24
24
  #
25
- # @param enable_i_pv6 [Boolean] Enable IPv6 on the network.
25
+ # @param enable_i_pv6 [Boolean]
26
26
  #
27
- # @param ingress [Boolean] Ingress network is the network which provides the routing-mesh
27
+ # @param ingress [Boolean]
28
28
  #
29
- # @param internal [Boolean] Restrict external access to the network.
29
+ # @param internal [Boolean]
30
30
  #
31
31
  # @param ipam [DockerEngineRuby::Models::NetworkCreateParams::Ipam]
32
32
  #
33
- # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
33
+ # @param labels [Hash{Symbol=>String}]
34
34
  #
35
- # @param options [Hash{Symbol=>String}] Network specific options to be used by the drivers.
35
+ # @param options [Hash{Symbol=>String}]
36
36
  #
37
- # @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
37
+ # @param scope [String]
38
38
  #
39
39
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
40
40
  #
@@ -52,20 +52,11 @@ module DockerEngineRuby
52
52
  )
53
53
  end
54
54
 
55
- # Some parameter documentations has been truncated, see
56
- # {DockerEngineRuby::Models::NetworkListParams} for more details.
57
- #
58
- # Returns a list of networks. For details on the format, see the
59
- # [network inspect endpoint](#operation/NetworkInspect).
60
- #
61
- # Note that it uses a different, smaller representation of a network than
62
- # inspecting a single network. For example, the list of containers attached to the
63
- # network is not propagated in API versions 1.28 and up.
55
+ # List networks
64
56
  #
65
57
  # @overload list(filters: nil, request_options: {})
66
58
  #
67
- # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to process
68
- #
59
+ # @param filters [String]
69
60
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
70
61
  #
71
62
  # @return [Array<DockerEngineRuby::Models::Summary>]
@@ -86,8 +77,7 @@ module DockerEngineRuby
86
77
  #
87
78
  # @overload delete(id, request_options: {})
88
79
  #
89
- # @param id [String] Network ID or name
90
- #
80
+ # @param id [String]
91
81
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
92
82
  #
93
83
  # @return [nil]
@@ -102,17 +92,15 @@ module DockerEngineRuby
102
92
  )
103
93
  end
104
94
 
105
- # The network must be either a local-scoped network or a swarm-scoped network with
106
- # the `attachable` option set. A network cannot be re-attached to a running
107
- # container
95
+ # Connect a container to a network
108
96
  #
109
97
  # @overload connect(id, container:, endpoint_config: nil, request_options: {})
110
98
  #
111
- # @param id [String] Network ID or name
99
+ # @param id [String]
112
100
  #
113
101
  # @param container [String] The ID or name of the container to connect to the network.
114
102
  #
115
- # @param endpoint_config [DockerEngineRuby::Models::ConnectRequest::EndpointConfig] Configuration for a network endpoint.
103
+ # @param endpoint_config [DockerEngineRuby::Models::ConnectRequest::EndpointConfig, nil] Configuration for a network endpoint.
116
104
  #
117
105
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
118
106
  #
@@ -134,7 +122,7 @@ module DockerEngineRuby
134
122
  #
135
123
  # @overload disconnect(id, container:, force: nil, request_options: {})
136
124
  #
137
- # @param id [String] Network ID or name
125
+ # @param id [String]
138
126
  #
139
127
  # @param container [String] The ID or name of the container to disconnect from the network.
140
128
  #
@@ -160,12 +148,9 @@ module DockerEngineRuby
160
148
  #
161
149
  # @overload inspect_(id, scope: nil, verbose: nil, request_options: {})
162
150
  #
163
- # @param id [String] Network ID or name
164
- #
165
- # @param scope [String] Filter the network by scope (swarm, global, or local)
166
- #
167
- # @param verbose [Boolean] Detailed inspect output for troubleshooting
168
- #
151
+ # @param id [String]
152
+ # @param scope [String]
153
+ # @param verbose [Boolean]
169
154
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
170
155
  #
171
156
  # @return [DockerEngineRuby::Models::NetworkInspectResponse]
@@ -182,15 +167,11 @@ module DockerEngineRuby
182
167
  )
183
168
  end
184
169
 
185
- # Some parameter documentations has been truncated, see
186
- # {DockerEngineRuby::Models::NetworkPruneParams} for more details.
187
- #
188
170
  # Delete unused networks
189
171
  #
190
172
  # @overload prune(filters: nil, request_options: {})
191
173
  #
192
- # @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
193
- #
174
+ # @param filters [String]
194
175
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
195
176
  #
196
177
  # @return [DockerEngineRuby::Models::NetworkPruneResponse]
@@ -3,16 +3,13 @@
3
3
  module DockerEngineRuby
4
4
  module Resources
5
5
  class Nodes
6
- # Some parameter documentations has been truncated, see
7
- # {DockerEngineRuby::Models::NodeUpdateParams} for more details.
8
- #
9
6
  # Update a node
10
7
  #
11
- # @overload update(id, version:, spec: nil, request_options: {})
8
+ # @overload update(id, version:, spec:, request_options: {})
12
9
  #
13
- # @param id [String] Path param: The ID of the node
10
+ # @param id [String] Path param
14
11
  #
15
- # @param version [Integer] Query param: The version number of the node object being updated. This is requir
12
+ # @param version [Integer] Query param
16
13
  #
17
14
  # @param spec [DockerEngineRuby::Models::Spec] Body param
18
15
  #
@@ -33,15 +30,11 @@ module DockerEngineRuby
33
30
  )
34
31
  end
35
32
 
36
- # Some parameter documentations has been truncated, see
37
- # {DockerEngineRuby::Models::NodeListParams} for more details.
38
- #
39
33
  # List nodes
40
34
  #
41
35
  # @overload list(filters: nil, request_options: {})
42
36
  #
43
- # @param filters [String] Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).
44
- #
37
+ # @param filters [String]
45
38
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
46
39
  #
47
40
  # @return [Array<DockerEngineRuby::Models::Node>]
@@ -62,10 +55,8 @@ module DockerEngineRuby
62
55
  #
63
56
  # @overload delete(id, force: nil, request_options: {})
64
57
  #
65
- # @param id [String] The ID or name of the node
66
- #
67
- # @param force [Boolean] Force remove a node from the swarm
68
- #
58
+ # @param id [String]
59
+ # @param force [Boolean]
69
60
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
70
61
  #
71
62
  # @return [nil]
@@ -86,8 +77,7 @@ module DockerEngineRuby
86
77
  #
87
78
  # @overload inspect_(id, request_options: {})
88
79
  #
89
- # @param id [String] The ID or name of the node
90
- #
80
+ # @param id [String]
91
81
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
92
82
  #
93
83
  # @return [DockerEngineRuby::Models::Node]
@@ -3,14 +3,11 @@
3
3
  module DockerEngineRuby
4
4
  module Resources
5
5
  class Plugins
6
- # Some parameter documentations has been truncated, see
7
- # {DockerEngineRuby::Models::PluginCreateParams} for more details.
8
- #
9
6
  # Create a plugin
10
7
  #
11
8
  # @overload create(name:, body:, request_options: {})
12
9
  #
13
- # @param name [String] Query param: The name of the plugin. The `:latest` tag is optional, and is the
10
+ # @param name [String] Query param
14
11
  #
15
12
  # @param body [Pathname, StringIO, IO, String, DockerEngineRuby::FilePart] Body param
16
13
  #
@@ -25,22 +22,18 @@ module DockerEngineRuby
25
22
  method: :post,
26
23
  path: "plugins/create",
27
24
  query: parsed.except(:body),
28
- headers: {"content-type" => "application/x-tar"},
25
+ headers: {"content-type" => "application/octet-stream"},
29
26
  body: parsed[:body],
30
27
  model: NilClass,
31
28
  options: options
32
29
  )
33
30
  end
34
31
 
35
- # Some parameter documentations has been truncated, see
36
- # {DockerEngineRuby::Models::PluginListParams} for more details.
37
- #
38
- # Returns information about installed plugins.
32
+ # List plugins
39
33
  #
40
34
  # @overload list(filters: nil, request_options: {})
41
35
  #
42
- # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
43
- #
36
+ # @param filters [String]
44
37
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
45
38
  #
46
39
  # @return [Array<DockerEngineRuby::Models::Plugin>]
@@ -57,17 +50,12 @@ module DockerEngineRuby
57
50
  )
58
51
  end
59
52
 
60
- # Some parameter documentations has been truncated, see
61
- # {DockerEngineRuby::Models::PluginDeleteParams} for more details.
62
- #
63
53
  # Remove a plugin
64
54
  #
65
55
  # @overload delete(name, force: nil, request_options: {})
66
56
  #
67
- # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
68
- #
69
- # @param force [Boolean] Disable the plugin before removing. This may result in issues if the
70
- #
57
+ # @param name [String]
58
+ # @param force [Boolean]
71
59
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
72
60
  #
73
61
  # @return [DockerEngineRuby::Models::Plugin]
@@ -84,17 +72,12 @@ module DockerEngineRuby
84
72
  )
85
73
  end
86
74
 
87
- # Some parameter documentations has been truncated, see
88
- # {DockerEngineRuby::Models::PluginDisableParams} for more details.
89
- #
90
75
  # Disable a plugin
91
76
  #
92
77
  # @overload disable(name, force: nil, request_options: {})
93
78
  #
94
- # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
95
- #
96
- # @param force [Boolean] Force disable a plugin even if still in use.
97
- #
79
+ # @param name [String]
80
+ # @param force [Boolean]
98
81
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
99
82
  #
100
83
  # @return [nil]
@@ -111,17 +94,12 @@ module DockerEngineRuby
111
94
  )
112
95
  end
113
96
 
114
- # Some parameter documentations has been truncated, see
115
- # {DockerEngineRuby::Models::PluginEnableParams} for more details.
116
- #
117
97
  # Enable a plugin
118
98
  #
119
99
  # @overload enable(name, timeout: nil, request_options: {})
120
100
  #
121
- # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
122
- #
123
- # @param timeout [Integer] Set the HTTP client timeout (in seconds)
124
- #
101
+ # @param name [String]
102
+ # @param timeout [Integer]
125
103
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
126
104
  #
127
105
  # @return [nil]
@@ -138,15 +116,11 @@ module DockerEngineRuby
138
116
  )
139
117
  end
140
118
 
141
- # Some parameter documentations has been truncated, see
142
- # {DockerEngineRuby::Models::PluginInspectParams} for more details.
143
- #
144
119
  # Inspect a plugin
145
120
  #
146
121
  # @overload inspect_(name, request_options: {})
147
122
  #
148
- # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
149
- #
123
+ # @param name [String]
150
124
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
151
125
  #
152
126
  # @return [DockerEngineRuby::Models::Plugin]
@@ -161,15 +135,11 @@ module DockerEngineRuby
161
135
  )
162
136
  end
163
137
 
164
- # Some parameter documentations has been truncated, see
165
- # {DockerEngineRuby::Models::PluginPrivilegesParams} for more details.
166
- #
167
138
  # Get plugin privileges
168
139
  #
169
140
  # @overload privileges(remote:, request_options: {})
170
141
  #
171
- # @param remote [String] The name of the plugin. The `:latest` tag is optional, and is the
172
- #
142
+ # @param remote [String]
173
143
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
174
144
  #
175
145
  # @return [Array<DockerEngineRuby::Models::Privilege>]
@@ -186,22 +156,17 @@ module DockerEngineRuby
186
156
  )
187
157
  end
188
158
 
189
- # Some parameter documentations has been truncated, see
190
- # {DockerEngineRuby::Models::PluginPullParams} for more details.
159
+ # Install a plugin
191
160
  #
192
- # Pulls and installs a plugin. After the plugin is installed, it can be enabled
193
- # using the
194
- # [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).
161
+ # @overload pull(remote:, body:, name: nil, x_registry_auth: nil, request_options: {})
195
162
  #
196
- # @overload pull(remote:, name: nil, body: nil, x_registry_auth: nil, request_options: {})
197
- #
198
- # @param remote [String] Query param: Remote reference for plugin to install.
199
- #
200
- # @param name [String] Query param: Local name for the pulled plugin.
163
+ # @param remote [String] Query param
201
164
  #
202
165
  # @param body [Array<DockerEngineRuby::Models::Privilege>] Body param
203
166
  #
204
- # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration to use when pulling a plugi
167
+ # @param name [String] Query param
168
+ #
169
+ # @param x_registry_auth [String] Header param
205
170
  #
206
171
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
207
172
  #
@@ -222,15 +187,11 @@ module DockerEngineRuby
222
187
  )
223
188
  end
224
189
 
225
- # Some parameter documentations has been truncated, see
226
- # {DockerEngineRuby::Models::PluginPushParams} for more details.
227
- #
228
- # Push a plugin to the registry.
190
+ # Push a plugin
229
191
  #
230
192
  # @overload push(name, request_options: {})
231
193
  #
232
- # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
233
- #
194
+ # @param name [String]
234
195
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
235
196
  #
236
197
  # @return [nil]
@@ -245,23 +206,18 @@ module DockerEngineRuby
245
206
  )
246
207
  end
247
208
 
248
- # Some parameter documentations has been truncated, see
249
- # {DockerEngineRuby::Models::PluginSetParams} for more details.
250
- #
251
209
  # Configure a plugin
252
210
  #
253
- # @overload set(name, body: nil, request_options: {})
254
- #
255
- # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
211
+ # @overload set(name, body:, request_options: {})
256
212
  #
213
+ # @param name [String]
257
214
  # @param body [Array<String>]
258
- #
259
215
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
260
216
  #
261
217
  # @return [nil]
262
218
  #
263
219
  # @see DockerEngineRuby::Models::PluginSetParams
264
- def set(name, params = {})
220
+ def set(name, params)
265
221
  parsed, options = DockerEngineRuby::PluginSetParams.dump_request(params)
266
222
  @client.request(
267
223
  method: :post,
@@ -272,20 +228,17 @@ module DockerEngineRuby
272
228
  )
273
229
  end
274
230
 
275
- # Some parameter documentations has been truncated, see
276
- # {DockerEngineRuby::Models::PluginUpgradeParams} for more details.
277
- #
278
231
  # Upgrade a plugin
279
232
  #
280
- # @overload upgrade(name, remote:, body: nil, x_registry_auth: nil, request_options: {})
233
+ # @overload upgrade(name, remote:, body:, x_registry_auth: nil, request_options: {})
281
234
  #
282
- # @param name [String] Path param: The name of the plugin. The `:latest` tag is optional, and is the
235
+ # @param name [String] Path param
283
236
  #
284
- # @param remote [String] Query param: Remote reference to upgrade to.
237
+ # @param remote [String] Query param
285
238
  #
286
239
  # @param body [Array<DockerEngineRuby::Models::Privilege>] Body param
287
240
  #
288
- # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration to use when pulling a plugi
241
+ # @param x_registry_auth [String] Header param
289
242
  #
290
243
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
291
244
  #
@@ -5,15 +5,15 @@ module DockerEngineRuby
5
5
  class Secrets
6
6
  # Create a secret
7
7
  #
8
- # @overload create(spec: nil, request_options: {})
8
+ # @overload create(spec:, request_options: {})
9
9
  #
10
- # @param spec [DockerEngineRuby::Models::SecretCreateParams::Spec]
10
+ # @param spec [DockerEngineRuby::Models::Spec]
11
11
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
12
12
  #
13
13
  # @return [DockerEngineRuby::Models::SecretCreateResponse]
14
14
  #
15
15
  # @see DockerEngineRuby::Models::SecretCreateParams
16
- def create(params = {})
16
+ def create(params)
17
17
  parsed, options = DockerEngineRuby::SecretCreateParams.dump_request(params)
18
18
  @client.request(
19
19
  method: :post,
@@ -24,16 +24,13 @@ module DockerEngineRuby
24
24
  )
25
25
  end
26
26
 
27
- # Some parameter documentations has been truncated, see
28
- # {DockerEngineRuby::Models::SecretUpdateParams} for more details.
29
- #
30
27
  # Update a Secret
31
28
  #
32
- # @overload update(id, version:, spec: nil, request_options: {})
29
+ # @overload update(id, version:, spec:, request_options: {})
33
30
  #
34
- # @param id [String] Path param: The ID or name of the secret
31
+ # @param id [String] Path param
35
32
  #
36
- # @param version [Integer] Query param: The version number of the secret object being updated. This is
33
+ # @param version [Integer] Query param
37
34
  #
38
35
  # @param spec [DockerEngineRuby::Models::Spec] Body param
39
36
  #
@@ -54,15 +51,11 @@ module DockerEngineRuby
54
51
  )
55
52
  end
56
53
 
57
- # Some parameter documentations has been truncated, see
58
- # {DockerEngineRuby::Models::SecretListParams} for more details.
59
- #
60
54
  # List secrets
61
55
  #
62
56
  # @overload list(filters: nil, request_options: {})
63
57
  #
64
- # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
65
- #
58
+ # @param filters [String]
66
59
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
67
60
  #
68
61
  # @return [Array<DockerEngineRuby::Models::Secret>]
@@ -83,8 +76,7 @@ module DockerEngineRuby
83
76
  #
84
77
  # @overload delete(id, request_options: {})
85
78
  #
86
- # @param id [String] ID of the secret
87
- #
79
+ # @param id [String]
88
80
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
89
81
  #
90
82
  # @return [nil]
@@ -103,8 +95,7 @@ module DockerEngineRuby
103
95
  #
104
96
  # @overload inspect_(id, request_options: {})
105
97
  #
106
- # @param id [String] ID of the secret
107
- #
98
+ # @param id [String]
108
99
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
109
100
  #
110
101
  # @return [DockerEngineRuby::Models::Secret]
@@ -3,16 +3,13 @@
3
3
  module DockerEngineRuby
4
4
  module Resources
5
5
  class Services
6
- # Some parameter documentations has been truncated, see
7
- # {DockerEngineRuby::Models::ServiceCreateParams} for more details.
8
- #
9
6
  # Create a service
10
7
  #
11
8
  # @overload create(spec:, x_registry_auth: nil, request_options: {})
12
9
  #
13
- # @param spec [DockerEngineRuby::Models::ServiceCreateParams::Spec] Body param: User modifiable configuration for a service.
10
+ # @param spec [DockerEngineRuby::Models::Spec] Body param: User modifiable configuration for a service.
14
11
  #
15
- # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration for pulling from private
12
+ # @param x_registry_auth [String] Header param
16
13
  #
17
14
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
18
15
  #
@@ -31,24 +28,21 @@ module DockerEngineRuby
31
28
  )
32
29
  end
33
30
 
34
- # Some parameter documentations has been truncated, see
35
- # {DockerEngineRuby::Models::ServiceUpdateParams} for more details.
36
- #
37
31
  # Update a service
38
32
  #
39
33
  # @overload update(id, version:, spec:, registry_auth_from: nil, rollback: nil, x_registry_auth: nil, request_options: {})
40
34
  #
41
- # @param id [String] Path param: ID or name of service.
35
+ # @param id [String] Path param
42
36
  #
43
- # @param version [Integer] Query param: The version number of the service object being updated. This is
37
+ # @param version [Integer] Query param
44
38
  #
45
- # @param spec [DockerEngineRuby::Models::ServiceUpdateParams::Spec] Body param: User modifiable configuration for a service.
39
+ # @param spec [DockerEngineRuby::Models::Spec] Body param: User modifiable configuration for a service.
46
40
  #
47
- # @param registry_auth_from [Symbol, DockerEngineRuby::Models::ServiceUpdateParams::RegistryAuthFrom] Query param: If the `X-Registry-Auth` header is not specified, this parameter
41
+ # @param registry_auth_from [Symbol, DockerEngineRuby::Models::ServiceUpdateParams::RegistryAuthFrom] Query param
48
42
  #
49
- # @param rollback [String] Query param: Set to this parameter to `previous` to cause a server-side rollback
43
+ # @param rollback [String] Query param
50
44
  #
51
- # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration for pulling from private
45
+ # @param x_registry_auth [String] Header param
52
46
  #
53
47
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
54
48
  #
@@ -69,17 +63,12 @@ module DockerEngineRuby
69
63
  )
70
64
  end
71
65
 
72
- # Some parameter documentations has been truncated, see
73
- # {DockerEngineRuby::Models::ServiceListParams} for more details.
74
- #
75
66
  # List services
76
67
  #
77
68
  # @overload list(filters: nil, status: nil, request_options: {})
78
69
  #
79
- # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
80
- #
81
- # @param status [Boolean] Include service status, with count of running and desired tasks.
82
- #
70
+ # @param filters [String]
71
+ # @param status [Boolean]
83
72
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
84
73
  #
85
74
  # @return [Array<DockerEngineRuby::Models::Service>]
@@ -100,8 +89,7 @@ module DockerEngineRuby
100
89
  #
101
90
  # @overload delete(id, request_options: {})
102
91
  #
103
- # @param id [String] ID or name of service.
104
- #
92
+ # @param id [String]
105
93
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
106
94
  #
107
95
  # @return [nil]
@@ -120,10 +108,8 @@ module DockerEngineRuby
120
108
  #
121
109
  # @overload inspect_(id, insert_defaults: nil, request_options: {})
122
110
  #
123
- # @param id [String] ID or name of service.
124
- #
125
- # @param insert_defaults [Boolean] Fill empty fields with default values.
126
- #
111
+ # @param id [String]
112
+ # @param insert_defaults [Boolean]
127
113
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
128
114
  #
129
115
  # @return [DockerEngineRuby::Models::Service]
@@ -140,33 +126,18 @@ module DockerEngineRuby
140
126
  )
141
127
  end
142
128
 
143
- # Some parameter documentations has been truncated, see
144
- # {DockerEngineRuby::Models::ServiceLogsParams} for more details.
145
- #
146
- # Get `stdout` and `stderr` logs from a service. See also
147
- # [`/containers/{id}/logs`](#operation/ContainerLogs).
148
- #
149
- # **Note**: This endpoint works only for services with the `local`, `json-file` or
150
- # `journald` logging drivers.
129
+ # Get service logs
151
130
  #
152
131
  # @overload logs(id, details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
153
132
  #
154
- # @param id [String] ID or name of the service
155
- #
156
- # @param details [Boolean] Show service context and extra details provided to logs.
157
- #
158
- # @param follow [Boolean] Keep connection after returning logs.
159
- #
160
- # @param since [Integer] Only return logs since this time, as a UNIX timestamp
161
- #
162
- # @param stderr [Boolean] Return logs from `stderr`
163
- #
164
- # @param stdout [Boolean] Return logs from `stdout`
165
- #
166
- # @param tail [String] Only return this number of log lines from the end of the logs.
167
- #
168
- # @param timestamps [Boolean] Add timestamps to every log line
169
- #
133
+ # @param id [String]
134
+ # @param details [Boolean]
135
+ # @param follow [Boolean]
136
+ # @param since [Integer]
137
+ # @param stderr [Boolean]
138
+ # @param stdout [Boolean]
139
+ # @param tail [String]
140
+ # @param timestamps [Boolean]
170
141
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil]
171
142
  #
172
143
  # @return [StringIO]
@@ -178,7 +149,7 @@ module DockerEngineRuby
178
149
  method: :get,
179
150
  path: ["services/%1$s/logs", id],
180
151
  query: parsed,
181
- headers: {"accept" => "application/vnd.docker.multiplexed-stream"},
152
+ headers: {"accept" => "application/octet-stream"},
182
153
  model: StringIO,
183
154
  options: options
184
155
  )