@quantum-hub/qhubctl 1.1.1 → 1.1.3

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 (211) hide show
  1. package/README.md +1 -1
  2. package/bin/dev.js +3 -1
  3. package/bin/run.js +1 -1
  4. package/dist/client/kqh/apis/ServicePlatformApplicationsApi.d.ts +2 -2
  5. package/dist/client/kqh/apis/ServicePlatformApplicationsApi.js +9 -46
  6. package/dist/client/kqh/apis/ServicePlatformDashboardApi.d.ts +2 -2
  7. package/dist/client/kqh/apis/ServicePlatformDashboardApi.js +5 -42
  8. package/dist/client/kqh/apis/ServicePlatformDataPoolsApi.d.ts +2 -2
  9. package/dist/client/kqh/apis/ServicePlatformDataPoolsApi.js +11 -48
  10. package/dist/client/kqh/apis/ServicePlatformJobsApi.d.ts +2 -2
  11. package/dist/client/kqh/apis/ServicePlatformJobsApi.js +9 -46
  12. package/dist/client/kqh/apis/ServicePlatformMarketplaceApi.d.ts +2 -2
  13. package/dist/client/kqh/apis/ServicePlatformMarketplaceApi.js +5 -42
  14. package/dist/client/kqh/apis/ServicePlatformMeteringAPIApi.d.ts +2 -2
  15. package/dist/client/kqh/apis/ServicePlatformMeteringAPIApi.js +5 -42
  16. package/dist/client/kqh/apis/ServicePlatformServicesApi.d.ts +2 -2
  17. package/dist/client/kqh/apis/ServicePlatformServicesApi.js +34 -71
  18. package/dist/client/kqh/apis/ServicePlatformSubscriptionsApi.d.ts +2 -2
  19. package/dist/client/kqh/apis/ServicePlatformSubscriptionsApi.js +7 -44
  20. package/dist/client/kqh/apis/TaxonomiesApi.d.ts +2 -2
  21. package/dist/client/kqh/apis/TaxonomiesApi.js +12 -49
  22. package/dist/client/kqh/apis/index.d.ts +9 -9
  23. package/dist/client/kqh/apis/index.js +9 -25
  24. package/dist/client/kqh/index.d.ts +3 -3
  25. package/dist/client/kqh/index.js +3 -19
  26. package/dist/client/kqh/models/AccessTokenDto.js +5 -12
  27. package/dist/client/kqh/models/AmountMajorDto.js +4 -10
  28. package/dist/client/kqh/models/ApiDto.d.ts +2 -2
  29. package/dist/client/kqh/models/ApiDto.js +13 -20
  30. package/dist/client/kqh/models/ApiOverviewDto.d.ts +1 -1
  31. package/dist/client/kqh/models/ApiOverviewDto.js +10 -17
  32. package/dist/client/kqh/models/ApplicationDto.js +5 -12
  33. package/dist/client/kqh/models/BuildJobDto.d.ts +1 -1
  34. package/dist/client/kqh/models/BuildJobDto.js +9 -16
  35. package/dist/client/kqh/models/CpuConfiguration.d.ts +1 -1
  36. package/dist/client/kqh/models/CpuConfiguration.js +7 -13
  37. package/dist/client/kqh/models/CreateApplicationRequest.js +4 -10
  38. package/dist/client/kqh/models/CreateDataPoolRequest.js +4 -10
  39. package/dist/client/kqh/models/CreateExternalServicePricingPlanRequest.d.ts +1 -1
  40. package/dist/client/kqh/models/CreateExternalServicePricingPlanRequest.js +8 -15
  41. package/dist/client/kqh/models/CreateJobRequest.d.ts +1 -1
  42. package/dist/client/kqh/models/CreateJobRequest.js +9 -15
  43. package/dist/client/kqh/models/CreateManagedServicePricingPlanRequest.js +6 -13
  44. package/dist/client/kqh/models/CreateProductRequest.js +4 -10
  45. package/dist/client/kqh/models/CreateSubscriptionRequest.js +4 -10
  46. package/dist/client/kqh/models/CreateWorkflowServiceRequest.js +4 -10
  47. package/dist/client/kqh/models/DataPoolDto.d.ts +3 -3
  48. package/dist/client/kqh/models/DataPoolDto.js +21 -28
  49. package/dist/client/kqh/models/DataPoolRef.js +4 -10
  50. package/dist/client/kqh/models/DataSourceDescriptorDto.d.ts +1 -1
  51. package/dist/client/kqh/models/DataSourceDescriptorDto.js +8 -15
  52. package/dist/client/kqh/models/FileDto.js +4 -10
  53. package/dist/client/kqh/models/FileSource.d.ts +1 -1
  54. package/dist/client/kqh/models/FileSource.js +4 -10
  55. package/dist/client/kqh/models/GpuConfiguration.d.ts +1 -1
  56. package/dist/client/kqh/models/GpuConfiguration.js +8 -15
  57. package/dist/client/kqh/models/JobDto.d.ts +2 -2
  58. package/dist/client/kqh/models/JobDto.js +13 -20
  59. package/dist/client/kqh/models/JobOverviewDto.d.ts +1 -1
  60. package/dist/client/kqh/models/JobOverviewDto.js +8 -15
  61. package/dist/client/kqh/models/MemoryConfiguration.d.ts +1 -1
  62. package/dist/client/kqh/models/MemoryConfiguration.js +7 -13
  63. package/dist/client/kqh/models/MeteringRequest.js +4 -10
  64. package/dist/client/kqh/models/MeteringResponse.js +4 -10
  65. package/dist/client/kqh/models/MonthAmountDto.d.ts +2 -2
  66. package/dist/client/kqh/models/MonthAmountDto.js +10 -16
  67. package/dist/client/kqh/models/OwnerDto.js +4 -10
  68. package/dist/client/kqh/models/PageDataPoolDto.d.ts +3 -3
  69. package/dist/client/kqh/models/PageDataPoolDto.js +13 -19
  70. package/dist/client/kqh/models/PageableObject.d.ts +1 -1
  71. package/dist/client/kqh/models/PageableObject.js +7 -13
  72. package/dist/client/kqh/models/PricingPlanDto.d.ts +1 -1
  73. package/dist/client/kqh/models/PricingPlanDto.js +8 -15
  74. package/dist/client/kqh/models/ProductAmountDto.d.ts +1 -1
  75. package/dist/client/kqh/models/ProductAmountDto.js +7 -13
  76. package/dist/client/kqh/models/ProductDto.js +5 -12
  77. package/dist/client/kqh/models/ProductGroupDto.d.ts +2 -2
  78. package/dist/client/kqh/models/ProductGroupDto.js +10 -16
  79. package/dist/client/kqh/models/ProductUsageDto.js +4 -10
  80. package/dist/client/kqh/models/RegistrySource.d.ts +1 -1
  81. package/dist/client/kqh/models/RegistrySource.js +7 -13
  82. package/dist/client/kqh/models/RepositorySource.d.ts +1 -1
  83. package/dist/client/kqh/models/RepositorySource.js +7 -13
  84. package/dist/client/kqh/models/ResourceConfiguration.js +10 -16
  85. package/dist/client/kqh/models/ReviewDto.js +5 -12
  86. package/dist/client/kqh/models/RuntimeConfiguration.js +5 -12
  87. package/dist/client/kqh/models/ServiceDefinitionCommand.js +5 -12
  88. package/dist/client/kqh/models/ServiceDefinitionDto.d.ts +5 -5
  89. package/dist/client/kqh/models/ServiceDefinitionDto.js +21 -28
  90. package/dist/client/kqh/models/ServiceDefinitionDtoSource.d.ts +3 -3
  91. package/dist/client/kqh/models/ServiceDefinitionDtoSource.js +18 -23
  92. package/dist/client/kqh/models/ServiceDefinitionOverviewDto.js +6 -13
  93. package/dist/client/kqh/models/ServiceDto.d.ts +1 -1
  94. package/dist/client/kqh/models/ServiceDto.js +8 -15
  95. package/dist/client/kqh/models/ServiceExecutionConsumerDto.js +5 -12
  96. package/dist/client/kqh/models/ServiceExecutionDto.js +4 -10
  97. package/dist/client/kqh/models/ServiceOverviewDto.js +8 -15
  98. package/dist/client/kqh/models/ServiceSource.js +10 -16
  99. package/dist/client/kqh/models/SortObject.js +4 -10
  100. package/dist/client/kqh/models/SubscriptionDto.d.ts +3 -3
  101. package/dist/client/kqh/models/SubscriptionDto.js +13 -19
  102. package/dist/client/kqh/models/TaxonomyElement.js +4 -10
  103. package/dist/client/kqh/models/UpdateDataPoolRequest.js +4 -10
  104. package/dist/client/kqh/models/UpdateResourceConfigurationRequest.d.ts +3 -3
  105. package/dist/client/kqh/models/UpdateResourceConfigurationRequest.js +18 -23
  106. package/dist/client/kqh/models/UpdateVersionRequest.d.ts +1 -1
  107. package/dist/client/kqh/models/UpdateVersionRequest.js +7 -13
  108. package/dist/client/kqh/models/UpdateWorkflowServiceRequest.js +4 -10
  109. package/dist/client/kqh/models/ValidationResult.js +5 -12
  110. package/dist/client/kqh/models/index.d.ts +57 -57
  111. package/dist/client/kqh/models/index.js +57 -73
  112. package/dist/client/kqh/runtime.js +17 -32
  113. package/dist/client/users/apis/AuthenticationApi.d.ts +2 -2
  114. package/dist/client/users/apis/AuthenticationApi.js +4 -41
  115. package/dist/client/users/apis/ExpertsApi.d.ts +2 -2
  116. package/dist/client/users/apis/ExpertsApi.js +5 -42
  117. package/dist/client/users/apis/SearchApi.d.ts +2 -2
  118. package/dist/client/users/apis/SearchApi.js +5 -42
  119. package/dist/client/users/apis/UserSettingsApi.d.ts +2 -2
  120. package/dist/client/users/apis/UserSettingsApi.js +11 -48
  121. package/dist/client/users/apis/UserSettingsPersonalAccessTokensApi.d.ts +2 -2
  122. package/dist/client/users/apis/UserSettingsPersonalAccessTokensApi.js +7 -44
  123. package/dist/client/users/apis/UsersApi.d.ts +2 -2
  124. package/dist/client/users/apis/UsersApi.js +4 -41
  125. package/dist/client/users/apis/index.d.ts +6 -6
  126. package/dist/client/users/apis/index.js +6 -22
  127. package/dist/client/users/index.d.ts +3 -3
  128. package/dist/client/users/index.js +3 -19
  129. package/dist/client/users/models/AccessTokenCreateRequest.js +5 -12
  130. package/dist/client/users/models/AccessTokenDto.js +5 -12
  131. package/dist/client/users/models/AccessTokensResponse.d.ts +1 -1
  132. package/dist/client/users/models/AccessTokensResponse.js +7 -13
  133. package/dist/client/users/models/DefaultAccessTokenResponse.js +4 -10
  134. package/dist/client/users/models/Language.js +4 -10
  135. package/dist/client/users/models/PageUserDto.d.ts +3 -3
  136. package/dist/client/users/models/PageUserDto.js +13 -19
  137. package/dist/client/users/models/Pageable.js +4 -10
  138. package/dist/client/users/models/PageableObject.d.ts +1 -1
  139. package/dist/client/users/models/PageableObject.js +7 -13
  140. package/dist/client/users/models/PersonalAccessTokenPrincipal.d.ts +1 -1
  141. package/dist/client/users/models/PersonalAccessTokenPrincipal.js +7 -13
  142. package/dist/client/users/models/Skill.js +4 -10
  143. package/dist/client/users/models/SortObject.js +4 -10
  144. package/dist/client/users/models/UpdateUserRequest.js +4 -10
  145. package/dist/client/users/models/UserDto.d.ts +2 -2
  146. package/dist/client/users/models/UserDto.js +10 -16
  147. package/dist/client/users/models/UserOverviewDto.js +4 -10
  148. package/dist/client/users/models/index.d.ts +14 -14
  149. package/dist/client/users/models/index.js +14 -30
  150. package/dist/client/users/runtime.js +17 -32
  151. package/dist/commands/compress/index.d.ts +1 -1
  152. package/dist/commands/compress/index.js +13 -19
  153. package/dist/commands/datapool/upload.d.ts +4 -4
  154. package/dist/commands/datapool/upload.js +24 -30
  155. package/dist/commands/get-context/index.d.ts +1 -1
  156. package/dist/commands/get-context/index.js +2 -5
  157. package/dist/commands/init/index.d.ts +3 -3
  158. package/dist/commands/init/index.js +30 -36
  159. package/dist/commands/list-contexts/index.d.ts +2 -2
  160. package/dist/commands/list-contexts/index.js +11 -17
  161. package/dist/commands/login/index.d.ts +3 -3
  162. package/dist/commands/login/index.js +16 -22
  163. package/dist/commands/logout/index.d.ts +1 -1
  164. package/dist/commands/logout/index.js +7 -10
  165. package/dist/commands/openapi/index.d.ts +7 -7
  166. package/dist/commands/openapi/index.js +81 -87
  167. package/dist/commands/run/index.d.ts +6 -6
  168. package/dist/commands/run/index.js +43 -48
  169. package/dist/commands/serve/index.d.ts +3 -3
  170. package/dist/commands/serve/index.js +31 -37
  171. package/dist/commands/services/index.d.ts +5 -5
  172. package/dist/commands/services/index.js +17 -23
  173. package/dist/commands/set-context/index.d.ts +4 -4
  174. package/dist/commands/set-context/index.js +13 -19
  175. package/dist/commands/up/index.d.ts +5 -5
  176. package/dist/commands/up/index.js +51 -57
  177. package/dist/index.js +1 -4
  178. package/dist/lib/command.js +5 -10
  179. package/dist/lib/debug.js +1 -5
  180. package/dist/lib/entrypoint-resolver.js +3 -7
  181. package/dist/lib/error.js +8 -12
  182. package/dist/lib/fetch.js +4 -10
  183. package/dist/lib/init-user-input.d.ts +1 -1
  184. package/dist/lib/init-user-input.js +16 -20
  185. package/dist/lib/random-name.js +1 -5
  186. package/dist/lib/random-string.js +1 -5
  187. package/dist/lib/repository.js +9 -17
  188. package/dist/lib/stream-to-blob.d.ts +1 -1
  189. package/dist/lib/stream-to-blob.js +1 -5
  190. package/dist/lib/up/get-description.js +9 -15
  191. package/dist/lib/up/ignore.js +9 -15
  192. package/dist/lib/up/zip.js +18 -24
  193. package/dist/model/account.js +1 -2
  194. package/dist/model/command.d.ts +2 -2
  195. package/dist/model/command.js +11 -19
  196. package/dist/model/managed-service-config.js +4 -7
  197. package/dist/model/user-config.js +3 -6
  198. package/dist/service/auth-service.d.ts +3 -3
  199. package/dist/service/auth-service.js +8 -14
  200. package/dist/service/command-service.d.ts +2 -2
  201. package/dist/service/command-service.js +1 -5
  202. package/dist/service/quantum-hub-service.d.ts +10 -10
  203. package/dist/service/quantum-hub-service.js +21 -24
  204. package/dist/service/service-config-service.d.ts +1 -1
  205. package/dist/service/service-config-service.js +14 -21
  206. package/dist/service/user-config-service.d.ts +1 -1
  207. package/dist/service/user-config-service.js +14 -21
  208. package/dist/service/user-service.d.ts +2 -2
  209. package/dist/service/user-service.js +8 -11
  210. package/oclif.manifest.json +170 -170
  211. package/package.json +4 -2
