aspera-cli 4.28.0 → 4.29.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 (237) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +143 -2
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +135 -56
  7. data/GOVERNANCE.md +30 -0
  8. data/LICENSE +201 -0
  9. data/README.md +103 -26
  10. data/SECURITY.md +70 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +9 -6
  13. data/docs/README.md +1633 -609
  14. data/docs/test-mcp-with-ai.md +8 -8
  15. data/lib/aspera/agent/base.rb +23 -2
  16. data/lib/aspera/agent/connect.rb +16 -12
  17. data/lib/aspera/agent/desktop.rb +10 -7
  18. data/lib/aspera/agent/direct.rb +20 -19
  19. data/lib/aspera/agent/factory.rb +6 -3
  20. data/lib/aspera/agent/httpgw.rb +7 -5
  21. data/lib/aspera/agent/node.rb +15 -7
  22. data/lib/aspera/agent/transferd.rb +167 -43
  23. data/lib/aspera/api/alee.rb +4 -1
  24. data/lib/aspera/api/aoc.rb +14 -11
  25. data/lib/aspera/api/ats.rb +4 -2
  26. data/lib/aspera/api/cos_node.rb +7 -4
  27. data/lib/aspera/api/faspex.rb +16 -9
  28. data/lib/aspera/api/httpgw.rb +9 -6
  29. data/lib/aspera/api/node.rb +20 -20
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +71 -65
  32. data/lib/aspera/ascp/log.schema.yaml +1084 -0
  33. data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
  34. data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
  35. data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
  36. data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
  37. data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
  38. data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
  39. data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
  40. data/lib/aspera/ascp/log_analyzer.rb +354 -0
  41. data/lib/aspera/ascp/management.rb +16 -8
  42. data/lib/aspera/ascp/session_errors.rb +217 -0
  43. data/lib/aspera/assert.rb +4 -0
  44. data/lib/aspera/cli/ascp_actions.rb +12 -19
  45. data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
  46. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  47. data/lib/aspera/cli/bootstrapper.rb +37 -33
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +6 -1
  50. data/lib/aspera/cli/command_spec.rb +34 -7
  51. data/lib/aspera/cli/completion/ascli.bash +19 -5
  52. data/lib/aspera/cli/completion/ascli.fish +13 -2
  53. data/lib/aspera/cli/completion/ascli.ps1 +31 -9
  54. data/lib/aspera/cli/completion/ascli.zsh +22 -6
  55. data/lib/aspera/cli/completion_actions.rb +303 -69
  56. data/lib/aspera/cli/context.rb +9 -4
  57. data/lib/aspera/cli/deprecation.rb +5 -2
  58. data/lib/aspera/cli/error.rb +3 -0
  59. data/lib/aspera/cli/extended_value.rb +61 -27
  60. data/lib/aspera/cli/formatter.rb +29 -22
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -10
  63. data/lib/aspera/cli/http.rb +12 -9
  64. data/lib/aspera/cli/info.rb +12 -7
  65. data/lib/aspera/cli/mailer.rb +6 -3
  66. data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
  67. data/lib/aspera/cli/mcp/secrets.rb +8 -5
  68. data/lib/aspera/cli/mcp/tool.rb +15 -14
  69. data/lib/aspera/cli/option_declarator.rb +10 -4
  70. data/lib/aspera/cli/option_registry.rb +6 -3
  71. data/lib/aspera/cli/option_types.rb +17 -2
  72. data/lib/aspera/cli/option_value.rb +65 -12
  73. data/lib/aspera/cli/options.schema.yaml +487 -63
  74. data/lib/aspera/cli/parser.rb +56 -32
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +244 -35
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +17 -12
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +198 -103
  81. data/lib/aspera/cli/plugins/console.rb +6 -3
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +21 -7
  84. data/lib/aspera/cli/plugins/faspex5.rb +28 -25
  85. data/lib/aspera/cli/plugins/faspio.rb +7 -5
  86. data/lib/aspera/cli/plugins/httpgw.rb +7 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +28 -22
  88. data/lib/aspera/cli/plugins/node.rb +31 -30
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +63 -11
  93. data/lib/aspera/cli/plugins/shares.rb +86 -16
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +144 -30
  96. data/lib/aspera/cli/preset_manager.rb +52 -18
  97. data/lib/aspera/cli/prompt.rb +4 -1
  98. data/lib/aspera/cli/result.rb +12 -8
  99. data/lib/aspera/cli/runner.rb +69 -46
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +79 -9
  102. data/lib/aspera/cli/special_values.rb +4 -1
  103. data/lib/aspera/cli/sync_actions.rb +13 -10
  104. data/lib/aspera/cli/table_fitter.rb +3 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +9 -6
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +29 -20
  108. data/lib/aspera/cli/transfer_progress.rb +13 -45
  109. data/lib/aspera/cli/vault_actions.rb +45 -0
  110. data/lib/aspera/cli/vault_manager.rb +188 -42
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.rb +12 -10
  113. data/lib/aspera/cli/wizard.rb +42 -39
  114. data/lib/aspera/command_line_builder.rb +9 -5
  115. data/lib/aspera/command_line_converter.rb +4 -1
  116. data/lib/aspera/coverage.rb +103 -33
  117. data/lib/aspera/data_repository.rb +4 -1
  118. data/lib/aspera/dot_container.rb +4 -1
  119. data/lib/aspera/duration.rb +5 -2
  120. data/lib/aspera/environment.rb +21 -12
  121. data/lib/aspera/exec_spec.rb +3 -0
  122. data/lib/aspera/faspex_gw.rb +13 -9
  123. data/lib/aspera/faspex_postproc.rb +15 -12
  124. data/lib/aspera/formatter_interface.rb +4 -1
  125. data/lib/aspera/graphql.rb +5 -1
  126. data/lib/aspera/hash_ext.rb +3 -0
  127. data/lib/aspera/id_generator.rb +4 -2
  128. data/lib/aspera/json_rpc/client.rb +6 -5
  129. data/lib/aspera/json_rpc/version.rb +3 -0
  130. data/lib/aspera/line_logger.rb +4 -1
  131. data/lib/aspera/link_header.rb +4 -1
  132. data/lib/aspera/log.rb +18 -5
  133. data/lib/aspera/markdown.rb +5 -2
  134. data/lib/aspera/mime.rb +3 -0
  135. data/lib/aspera/nagios.rb +6 -4
  136. data/lib/aspera/node_emulator.rb +15 -13
  137. data/lib/aspera/oauth/client/base.rb +91 -70
  138. data/lib/aspera/oauth/client/boot.rb +7 -4
  139. data/lib/aspera/oauth/client/factory.rb +6 -3
  140. data/lib/aspera/oauth/client/generic.rb +5 -1
  141. data/lib/aspera/oauth/client/json_credentials.rb +4 -1
  142. data/lib/aspera/oauth/client/jwt.rb +6 -3
  143. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  144. data/lib/aspera/oauth/client/url_json.rb +4 -1
  145. data/lib/aspera/oauth/client/web.rb +39 -12
  146. data/lib/aspera/oauth/server/pkce.rb +6 -5
  147. data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
  148. data/lib/aspera/persistency_action_once.rb +5 -3
  149. data/lib/aspera/persistency_folder.rb +6 -3
  150. data/lib/aspera/preview/file_types.rb +6 -3
  151. data/lib/aspera/preview/generator.rb +9 -5
  152. data/lib/aspera/preview/options.schema.yaml +3 -3
  153. data/lib/aspera/preview/terminal.rb +8 -4
  154. data/lib/aspera/preview/utils.rb +6 -4
  155. data/lib/aspera/products/connect.rb +5 -2
  156. data/lib/aspera/products/desktop.rb +4 -1
  157. data/lib/aspera/products/other.rb +4 -2
  158. data/lib/aspera/products/transferd.rb +6 -2
  159. data/lib/aspera/products/transferd_service.rb +610 -0
  160. data/lib/aspera/proxy_auto_config.js +2 -2
  161. data/lib/aspera/proxy_auto_config.rb +5 -2
  162. data/lib/aspera/rainbow.rb +3 -0
  163. data/lib/aspera/rest/aspera_errors.rb +4 -1
  164. data/lib/aspera/rest/call_error.rb +3 -0
  165. data/lib/aspera/rest/client.rb +22 -29
  166. data/lib/aspera/rest/error_analyzer.rb +5 -2
  167. data/lib/aspera/rest/list.rb +8 -4
  168. data/lib/aspera/rest/parameters.rb +3 -0
  169. data/lib/aspera/rest/util.rb +8 -5
  170. data/lib/aspera/rest.rb +9 -6
  171. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
  172. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
  173. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  174. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  175. data/lib/aspera/schema/async_tables.yaml +11 -10
  176. data/lib/aspera/schema/documentation.rb +8 -2
  177. data/lib/aspera/schema/reader.rb +7 -0
  178. data/lib/aspera/schema/registry.rb +43 -28
  179. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  180. data/lib/aspera/schema/validator.rb +4 -1
  181. data/lib/aspera/sealed_hash.rb +166 -0
  182. data/lib/aspera/secret/hider.rb +201 -0
  183. data/lib/aspera/secret/reference.rb +150 -0
  184. data/lib/aspera/secret/resolver.rb +212 -0
  185. data/lib/aspera/secret/store/base.rb +153 -0
  186. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  187. data/lib/aspera/secret/store/factory.rb +103 -0
  188. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  189. data/lib/aspera/secret/store/keeper.rb +141 -0
  190. data/lib/aspera/secret/store/macos_security.rb +284 -0
  191. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  192. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  193. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  194. data/lib/aspera/secret/store/secret_service.rb +125 -0
  195. data/lib/aspera/secret/strength.rb +119 -0
  196. data/lib/aspera/servlet_helpers.rb +5 -2
  197. data/lib/aspera/ssh.rb +10 -7
  198. data/lib/aspera/ssl.rb +5 -2
  199. data/lib/aspera/string_ext.rb +3 -0
  200. data/lib/aspera/sync/args.schema.yaml +3 -0
  201. data/lib/aspera/sync/conf.schema.yaml +9 -4
  202. data/lib/aspera/sync/database.rb +3 -0
  203. data/lib/aspera/sync/operations.rb +16 -14
  204. data/lib/aspera/temp_file_manager.rb +8 -4
  205. data/lib/aspera/timer_limiter.rb +3 -0
  206. data/lib/aspera/transfer/error.rb +4 -1
  207. data/lib/aspera/transfer/faux_file.rb +4 -1
  208. data/lib/aspera/transfer/parameters.rb +17 -14
  209. data/lib/aspera/transfer/result.rb +3 -0
  210. data/lib/aspera/transfer/resumer.rb +6 -4
  211. data/lib/aspera/transfer/spec.rb +9 -22
  212. data/lib/aspera/transfer/units.rb +75 -0
  213. data/lib/aspera/uri_reader.rb +57 -7
  214. data/lib/aspera/web_auth/index.html.erb +6 -2
  215. data/lib/aspera/web_auth/paste.rb +109 -0
  216. data/lib/aspera/web_auth/receiver.rb +50 -0
  217. data/lib/aspera/web_auth/relay.rb +76 -0
  218. data/lib/aspera/web_auth/reply.html.erb +150 -0
  219. data/lib/aspera/web_auth/server.rb +47 -10
  220. data/lib/aspera/web_page.rb +7 -2
  221. data/lib/aspera/web_server_simple.rb +6 -3
  222. data/lib/aspera/yaml.rb +5 -1
  223. data/llms.txt +81 -0
  224. data/skills/ascli/SKILL.md +88 -0
  225. data.tar.gz.sig +0 -0
  226. metadata +72 -19
  227. metadata.gz.sig +0 -0
  228. data/lib/aspera/keychain/base.rb +0 -30
  229. data/lib/aspera/keychain/encrypted_hash.rb +0 -192
  230. data/lib/aspera/keychain/factory.rb +0 -58
  231. data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
  232. data/lib/aspera/keychain/macos_security.rb +0 -277
  233. data/lib/aspera/keychain/one_password_api.rb +0 -91
  234. data/lib/aspera/keychain/one_password_base.rb +0 -39
  235. data/lib/aspera/keychain/one_password_cli.rb +0 -100
  236. data/lib/aspera/secret_hider.rb +0 -196
  237. data/lib/aspera/secret_strength.rb +0 -114
@@ -1,22 +1,25 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/mime'
4
- require 'aspera/rest/parameters'
5
- require 'aspera/rest/util'
6
- require 'aspera/rest/call_error'
7
- require 'aspera/rest/error_analyzer'
8
- require 'aspera/log'
9
- require 'aspera/assert'
10
- require 'aspera/oauth/client/factory'
11
- require 'aspera/hash_ext'
12
- require 'aspera/timer_limiter'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative '../mime'
7
+ require_relative 'parameters'
8
+ require_relative 'util'
9
+ require_relative 'call_error'
10
+ require_relative 'error_analyzer'
11
+ require_relative '../log'
12
+ require_relative '../assert'
13
+ require_relative '../oauth/client/factory'
14
+ require_relative '../hash_ext'
15
+ require_relative '../timer_limiter'
16
+ require_relative '../rainbow'
13
17
  require 'net/http'
14
18
  require 'net/https'
15
19
  require 'json'
16
20
  require 'securerandom'
17
21
  require 'fileutils'
18
22
  require 'pathname'
19
- require 'aspera/rainbow'
20
23
  using Rainbow
21
24
 
22
25
  # Cancel method for HTTP
@@ -202,11 +205,15 @@ module Aspera
202
205
  # not authorized: OAuth token expired
203
206
  if !token_renewed && @not_auth_codes.include?(result_http.code.to_s) && @auth_params[:type].eql?(:oauth2)