@@ -15,7 +15,7 @@
15
15
  "pluginName": "@quantum-hub/qhubctl",
16
16
  "pluginType": "core",
17
17
  "strict": true,
18
- "isESM": false,
18
+ "isESM": true,
19
19
  "relativePath": [
20
20
  "dist",
21
21
  "commands",
@@ -23,43 +23,48 @@
23
23
  "index.js"
24
24
  ]
25
25
  },
26
- "init": {
26
+ "datapool:upload": {
27
27
  "aliases": [],
28
28
  "args": {},
29
- "description": "Bootstrap project to create a service.",
29
+ "description": "Upload files to a data pool",
30
30
  "examples": [
31
- "$ qhubctl init"
31
+ "$ qhubctl datapool upload --file ./data/dataset.csv",
32
+ "$ qhubctl datapool upload --file ./data/dataset.csv --file ./data/metadata.json",
33
+ "$ qhubctl datapool upload -f ./data/dataset.csv -f ./data/metadata.json --datapool-id 550e8400-e29b-41d4-a716-446655440000"
32
34
  ],
33
35
  "flags": {
34
- "name": {
35
- "description": "The name of the service",
36
- "name": "name",
37
- "required": false,
36
+ "file": {
37
+ "char": "f",
38
+ "description": "Path to a file to upload (can be specified multiple times)",
39
+ "name": "file",
40
+ "required": true,
38
41
  "hasDynamicHelp": false,
39
- "multiple": false,
42
+ "multiple": true,
40
43
  "type": "option"
41
44
  },
42
- "non-interactive": {
43
- "description": "Run it in non-interactive mode",
44
- "name": "non-interactive",
45
+ "datapool-id": {
46
+ "char": "d",
47
+ "description": "ID of the data pool to upload the files to (optional - will prompt to create a new one if not provided)",
48
+ "name": "datapool-id",
45
49
  "required": false,
46
- "allowNo": false,
47
- "type": "boolean"
50
+ "hasDynamicHelp": false,
51
+ "multiple": false,
52
+ "type": "option"
48
53
  }
49
54
  },
50
55
  "hasDynamicHelp": false,
51
56
  "hiddenAliases": [],
52
- "id": "init",
57
+ "id": "datapool:upload",
53
58
  "pluginAlias": "@quantum-hub/qhubctl",
54
59
  "pluginName": "@quantum-hub/qhubctl",
55
60
  "pluginType": "core",
56
61
  "strict": true,
57
- "isESM": false,
62
+ "isESM": true,
58
63
  "relativePath": [
59
64
  "dist",
60
65
  "commands",
61
- "init",
62
- "index.js"
66
+ "datapool",
67
+ "upload.js"
63
68
  ]
64
69
  },
65
70
  "get-context": {
@@ -77,7 +82,7 @@
77
82
  "pluginName": "@quantum-hub/qhubctl",
78
83
  "pluginType": "core",
79
84
  "strict": true,
80
- "isESM": false,
85
+ "isESM": true,
81
86
  "relativePath": [
82
87
  "dist",
83
88
  "commands",
@@ -85,71 +90,66 @@
85
90
  "index.js"
86
91
  ]
87
92
  },
88
- "list-contexts": {
93
+ "init": {
89
94
  "aliases": [],
90
95
  "args": {},
91
- "description": "Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.",
96
+ "description": "Bootstrap project to create a service.",
92
97
  "examples": [
93
- "$ qhubctl list-contexts"
98
+ "$ qhubctl init"
94
99
  ],
95
- "flags": {},
100
+ "flags": {
101
+ "name": {
102
+ "description": "The name of the service",
103
+ "name": "name",
104
+ "required": false,
105
+ "hasDynamicHelp": false,
106
+ "multiple": false,
107
+ "type": "option"
108
+ },
109
+ "non-interactive": {
110
+ "description": "Run it in non-interactive mode",
111
+ "name": "non-interactive",
112
+ "required": false,
113
+ "allowNo": false,
114
+ "type": "boolean"
115
+ }
116
+ },
96
117
  "hasDynamicHelp": false,
97
118
  "hiddenAliases": [],
98
- "id": "list-contexts",
119
+ "id": "init",
99
120
  "pluginAlias": "@quantum-hub/qhubctl",
100
121
  "pluginName": "@quantum-hub/qhubctl",
101
122
  "pluginType": "core",
102
123
  "strict": true,
103
- "isESM": false,
124
+ "isESM": true,
104
125
  "relativePath": [
105
126
  "dist",
106
127
  "commands",
107
- "list-contexts",
128
+ "init",
108
129
  "index.js"
109
130
  ]
110
131
  },
111
- "datapool:upload": {
132
+ "list-contexts": {
112
133
  "aliases": [],
113
134
  "args": {},
114
- "description": "Upload files to a data pool",
135
+ "description": "Retrieves the available contexts, i.e., the personal or organizational accounts available to you to work with.",
115
136
  "examples": [
116
- "$ qhubctl datapool upload --file ./data/dataset.csv",
117
- "$ qhubctl datapool upload --file ./data/dataset.csv --file ./data/metadata.json",
118
- "$ qhubctl datapool upload -f ./data/dataset.csv -f ./data/metadata.json --datapool-id 550e8400-e29b-41d4-a716-446655440000"
137
+ "$ qhubctl list-contexts"
119
138
  ],
120
- "flags": {
121
- "file": {
122
- "char": "f",
123
- "description": "Path to a file to upload (can be specified multiple times)",
124
- "name": "file",
125
- "required": true,
126
- "hasDynamicHelp": false,
127
- "multiple": true,
128
- "type": "option"
129
- },
130
- "datapool-id": {
131
- "char": "d",
132
- "description": "ID of the data pool to upload the files to (optional - will prompt to create a new one if not provided)",
133
- "name": "datapool-id",
134
- "required": false,
135
- "hasDynamicHelp": false,
136
- "multiple": false,
137
- "type": "option"
138
- }
139
- },
139
+ "flags": {},
140
140
  "hasDynamicHelp": false,
141
141
  "hiddenAliases": [],
142
- "id": "datapool:upload",
142
+ "id": "list-contexts",
143
143
  "pluginAlias": "@quantum-hub/qhubctl",
144
144
  "pluginName": "@quantum-hub/qhubctl",
145
145
  "pluginType": "core",
146
146
  "strict": true,
147
- "isESM": false,
147
+ "isESM": true,
148
148
  "relativePath": [
149
149
  "dist",
150
150
  "commands",
151
- "datapool",
152
- "upload.js"
151
+ "list-contexts",
152
+ "index.js"
153
153
  ]
154
154
  },
155
155
  "login": {
@@ -186,7 +186,7 @@
186
186
  "pluginName": "@quantum-hub/qhubctl",
187
187
  "pluginType": "core",
188
188
  "strict": true,
189
- "isESM": false,
189
+ "isESM": true,
190
190
  "relativePath": [
191
191
  "dist",
192
192
  "commands",
@@ -209,7 +209,7 @@
209
209
  "pluginName": "@quantum-hub/qhubctl",
210
210
  "pluginType": "core",
211
211
  "strict": true,
212
- "isESM": false,
212
+ "isESM": true,
213
213
  "relativePath": [
214
214
  "dist",
215
215
  "commands",
@@ -217,82 +217,62 @@
217
217
  "index.js"
218
218
  ]
219
219
  },
220
- "openapi": {
220
+ "run": {
221
221
  "aliases": [],
222
- "args": {},
223
- "description": "Generates the OpenAPI description for your project based on the parameter and return types of your run() method. The output of this command will be used when creating or updating your service. Supports PYTHON_TEMPLATE (with src/program.py), PYTHON and DOCKER runtimes (with explicit entrypoint). The Python dependency \"qhub-commons\" must be installed in your activated Python environment to use this command.",
222
+ "args": {
223
+ "serviceId": {
224
+ "name": "serviceId"
225
+ }
226
+ },
227
+ "description": "Creates a job execution",
224
228
  "examples": [
225
- "$ qhubctl openapi",
226
- "$ qhubctl openapi --file=./openapi.yaml --format=yaml --force",
227
- "$ qhubctl openapi --entrypoint=src.program:run",
228
- "$ qhubctl openapi --package=src.program --method=run",
229
- "$ qhubctl openapi --package=src.program"
229
+ "$ qhubctl run",
230
+ "$ qhubctl run --detached",
231
+ "$ qhubctl run -i '{\"values\": [10,12], \"round_up\": true}'",
232
+ "$ qhubctl run --input-files=./input/data.json,./input/params.json",
233
+ "$ qhubctl run --input-files=./config.json,./overrides.json"
230
234
  ],
231
235
  "flags": {
232
- "force": {
233
- "char": "f",
234
- "description": "Overwrite the output file if it already exists",
235
- "name": "force",
236
- "required": false,
237
- "allowNo": false,
238
- "type": "boolean"
239
- },
240
- "file": {
241
- "description": "The file to write the OpenAPI description to",
242
- "name": "file",
236
+ "input": {
237
+ "char": "i",
238
+ "description": "Input as JSON string.",
239
+ "name": "input",
243
240
  "required": false,
244
241
  "hasDynamicHelp": false,
245
242
  "multiple": false,
246
243
  "type": "option"
247
244
  },
248
- "format": {
249
- "description": "The format to generate the OpenAPI description [possible values: yaml]",
250
- "name": "format",
251
- "required": false,
252
- "hasDynamicHelp": false,
253
- "multiple": false,
254
- "options": [
255
- "yaml"
245
+ "input-files": {
246
+ "aliases": [
247
+ "input-files"
256
248
  ],
257
- "type": "option"
258
- },
259
- "entrypoint": {
260
- "description": "The entrypoint to your program in the format \"package.module:function\" (default: \"src.program:run\"). Overrides package and method flags.",
261
- "name": "entrypoint",
262
- "required": false,
263
- "hasDynamicHelp": false,
264
- "multiple": false,
265
- "type": "option"
266
- },
267
- "package": {
268
- "description": "The package/module path to your program (e.g., \"src.program\" or \"my_package.main\"). Only used if entrypoint is not provided.",
269
- "name": "package",
249
+ "description": "Comma-separated paths to files containing input to be merged (default: ./input/data.json,./input/params.json).",
250
+ "name": "input-files",
270
251
  "required": false,
271
252
  "hasDynamicHelp": false,
272
253
  "multiple": false,
273
254
  "type": "option"
274
255
  },
275
- "method": {
276
- "description": "The method/function name in your program (default: \"run\"). Only used if entrypoint is not provided.",
277
- "name": "method",
256
+ "detached": {
257
+ "description": "Executes the job in detached mode, i.e., without waiting for it to finish.",
258
+ "name": "detached",
278
259
  "required": false,
279
- "hasDynamicHelp": false,
280
- "multiple": false,
281
- "type": "option"
260
+ "allowNo": false,
261
+ "type": "boolean"
282
262
  }
283
263
  },
284
264
  "hasDynamicHelp": false,
285
265
  "hiddenAliases": [],
286
- "id": "openapi",
266
+ "id": "run",
287
267
  "pluginAlias": "@quantum-hub/qhubctl",
288
268
  "pluginName": "@quantum-hub/qhubctl",
289
269
  "pluginType": "core",
290
270
  "strict": true,
291
- "isESM": false,
271
+ "isESM": true,
292
272
  "relativePath": [
293
273
  "dist",
294
274
  "commands",
295
- "openapi",
275
+ "run",
296
276
  "index.js"
297
277
  ]
298
278
  },
@@ -333,7 +313,7 @@
333
313
  "strict": true,
334
314
  "CONTAINER_NAME": "planqk-cli-serve",
335
315
  "IMAGE": "registry.gitlab.com/planqk-foss/planqk-cli-serve:latest",
336
- "isESM": false,
316
+ "isESM": true,
337
317
  "relativePath": [
338
318
  "dist",
339
319
  "commands",
@@ -341,65 +321,6 @@
341
321
  "index.js"
342
322
  ]
343
323
  },
344
- "run": {
345
- "aliases": [],
346
- "args": {
347
- "serviceId": {
348
- "name": "serviceId"
349
- }
350
- },
351
- "description": "Creates a job execution",
352
- "examples": [
353
- "$ qhubctl run",
354
- "$ qhubctl run --detached",
355
- "$ qhubctl run -i '{\"values\": [10,12], \"round_up\": true}'",
356
- "$ qhubctl run --input-files=./input/data.json,./input/params.json",
357
- "$ qhubctl run --input-files=./config.json,./overrides.json"
358
- ],
359
- "flags": {
360
- "input": {
361
- "char": "i",
362
- "description": "Input as JSON string.",
363
- "name": "input",
364
- "required": false,
365
- "hasDynamicHelp": false,
366
- "multiple": false,
367
- "type": "option"
368
- },
369
- "input-files": {
370
- "aliases": [
371
- "input-files"
372
- ],
373
- "description": "Comma-separated paths to files containing input to be merged (default: ./input/data.json,./input/params.json).",
374
- "name": "input-files",
375
- "required": false,
376
- "hasDynamicHelp": false,
377
- "multiple": false,
378
- "type": "option"
379
- },
380
- "detached": {
381
- "description": "Executes the job in detached mode, i.e., without waiting for it to finish.",
382
- "name": "detached",
383
- "required": false,
384
- "allowNo": false,
385
- "type": "boolean"
386
- }
387
- },
388
- "hasDynamicHelp": false,
389
- "hiddenAliases": [],
390
- "id": "run",
391
- "pluginAlias": "@quantum-hub/qhubctl",
392
- "pluginName": "@quantum-hub/qhubctl",
393
- "pluginType": "core",
394
- "strict": true,
395
- "isESM": false,
396
- "relativePath": [
397
- "dist",
398
- "commands",
399
- "run",
400
- "index.js"
401
- ]
402
- },
403
324
  "services": {
404
325
  "aliases": [],
405
326
  "args": {},
@@ -440,7 +361,7 @@
440
361
  "pluginName": "@quantum-hub/qhubctl",
441
362
  "pluginType": "core",
442
363
  "strict": true,
443
- "isESM": false,
364
+ "isESM": true,
444
365
  "relativePath": [
445
366
  "dist",
446
367
  "commands",
@@ -468,7 +389,7 @@
468
389
  "pluginName": "@quantum-hub/qhubctl",
469
390
  "pluginType": "core",
470
391
  "strict": true,
471
- "isESM": false,
392
+ "isESM": true,
472
393
  "relativePath": [
473
394
  "dist",
474
395
  "commands",
@@ -476,6 +397,85 @@
476
397
  "index.js"
477
398
  ]
478
399
  },
400
+ "openapi": {
401
+ "aliases": [],
402
+ "args": {},
403
+ "description": "Generates the OpenAPI description for your project based on the parameter and return types of your run() method. The output of this command will be used when creating or updating your service. Supports PYTHON_TEMPLATE (with src/program.py), PYTHON and DOCKER runtimes (with explicit entrypoint). The Python dependency \"qhub-commons\" must be installed in your activated Python environment to use this command.",
404
+ "examples": [
405
+ "$ qhubctl openapi",
406
+ "$ qhubctl openapi --file=./openapi.yaml --format=yaml --force",
407
+ "$ qhubctl openapi --entrypoint=src.program:run",
408
+ "$ qhubctl openapi --package=src.program --method=run",
409
+ "$ qhubctl openapi --package=src.program"
410
+ ],
411
+ "flags": {
412
+ "force": {
413
+ "char": "f",
414
+ "description": "Overwrite the output file if it already exists",
415
+ "name": "force",
416
+ "required": false,
417
+ "allowNo": false,
418
+ "type": "boolean"
419
+ },
420
+ "file": {
421
+ "description": "The file to write the OpenAPI description to",
422
+ "name": "file",
423
+ "required": false,
424
+ "hasDynamicHelp": false,
425
+ "multiple": false,
426
+ "type": "option"
427
+ },
428
+ "format": {
429
+ "description": "The format to generate the OpenAPI description [possible values: yaml]",
430
+ "name": "format",
431
+ "required": false,
432
+ "hasDynamicHelp": false,
433
+ "multiple": false,
434
+ "options": [
435
+ "yaml"
436
+ ],
437
+ "type": "option"
438
+ },
439
+ "entrypoint": {
440
+ "description": "The entrypoint to your program in the format \"package.module:function\" (default: \"src.program:run\"). Overrides package and method flags.",
441
+ "name": "entrypoint",
442
+ "required": false,
443
+ "hasDynamicHelp": false,
444
+ "multiple": false,
445
+ "type": "option"
446
+ },
447
+ "package": {
448
+ "description": "The package/module path to your program (e.g., \"src.program\" or \"my_package.main\"). Only used if entrypoint is not provided.",
449
+ "name": "package",
450
+ "required": false,
451
+ "hasDynamicHelp": false,
452
+ "multiple": false,
453
+ "type": "option"
454
+ },
455
+ "method": {
456
+ "description": "The method/function name in your program (default: \"run\"). Only used if entrypoint is not provided.",
457
+ "name": "method",
458
+ "required": false,
459
+ "hasDynamicHelp": false,
460
+ "multiple": false,
461
+ "type": "option"
462
+ }
463
+ },
464
+ "hasDynamicHelp": false,
465
+ "hiddenAliases": [],
466
+ "id": "openapi",
467
+ "pluginAlias": "@quantum-hub/qhubctl",
468
+ "pluginName": "@quantum-hub/qhubctl",
469
+ "pluginType": "core",
470
+ "strict": true,
471
+ "isESM": true,
472
+ "relativePath": [
473
+ "dist",
474
+ "commands",
475
+ "openapi",
476
+ "index.js"
477
+ ]
478
+ },
479
479
  "up": {
480
480
  "aliases": [],
481
481
  "args": {},
@@ -517,7 +517,7 @@
517
517
  "pluginName": "@quantum-hub/qhubctl",
518
518
  "pluginType": "core",
519
519
  "strict": true,
520
- "isESM": false,
520
+ "isESM": true,
521
521
  "relativePath": [
522
522
  "dist",
523
523
  "commands",
@@ -526,5 +526,5 @@
526
526
  ]
527
527
  }
528
528
  },
529
- "version": "1.1.1"
529
+ "version": "1.1.3"
530
530
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quantum-hub/qhubctl",
3
- "version": "1.1.1",
3
+ "version": "1.1.3",
4
4
  "description": "Quantum Hub CLI",
5
5
  "author": "Kipu Quantum GmbH",
6
6
  "contributors": [
@@ -10,6 +10,7 @@
10
10
  "Harzenetter, Lukas <lukas.harzenetter@kipu-quantum.com>"
11
11
  ],
12
12
  "license": "Apache-2.0",
13
+ "type": "module",
13
14
  "keywords": [
14
15
  "hub",
15
16
  "kipu",
@@ -32,7 +33,7 @@
32
33
  "@oclif/plugin-not-found": "^3.2.74",
33
34
  "@oclif/plugin-version": "^2.2.36",
34
35
  "@oclif/plugin-warn-if-update-available": "^3.1.55",
35
- "@quantum-hub/qhub-api": "^1",
36
+ "@quantum-hub/qhub-api": "^1.0.24",
36
37
  "adm-zip": "^0.5.16",
37
38
  "async-wait-until": "^2.0.31",
38
39
  "fs-extra": "^11.3.3",
@@ -61,6 +62,7 @@
61
62
  "oclif": "^4.22.81",
62
63
  "shx": "^0.4.0",
63
64
  "ts-node": "^10.9.2",
65
+ "tsx": "^4.21.0",
64
66
  "typescript": "^5.9.3",
65
67
  "typescript-eslint": "^8.56.1"
66
68
  },