204
207
  token_renewed = true
205
- new_authorization = renew_oauth_authorization
206
- unless new_authorization.nil?
208
+ begin
209
+ req_headers['Authorization'] = oauth.renewed_authorization
207
210
  Log.log.debug('using new token')
208
- req_headers['Authorization'] = new_authorization
209
211
  retry
212
+ rescue StandardError => e_renew
213
+ # The reason why no token could be obtained is more useful than the original error
214
+ raise e_renew if exception
215
+ # No exception requested: the result is the original response
216
+ Log.log.error { "Token renewal failed: #{e_renew.message}" }
210
217
  end
211
218
  end
212
219
  if retry_error?(e) && (error_tries -= 1).positive?
@@ -266,20 +273,6 @@ module Aspera
266
273
  sleep(Parameters.instance.retry_sleep) unless Parameters.instance.retry_sleep.eql?(0)
267
274
  end
268
275
 
269
- # Renew OAuth token: use refresh token, or generate a new one
270
- # @return [String, nil] New value for header `Authorization`, or `nil` if no new token could be obtained
271
- def renew_oauth_authorization
272
- oauth.authorization(refresh: true)
273
- rescue StandardError => e
274
- Log.log.error("refresh failed: #{e.message}".bg(:red))
275
- begin
276
- oauth.authorization(cache: false)
277
- rescue StandardError => e
278
- Log.log.error("new token failed: #{e.message}".bg(:red))
279
- nil
280
- end
281
- end
282
-
283
276
  # Forward the call to the location of a redirect response.
284
277
  # Same server: same API parameters (auth, headers). Other server: credentials are not forwarded.
285
278
  # @param request_uri [URI] URI of the redirected request
@@ -515,7 +508,7 @@ module Aspera
515
508
  end
516
509
 
517
510
  # HTTP codes of service unavailable
518
- UNAVAILABLE_CODES = ['503']
511
+ UNAVAILABLE_CODES = ['503'].freeze
519
512
  # Network errors that can be retried
520
513
  NETWORK_ERRORS = [
521
514
  Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout,
@@ -1,7 +1,10 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/rest/call_error'
4
- require 'aspera/log'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'call_error'
7
+ require_relative '../log'
5
8
  require 'singleton'
6
9
  require 'net/http'
7
10
 
@@ -1,9 +1,13 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/rest/parameters'
4
- require 'aspera/mime'
5
- require 'aspera/assert'
6
- require 'aspera/log'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'parameters'
7
+ require_relative '../cli/error'
8
+ require_relative '../mime'
9
+ require_relative '../assert'
10
+ require_relative '../log'
7
11
 
8
12
  module Aspera
9
13
  module Rest
@@ -1,5 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
3
6
  require 'singleton'
4
7
 
5
8
  module Aspera
@@ -1,9 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/rest/parameters'
4
- require 'aspera/log'
5
- require 'aspera/assert'
6
- require 'aspera/secret_hider'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'parameters'
7
+ require_relative '../log'
8
+ require_relative '../assert'
9
+ require_relative '../secret/hider'
7
10
  require 'net/http'
8
11
  require 'net/https'
9
12
  require 'uri'
@@ -20,7 +23,7 @@ module Aspera
20
23
  def basic_authorization(user, pass)
21
24
  credentials = Base64.strict_encode64("#{user}:#{pass}")
22
25
  # Hidden wherever it appears (logs, results)
23
- SecretHider.instance.add_secret_values(credentials)
26
+ Secret::Hider.instance.add_secret_values(credentials)
24
27
  "Basic #{credentials}"
25
28
  end
26
29
 
data/lib/aspera/rest.rb CHANGED
@@ -1,8 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'aspera/rest/parameters'
4
- require 'aspera/rest/util'
5
- require 'aspera/rest/call_error'
6
- require 'aspera/rest/error_analyzer'
7
- require 'aspera/rest/client'
8
- require 'aspera/rest/list'
3
+ # SPDX-FileCopyrightText: IBM Corp.
4
+ # SPDX-License-Identifier: Apache-2.0
5
+
6
+ require_relative 'rest/parameters'
7
+ require_relative 'rest/util'
8
+ require_relative 'rest/call_error'
9
+ require_relative 'rest/error_analyzer'
10
+ require_relative 'rest/client'
11
+ require_relative 'rest/list'
@@ -39576,13 +39576,13 @@ components:
39576
39576
  description: JWT access token used to authorize access to protected endpoints.
39577
39577
  type: string
39578
39578
  examples:
39579
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6IiIsImV4cCI6MTYwMzI3MDIxNywiYXVkIjoiZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwianRpIjoiZ2VyYXJkOGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwiaWF0IjoxNjAzMjI3MDE3LCJzdWIiOiJjbGllbnQ6ZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIn0.dsXeTd4USW0MS6N265fdPhZZo4YsnIPyKVDVJ0sHwg9bI5DH5alesqKqjyZSNo7fQ0EZXlbtVuSlX0geYXSE4PnaMnIv5vH1D9OnMtfj1ms3u1DI2ee_1bVvgCb3g3uA81etnRTwzn9e1RuXjpe4_kAiOOURGPRJMTbjju2GFErAFFunZavaw-e3VdHDIvhmKgJIGuGzqPJSs1n10RixJocSQsve-S0c3UYcY5kES8MmqZk9Ap5iYskak8gK5JO3BT1-GNydG11RpDbGg-7mDd3s4IhRGRnBCYBCfdqwfWohGOpecV6NNlA6N8w0k7Hs1aNXEZO-yYE-dIPkEezOvQ
39579
+ - <ACCESS_TOKEN>
39580
39580
  minLength: 1
39581
39581
  refresh_token:
39582
39582
  description: The refresh token used to request a new access token. This is required when `grant_type = refresh_token`.
39583
39583
  type: string
39584
39584
  examples:
39585
- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMj
39585
+ - <REFRESH_TOKEN>
39586
39586
  maxLength: 255
39587
39587
  minLength: 1
39588
39588
  JwtGetTokenRequest:
@@ -39604,7 +39604,7 @@ components:
39604
39604
  description: JWT access token used to authorize access to protected endpoints.
39605
39605
  type: string
39606
39606
  examples:
39607
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6IiIsImV4cCI6MTYwMzI3MDIxNywiYXVkIjoiZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwianRpIjoiZ2VyYXJkOGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwiaWF0IjoxNjAzMjI3MDE3LCJzdWIiOiJjbGllbnQ6ZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIn0.dsXeTd4USW0MS6N265fdPhZZo4YsnIPyKVDVJ0sHwg9bI5DH5alesqKqjyZSNo7fQ0EZXlbtVuSlX0geYXSE4PnaMnIv5vH1D9OnMtfj1ms3u1DI2ee_1bVvgCb3g3uA81etnRTwzn9e1RuXjpe4_kAiOOURGPRJMTbjju2GFErAFFunZavaw-e3VdHDIvhmKgJIGuGzqPJSs1n10RixJocSQsve-S0c3UYcY5kES8MmqZk9Ap5iYskak8gK5JO3BT1-GNydG11RpDbGg-7mDd3s4IhRGRnBCYBCfdqwfWohGOpecV6NNlA6N8w0k7Hs1aNXEZO-yYE-dIPkEezOvQ
39607
+ - <ACCESS_TOKEN>
39608
39608
  minLength: 1
39609
39609
  WebPostTokenRequest:
39610
39610
  description: Parameters to authorize to an OAuth 2 client.
@@ -39637,7 +39637,7 @@ components:
39637
39637
  description: JWT access token used to authorize access to protected endpoints.
39638
39638
  type: string
39639
39639
  examples:
39640
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6IiIsImV4cCI6MTYwMzI3MDIxNywiYXVkIjoiZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwianRpIjoiZ2VyYXJkOGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwiaWF0IjoxNjAzMjI3MDE3LCJzdWIiOiJjbGllbnQ6ZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIn0.dsXeTd4USW0MS6N265fdPhZZo4YsnIPyKVDVJ0sHwg9bI5DH5alesqKqjyZSNo7fQ0EZXlbtVuSlX0geYXSE4PnaMnIv5vH1D9OnMtfj1ms3u1DI2ee_1bVvgCb3g3uA81etnRTwzn9e1RuXjpe4_kAiOOURGPRJMTbjju2GFErAFFunZavaw-e3VdHDIvhmKgJIGuGzqPJSs1n10RixJocSQsve-S0c3UYcY5kES8MmqZk9Ap5iYskak8gK5JO3BT1-GNydG11RpDbGg-7mDd3s4IhRGRnBCYBCfdqwfWohGOpecV6NNlA6N8w0k7Hs1aNXEZO-yYE-dIPkEezOvQ
39640
+ - <ACCESS_TOKEN>
39641
39641
  minLength: 1
39642
39642
  redirect_uri:
39643
39643
  description: The URL to redirect users to after successful authentication. Must use the HTTPS protocol.
@@ -39674,7 +39674,7 @@ components:
39674
39674
  description: The refresh token used to request a new access token. This is required when `grant_type = refresh_token`.
39675
39675
  type: string
39676
39676
  examples:
39677
- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMj
39677
+ - <REFRESH_TOKEN>
39678
39678
  maxLength: 255
39679
39679
  minLength: 1
39680
39680
  client_secret:
@@ -39719,7 +39719,7 @@ components:
39719
39719
  description: JWT access token used to authorize access to protected endpoints.
39720
39720
  type: string
39721
39721
  examples:
39722
- - eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6IiIsImV4cCI6MTYwMzI3MDIxNywiYXVkIjoiZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwianRpIjoiZ2VyYXJkOGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIiwiaWF0IjoxNjAzMjI3MDE3LCJzdWIiOiJjbGllbnQ6ZThiM2Q2OGEtYmNlOC00OTQzLWExY2EtMjliZWQxMzRhZWQxIn0.dsXeTd4USW0MS6N265fdPhZZo4YsnIPyKVDVJ0sHwg9bI5DH5alesqKqjyZSNo7fQ0EZXlbtVuSlX0geYXSE4PnaMnIv5vH1D9OnMtfj1ms3u1DI2ee_1bVvgCb3g3uA81etnRTwzn9e1RuXjpe4_kAiOOURGPRJMTbjju2GFErAFFunZavaw-e3VdHDIvhmKgJIGuGzqPJSs1n10RixJocSQsve-S0c3UYcY5kES8MmqZk9Ap5iYskak8gK5JO3BT1-GNydG11RpDbGg-7mDd3s4IhRGRnBCYBCfdqwfWohGOpecV6NNlA6N8w0k7Hs1aNXEZO-yYE-dIPkEezOvQ
39722
+ - <ACCESS_TOKEN>
39723
39723
  minLength: 1
39724
39724
  redirect_uri:
39725
39725
  description: The URL to redirect users to after successful authentication. Must use the HTTPS protocol.
@@ -39756,7 +39756,7 @@ components:
39756
39756
  description: The refresh token used to request a new access token. This is required when `grant_type = refresh_token`.
39757
39757
  type: string
39758
39758
  examples:
39759
- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMj
39759
+ - <REFRESH_TOKEN>
39760
39760
  maxLength: 255
39761
39761
  minLength: 1
39762
39762
  client_secret:
@@ -39795,7 +39795,7 @@ components:
39795
39795
  description: The assertion for the urn:ietf:params:oauth:grant-type:jwt-bearer grant_type.
39796
39796
  type: string
39797
39797
  examples:
39798
- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
39798
+ - <JWT>
39799
39799
  maxLength: 255
39800
39800
  minLength: 1
39801
39801
  required:
@@ -39826,7 +39826,7 @@ components:
39826
39826
  description: The refresh token used to request a new access token. This is required when `grant_type = refresh_token`.
39827
39827
  type: string
39828
39828
  examples:
39829
- - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMj
39829
+ - <REFRESH_TOKEN>
39830
39830
  maxLength: 255
39831
39831
  minLength: 1
39832
39832
  required:
@@ -29,7 +29,7 @@ info:
29
29
 
30
30
  If JWT authentication is disabled in your Orchestrator configuration (`/api/login` then returns 403), give the credentials with every API request, either:
31
31
 
32
- - as query parameters `login` and `password`, e.g. `/api/workflows_list?login=admin&password=mypassword&format=json`
32
+ - as query parameters `login` and `password`, e.g. `/api/workflows_list?login=admin&password=<PASSWORD>&format=json`
33
33
  - as query parameters `login` and `api_key` (the API key of the user)
34
34
  - with HTTP Basic authentication
35
35
 
@@ -110,12 +110,12 @@ paths:
110
110
  summary: Username and password
111
111
  value:
112
112
  username: admin
113
- password: mypassword
113
+ password: <PASSWORD>
114
114
  api_key:
115
115
  summary: Username and API key
116
116
  value:
117
117
  username: admin
118
- api_key: my_api_key
118
+ api_key: <API_KEY>
119
119
  responses:
120
120
  '200':
121
121
  description: Successfully authenticated
@@ -863,22 +863,33 @@ paths:
863
863
  in: query
864
864
  schema:
865
865
  type: string
866
- description: Filter by work order status, e.g. `Failed`
866
+ description: 'Filter by work order status, comma-separated (case insensitive): `Initializing`, `Initialized`, `Created`, `Ready`, `In Progress`, `Complete`, `Rolled-back`, `Canceled`, `Paused`, `Cut-off`, `Failed`, `Error`, `Destroyed`, `Cleared`, `Flagged`. Not set: all but `Rolled-back`, `Cut-off`, `Ready`, `Destroyed`, `Cleared`, `Flagged` and `Unknown`.'
867
+ examples:
868
+ - Failed,Canceled
867
869
  - name: priority
868
870
  in: query
869
871
  schema:
870
872
  type: string
871
- description: Filter by priority
873
+ enum:
874
+ - low
875
+ - medium
876
+ - high
877
+ - preemptive
878
+ description: 'Filter by priority (case insensitive): `low` (1), `medium` (2), `high` (3) or `preemptive` (below 1). Another value is ignored.'
872
879
  - name: from_date
873
880
  in: query
874
881
  schema:
875
882
  type: string
876
- description: Work orders updated after this date, e.g. `'06-27-2015 02:40:59'`
883
+ description: 'Work orders updated after this date. Format `<date> HH:MM:SS`, with `<date>` as `mm-dd-yyyy` (default), `mm/dd/yyyy` (server date format `american`), `dd-mm-yyyy` (`continental`) or `yyyy-mm-dd` (`swedish`). Another format is ignored.'
884
+ examples:
885
+ - 06-27-2015 02:40:59
877
886
  - name: to_date
878
887
  in: query
879
888
  schema:
880
889
  type: string
881
- description: Work orders updated before this date
890
+ description: 'Work orders updated before this date. Format `<date> HH:MM:SS`, with `<date>` as `mm-dd-yyyy` (default), `mm/dd/yyyy` (server date format `american`), `dd-mm-yyyy` (`continental`) or `yyyy-mm-dd` (`swedish`). Another format is ignored.'
891
+ examples:
892
+ - 06-29-2015 02:40:59
882
893
  - name: tag
883
894
  in: query
884
895
  style: form
@@ -1237,6 +1248,7 @@ paths:
1237
1248
  parameters:
1238
1249
  type: object
1239
1250
  description: Runtime parameters of the work order
1251
+ additionalProperties: true
1240
1252
  - title: Output value
1241
1253
  description: With `explicit_output`, or `explicit_output_step` and `explicit_output_variable`
1242
1254
  '400':
@@ -1552,7 +1564,8 @@ paths:
1552
1564
  type: object
1553
1565
  properties:
1554
1566
  item:
1555
- description: The queued item
1567
+ type: string
1568
+ description: The queued item, as given in `queued_item`
1556
1569
  description:
1557
1570
  type: string
1558
1571
  rank:
@@ -1782,15 +1795,22 @@ paths:
1782
1795
  workflow_name:
1783
1796
  type: string
1784
1797
  last_activity:
1785
- description: Only when active
1798
+ type: string
1799
+ description: Last activity of the workflow or work order (`YYYY-MM-DD HH:MM:SS`), `-` if none. Only when active.
1786
1800
  active:
1787
1801
  type: boolean
1788
1802
  status:
1789
1803
  type: string
1804
+ description: 'Status of the monitor: `Monitoring Off`, `No Issues`, `Alerts`, `Warnings`, or `Fetching` (remote node monitor)'
1805
+ examples:
1806
+ - No Issues
1790
1807
  status_report:
1791
- description: Only when active
1808
+ type: string
1809
+ description: Status text of the monitor, `-` when there is nothing to report. Only when active.
1792
1810
  last_polled:
1793
- description: Only when active
1811
+ type: [string, 'null']
1812
+ format: date-time
1813
+ description: Time of the last refresh of the status. Only when active.
1794
1814
  monitor_workorders:
1795
1815
  type: object
1796
1816
  description: Empty when there is no monitor
@@ -1807,15 +1827,22 @@ paths:
1807
1827
  workflow_name:
1808
1828
  type: string
1809
1829
  last_activity:
1810
- description: Only when active
1830
+ type: string
1831
+ description: Last activity of the workflow or work order (`YYYY-MM-DD HH:MM:SS`), `-` if none. Only when active.
1811
1832
  active:
1812
1833
  type: boolean
1813
1834
  status:
1814
1835
  type: string
1836
+ description: 'Status of the monitor: `Monitoring Off`, `No Issues`, `Alerts`, `Warnings`, or `Fetching` (remote node monitor)'
1837
+ examples:
1838
+ - No Issues
1815
1839
  status_report:
1816
- description: Only when active
1840
+ type: string
1841
+ description: Status text of the monitor, `-` when there is nothing to report. Only when active.
1817
1842
  last_polled:
1818
- description: Only when active
1843
+ type: [string, 'null']
1844
+ format: date-time
1845
+ description: Time of the last refresh of the status. Only when active.
1819
1846
  monitor_folders:
1820
1847
  type: object
1821
1848
  description: Empty when there is no monitor
@@ -1833,17 +1860,25 @@ paths:
1833
1860
  path:
1834
1861
  type: string
1835
1862
  content:
1836
- description: Only when active
1863
+ type: string
1864
+ description: Number of files and folders, e.g. `3 files, 1 folders`, or `-`. Only when active.
1837
1865
  age_range:
1838
- description: Only when active
1866
+ type: string
1867
+ description: Age of the youngest and oldest entries, with the aging unit of the monitor, or `-`. Only when active.
1839
1868
  active:
1840
1869
  type: boolean
1841
1870
  status:
1842
1871
  type: string
1872
+ description: 'Status of the monitor: `Monitoring Off`, `No Issues`, `Alerts`, `Warnings`, or `Fetching` (remote node monitor)'
1873
+ examples:
1874
+ - No Issues
1843
1875
  status_report:
1844
- description: Only when active
1876
+ type: string
1877
+ description: Status text of the monitor, `-` when there is nothing to report. Only when active.
1845
1878
  last_polled:
1846
- description: Only when active
1879
+ type: [string, 'null']
1880
+ format: date-time
1881
+ description: Time of the last refresh of the status. Only when active.
1847
1882
  monitor_nodes:
1848
1883
  type: object
1849
1884
  description: Empty when there is no monitor
@@ -1863,10 +1898,16 @@ paths:
1863
1898
  type: boolean
1864
1899
  status:
1865
1900
  type: string
1901
+ description: 'Status of the monitor: `Monitoring Off`, `No Issues`, `Alerts`, `Warnings`, or `Fetching` (remote node monitor)'
1902
+ examples:
1903
+ - No Issues
1866
1904
  status_report:
1867
- description: Only when active
1905
+ type: string
1906
+ description: Status text of the monitor, `-` when there is nothing to report. Only when active.
1868
1907
  last_polled:
1869
- description: Only when active
1908
+ type: [string, 'null']
1909
+ format: date-time
1910
+ description: Time of the last refresh of the status. Only when active.
1870
1911
  monitor_scripts:
1871
1912
  type: object
1872
1913
  description: Empty when there is no monitor
@@ -1889,10 +1930,16 @@ paths:
1889
1930
  type: boolean
1890
1931
  status:
1891
1932
  type: string
1933
+ description: 'Status of the monitor: `Monitoring Off`, `No Issues`, `Alerts`, `Warnings`, or `Fetching` (remote node monitor)'
1934
+ examples:
1935
+ - No Issues
1892
1936
  status_report:
1893
- description: Only when active
1937
+ type: string
1938
+ description: Status text of the monitor, `-` when there is nothing to report. Only when active.
1894
1939
  last_polled:
1895
- description: Only when active
1940
+ type: [string, 'null']
1941
+ format: date-time
1942
+ description: Time of the last refresh of the status. Only when active.
1896
1943
  '401':
1897
1944
  $ref: '#/components/responses/UnauthorizedError'
1898
1945
  default:
@@ -1917,6 +1964,8 @@ paths:
1917
1964
  description: All the attributes of the monitors. For type `workorder`, each monitor is in an object with key `monitor-workorder`. Remote node monitors give the names of the monitored remote nodes (`remote_node_name`).
1918
1965
  items:
1919
1966
  type: object
1967
+ description: Attributes of one monitor (depend on the monitor type)
1968
+ additionalProperties: true
1920
1969
  '401':
1921
1970
  $ref: '#/components/responses/UnauthorizedError'
1922
1971
  default:
@@ -2075,6 +2124,7 @@ paths:
2075
2124
  task_inputs:
2076
2125
  type: object
2077
2126
  description: Parameters received by the task (name to value)
2127
+ additionalProperties: true
2078
2128
  user_inputs:
2079
2129
  type: array
2080
2130
  items:
@@ -2101,8 +2151,7 @@ paths:
2101
2151
  style: deepObject
2102
2152
  explode: true
2103
2153
  schema:
2104
- type: object
2105
- additionalProperties: true
2154
+ $ref: '#/components/schemas/TaskUserInputs'
2106
2155
  description: Values of the user inputs, e.g. `outputs[Filename]=tron.avi`. All required inputs must be given.
2107
2156
  - name: input_provider
2108
2157
  in: query
@@ -2123,6 +2172,7 @@ paths:
2123
2172
  user_inputs:
2124
2173
  type: object
2125
2174
  description: Values of the user inputs (name to value)
2175
+ additionalProperties: true
2126
2176
  input_provider:
2127
2177
  type: string
2128
2178
  '401':
@@ -2163,6 +2213,7 @@ paths:
2163
2213
  task_inputs:
2164
2214
  type: object
2165
2215
  description: Parameters received by the task (name to value)
2216
+ additionalProperties: true
2166
2217
  user_inputs:
2167
2218
  type: array
2168
2219
  items:
@@ -2605,7 +2656,13 @@ paths:
2605
2656
  in: query
2606
2657
  schema:
2607
2658
  type: string
2608
- description: Only alerts of this category, e.g. `user`
2659
+ enum:
2660
+ - WorkflowAlerts
2661
+ - UserAlerts
2662
+ - WorkorderAlerts
2663
+ - MonitorAlerts
2664
+ - PluginAlerts
2665
+ description: Only alerts of this category (case sensitive). With another value, no alert is returned.
2609
2666
  - $ref: '#/components/parameters/Format'
2610
2667
  responses:
2611
2668
  '200':
@@ -3634,7 +3691,8 @@ components:
3634
3691
  description: Input or output of a work step
3635
3692
  properties:
3636
3693
  value:
3637
- description: Value, of any type
3694
+ type: [string, integer, number, boolean, array, object, 'null']
3695
+ description: 'Value, of the type given by `type`: integer for `int`, number for `float`, boolean for `flag`, array for `array`, object for `hash`, string for the others'
3638
3696
  name:
3639
3697
  type: string
3640
3698
  id:
@@ -3649,7 +3707,8 @@ components:
3649
3707
  id:
3650
3708
  type: integer
3651
3709
  queued_item:
3652
- description: The queued item
3710
+ type: [string, integer, number, boolean, array, object, 'null']
3711
+ description: The queued item, decoded from YAML. A string for an item added with `queue_item`, any type for an item added by a workflow.
3653
3712
  item_description:
3654
3713
  type: [string, 'null']
3655
3714
  priority:
@@ -3741,10 +3800,34 @@ components:
3741
3800
  type:
3742
3801
  type: string
3743
3802
  description: Value type
3803
+ enum: [int, float, string, array, hash, flag, date, object, pwd, attachment]
3744
3804
  value:
3745
- description: Current value
3805
+ type: [string, integer, number, boolean, array, object, 'null']
3806
+ description: 'Current value, of the type given by `type`: integer for `int`, number for `float`, boolean for `flag`, array for `array`, object for `hash`, string for the others'
3746
3807
  required:
3747
3808
  type: boolean
3809
+ TaskUserInputs:
3810
+ type: object
3811
+ description: >-
3812
+ Values of the user inputs of a task: one key per user input, as listed in `user_inputs` of `task_details` (`name`, `type`, `required`).
3813
+ All inputs with `required: true` must be given, else Orchestrator refuses with `Missing data for <names>`.
3814
+ Values are sent as text and converted by Orchestrator to the type of the input:
3815
+ `int` (e.g. `-12`), `float` (e.g. `1.5`), `flag` (`true` or `false`), `date` (e.g. `2026-01-31 10:00:00`),
3816
+ `hash` (JSON or Ruby hash, starts with `{`), `array` (JSON array, or items separated by `;`),
3817
+ `string`, `object` (YAML), `pwd` (password).
3818
+ For an input with `required: true`, a value that does not match the type is refused (`Invalid output type(s)`).
3819
+ An input not given is overwritten with the conversion of the text `nil` (e.g. `0` for an `int`).
3820
+ additionalProperties: true
3821
+ examples:
3822
+ - Retries: '3'
3823
+ Ratio: '1.5'
3824
+ Filename: tron.avi
3825
+ Files: '["a.mov","b.mov"]'
3826
+ Options: '{"quality":"high"}'
3827
+ Approved: 'true'
3828
+ Deadline: '2026-01-31 10:00:00'
3829
+ Metadata: 'title: Tron'
3830
+ Secret: <SECRET>
3748
3831
  MonitorChange:
3749
3832
  type: object
3750
3833
  properties:
@@ -3816,6 +3899,7 @@ components:
3816
3899
  type: integer
3817
3900
  category_id:
3818
3901
  type: [integer, 'null']
3902
+ description: 'Category: 1 `WorkflowAlerts`, 2 `UserAlerts`, 3 `WorkorderAlerts`, 4 `MonitorAlerts`, 5 `PluginAlerts`'
3819
3903
  alert_header:
3820
3904
  type: [string, 'null']
3821
3905
  alert_description:
@@ -3865,9 +3949,13 @@ components:
3865
3949
  type: string
3866
3950
  format: date-time
3867
3951
  Inputs:
3868
- description: Inputs of the test case
3952
+ type: object
3953
+ description: Inputs of the test case (name to value), empty if none
3954
+ additionalProperties: true
3869
3955
  Outputs:
3870
- description: Outputs of the test case
3956
+ type: object
3957
+ description: Outputs of the test case (name to value), `null` values until the test case has run
3958
+ additionalProperties: true
3871
3959
  Result:
3872
3960
  type: [boolean, 'null']
3873
3961
  Result: