harbor2_legacy_client 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (375) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +365 -0
  4. data/Rakefile +8 -0
  5. data/docs/Action.md +8 -0
  6. data/docs/Action1.md +8 -0
  7. data/docs/AdminJobSchedule.md +9 -0
  8. data/docs/AdminJobScheduleObj.md +9 -0
  9. data/docs/BadRequestFormatedError.md +8 -0
  10. data/docs/BoolConfigItem.md +9 -0
  11. data/docs/CVEAllowlist.md +11 -0
  12. data/docs/CVEAllowlistItem.md +8 -0
  13. data/docs/ChartAPIError.md +8 -0
  14. data/docs/ChartMetadata.md +18 -0
  15. data/docs/ChartRepositoryApi.md +191 -0
  16. data/docs/ChartVersion.md +23 -0
  17. data/docs/ComponentHealthStatus.md +10 -0
  18. data/docs/ComponentOverviewEntry.md +9 -0
  19. data/docs/Configurations.md +42 -0
  20. data/docs/ConfigurationsResponse.md +41 -0
  21. data/docs/ConfigurationsScanAllPolicy.md +9 -0
  22. data/docs/ConfigurationsScanAllPolicyParameter.md +8 -0
  23. data/docs/ConflictFormatedError.md +8 -0
  24. data/docs/EmailServerSetting.md +13 -0
  25. data/docs/Endpoint.md +9 -0
  26. data/docs/EventType.md +7 -0
  27. data/docs/FilterStyle.md +10 -0
  28. data/docs/ForbiddenChartAPIError.md +8 -0
  29. data/docs/GCResult.md +16 -0
  30. data/docs/GeneralInfo.md +16 -0
  31. data/docs/InputSecret.md +8 -0
  32. data/docs/InsufficientStorageChartAPIError.md +8 -0
  33. data/docs/IntegerConfigItem.md +9 -0
  34. data/docs/InternalChartAPIError.md +8 -0
  35. data/docs/IsDefault.md +8 -0
  36. data/docs/Label.md +16 -0
  37. data/docs/LabelApi.md +191 -0
  38. data/docs/Labels.md +7 -0
  39. data/docs/LdapConf.md +15 -0
  40. data/docs/LdapFailedImportUsers.md +9 -0
  41. data/docs/LdapImportUsers.md +8 -0
  42. data/docs/LdapUsers.md +10 -0
  43. data/docs/Namespace.md +9 -0
  44. data/docs/NotFoundChartAPIError.md +8 -0
  45. data/docs/NotifyType.md +7 -0
  46. data/docs/OverallHealthStatus.md +9 -0
  47. data/docs/Password.md +9 -0
  48. data/docs/Permission.md +9 -0
  49. data/docs/PingRegistry.md +14 -0
  50. data/docs/ProductsApi.md +6382 -0
  51. data/docs/Project.md +22 -0
  52. data/docs/ProjectMember.md +10 -0
  53. data/docs/ProjectMemberEntity.md +14 -0
  54. data/docs/ProjectMetadata.md +13 -0
  55. data/docs/ProjectReq.md +13 -0
  56. data/docs/ProjectScanner.md +8 -0
  57. data/docs/ProjectSummary.md +15 -0
  58. data/docs/ProjectSummaryQuota.md +9 -0
  59. data/docs/PutRegistry.md +14 -0
  60. data/docs/Quota.md +13 -0
  61. data/docs/QuotaApi.md +118 -0
  62. data/docs/QuotaRefObject.md +7 -0
  63. data/docs/QuotaSwitcher.md +8 -0
  64. data/docs/QuotaUpdateReq.md +8 -0
  65. data/docs/Registry.md +17 -0
  66. data/docs/RegistryCredential.md +10 -0
  67. data/docs/RegistryInfo.md +11 -0
  68. data/docs/ReplicationExecution.md +19 -0
  69. data/docs/ReplicationFilter.md +9 -0
  70. data/docs/ReplicationPolicy.md +20 -0
  71. data/docs/ReplicationTask.md +16 -0
  72. data/docs/ReplicationTrigger.md +9 -0
  73. data/docs/ResourceList.md +7 -0
  74. data/docs/RetentionApi.md +449 -0
  75. data/docs/RetentionExecution.md +14 -0
  76. data/docs/RetentionExecutionTask.md +18 -0
  77. data/docs/RetentionMetadata.md +10 -0
  78. data/docs/RetentionPolicy.md +12 -0
  79. data/docs/RetentionPolicyScope.md +9 -0
  80. data/docs/RetentionRule.md +15 -0
  81. data/docs/RetentionRuleMetadata.md +11 -0
  82. data/docs/RetentionRuleParamMetadata.md +10 -0
  83. data/docs/RetentionRuleTrigger.md +10 -0
  84. data/docs/RetentionSelector.md +11 -0
  85. data/docs/RetentionSelectorMetadata.md +10 -0
  86. data/docs/RobotAccount.md +15 -0
  87. data/docs/RobotAccountAccess.md +9 -0
  88. data/docs/RobotAccountApi.md +291 -0
  89. data/docs/RobotAccountCreate.md +11 -0
  90. data/docs/RobotAccountPostRep.md +9 -0
  91. data/docs/RobotAccountUpdate.md +8 -0
  92. data/docs/Role.md +11 -0
  93. data/docs/RoleParam.md +9 -0
  94. data/docs/RoleRequest.md +8 -0
  95. data/docs/ScanApi.md +104 -0
  96. data/docs/Scanner.md +10 -0
  97. data/docs/ScannerAdapterMetadata.md +10 -0
  98. data/docs/ScannerCapability.md +9 -0
  99. data/docs/ScannerRegistration.md +21 -0
  100. data/docs/ScannerRegistrationReq.md +15 -0
  101. data/docs/ScannerRegistrationSettings.md +11 -0
  102. data/docs/ScannersApi.md +600 -0
  103. data/docs/Search.md +10 -0
  104. data/docs/SearchRepository.md +13 -0
  105. data/docs/SearchResult.md +10 -0
  106. data/docs/StatisticMap.md +13 -0
  107. data/docs/Stats.md +12 -0
  108. data/docs/Storage.md +9 -0
  109. data/docs/StringConfigItem.md +9 -0
  110. data/docs/SupportedWebhookEventTypes.md +9 -0
  111. data/docs/SysAdminFlag.md +8 -0
  112. data/docs/SystemApi.md +163 -0
  113. data/docs/SystemInfo.md +8 -0
  114. data/docs/TriggerSettings.md +8 -0
  115. data/docs/UnauthorizedChartAPIError.md +8 -0
  116. data/docs/User.md +22 -0
  117. data/docs/UserEntity.md +9 -0
  118. data/docs/UserGroup.md +11 -0
  119. data/docs/UserProfile.md +10 -0
  120. data/docs/UserSearch.md +9 -0
  121. data/docs/WebhookJob.md +15 -0
  122. data/docs/WebhookLastTrigger.md +11 -0
  123. data/docs/WebhookPolicy.md +17 -0
  124. data/docs/WebhookTargetObject.md +11 -0
  125. data/git_push.sh +55 -0
  126. data/harbor2_legacy_client.gemspec +46 -0
  127. data/lib/harbor2_legacy_client.rb +159 -0
  128. data/lib/harbor2_legacy_client/api/chart_repository_api.rb +230 -0
  129. data/lib/harbor2_legacy_client/api/label_api.rb +230 -0
  130. data/lib/harbor2_legacy_client/api/products_api.rb +6500 -0
  131. data/lib/harbor2_legacy_client/api/quota_api.rb +136 -0
  132. data/lib/harbor2_legacy_client/api/retention_api.rb +482 -0
  133. data/lib/harbor2_legacy_client/api/robot_account_api.rb +321 -0
  134. data/lib/harbor2_legacy_client/api/scan_api.rb +119 -0
  135. data/lib/harbor2_legacy_client/api/scanners_api.rb +624 -0
  136. data/lib/harbor2_legacy_client/api/system_api.rb +173 -0
  137. data/lib/harbor2_legacy_client/api_client.rb +391 -0
  138. data/lib/harbor2_legacy_client/api_error.rb +38 -0
  139. data/lib/harbor2_legacy_client/configuration.rb +209 -0
  140. data/lib/harbor2_legacy_client/models/action.rb +184 -0
  141. data/lib/harbor2_legacy_client/models/action_1.rb +184 -0
  142. data/lib/harbor2_legacy_client/models/admin_job_schedule.rb +196 -0
  143. data/lib/harbor2_legacy_client/models/admin_job_schedule_obj.rb +195 -0
  144. data/lib/harbor2_legacy_client/models/bad_request_formated_error.rb +191 -0
  145. data/lib/harbor2_legacy_client/models/bool_config_item.rb +195 -0
  146. data/lib/harbor2_legacy_client/models/chart_api_error.rb +191 -0
  147. data/lib/harbor2_legacy_client/models/chart_metadata.rb +320 -0
  148. data/lib/harbor2_legacy_client/models/chart_version.rb +371 -0
  149. data/lib/harbor2_legacy_client/models/component_health_status.rb +206 -0
  150. data/lib/harbor2_legacy_client/models/component_overview_entry.rb +195 -0
  151. data/lib/harbor2_legacy_client/models/configurations.rb +524 -0
  152. data/lib/harbor2_legacy_client/models/configurations_response.rb +514 -0
  153. data/lib/harbor2_legacy_client/models/configurations_scan_all_policy.rb +194 -0
  154. data/lib/harbor2_legacy_client/models/configurations_scan_all_policy_parameter.rb +186 -0
  155. data/lib/harbor2_legacy_client/models/conflict_formated_error.rb +191 -0
  156. data/lib/harbor2_legacy_client/models/cve_allowlist.rb +217 -0
  157. data/lib/harbor2_legacy_client/models/cve_allowlist_item.rb +186 -0
  158. data/lib/harbor2_legacy_client/models/email_server_setting.rb +235 -0
  159. data/lib/harbor2_legacy_client/models/endpoint.rb +195 -0
  160. data/lib/harbor2_legacy_client/models/event_type.rb +176 -0
  161. data/lib/harbor2_legacy_client/models/filter_style.rb +208 -0
  162. data/lib/harbor2_legacy_client/models/forbidden_chart_api_error.rb +191 -0
  163. data/lib/harbor2_legacy_client/models/gc_result.rb +264 -0
  164. data/lib/harbor2_legacy_client/models/general_info.rb +265 -0
  165. data/lib/harbor2_legacy_client/models/input_secret.rb +185 -0
  166. data/lib/harbor2_legacy_client/models/insufficient_storage_chart_api_error.rb +191 -0
  167. data/lib/harbor2_legacy_client/models/integer_config_item.rb +195 -0
  168. data/lib/harbor2_legacy_client/models/internal_chart_api_error.rb +191 -0
  169. data/lib/harbor2_legacy_client/models/is_default.rb +185 -0
  170. data/lib/harbor2_legacy_client/models/label.rb +265 -0
  171. data/lib/harbor2_legacy_client/models/labels.rb +176 -0
  172. data/lib/harbor2_legacy_client/models/ldap_conf.rb +255 -0
  173. data/lib/harbor2_legacy_client/models/ldap_failed_import_users.rb +195 -0
  174. data/lib/harbor2_legacy_client/models/ldap_import_users.rb +187 -0
  175. data/lib/harbor2_legacy_client/models/ldap_users.rb +205 -0
  176. data/lib/harbor2_legacy_client/models/namespace.rb +196 -0
  177. data/lib/harbor2_legacy_client/models/not_found_chart_api_error.rb +191 -0
  178. data/lib/harbor2_legacy_client/models/notify_type.rb +176 -0
  179. data/lib/harbor2_legacy_client/models/overall_health_status.rb +197 -0
  180. data/lib/harbor2_legacy_client/models/password.rb +195 -0
  181. data/lib/harbor2_legacy_client/models/permission.rb +196 -0
  182. data/lib/harbor2_legacy_client/models/ping_registry.rb +245 -0
  183. data/lib/harbor2_legacy_client/models/project.rb +327 -0
  184. data/lib/harbor2_legacy_client/models/project_member.rb +203 -0
  185. data/lib/harbor2_legacy_client/models/project_member_entity.rb +245 -0
  186. data/lib/harbor2_legacy_client/models/project_metadata.rb +235 -0
  187. data/lib/harbor2_legacy_client/models/project_req.rb +235 -0
  188. data/lib/harbor2_legacy_client/models/project_scanner.rb +185 -0
  189. data/lib/harbor2_legacy_client/models/project_summary.rb +253 -0
  190. data/lib/harbor2_legacy_client/models/project_summary_quota.rb +195 -0
  191. data/lib/harbor2_legacy_client/models/put_registry.rb +245 -0
  192. data/lib/harbor2_legacy_client/models/quota.rb +236 -0
  193. data/lib/harbor2_legacy_client/models/quota_ref_object.rb +175 -0
  194. data/lib/harbor2_legacy_client/models/quota_switcher.rb +185 -0
  195. data/lib/harbor2_legacy_client/models/quota_update_req.rb +185 -0
  196. data/lib/harbor2_legacy_client/models/registry.rb +274 -0
  197. data/lib/harbor2_legacy_client/models/registry_credential.rb +205 -0
  198. data/lib/harbor2_legacy_client/models/registry_info.rb +220 -0
  199. data/lib/harbor2_legacy_client/models/replication_execution.rb +296 -0
  200. data/lib/harbor2_legacy_client/models/replication_filter.rb +195 -0
  201. data/lib/harbor2_legacy_client/models/replication_policy.rb +306 -0
  202. data/lib/harbor2_legacy_client/models/replication_task.rb +266 -0
  203. data/lib/harbor2_legacy_client/models/replication_trigger.rb +194 -0
  204. data/lib/harbor2_legacy_client/models/resource_list.rb +175 -0
  205. data/lib/harbor2_legacy_client/models/retention_execution.rb +238 -0
  206. data/lib/harbor2_legacy_client/models/retention_execution_task.rb +274 -0
  207. data/lib/harbor2_legacy_client/models/retention_metadata.rb +212 -0
  208. data/lib/harbor2_legacy_client/models/retention_policy.rb +223 -0
  209. data/lib/harbor2_legacy_client/models/retention_policy_scope.rb +193 -0
  210. data/lib/harbor2_legacy_client/models/retention_rule.rb +253 -0
  211. data/lib/harbor2_legacy_client/models/retention_rule_metadata.rb +218 -0
  212. data/lib/harbor2_legacy_client/models/retention_rule_param_metadata.rb +203 -0
  213. data/lib/harbor2_legacy_client/models/retention_rule_trigger.rb +202 -0
  214. data/lib/harbor2_legacy_client/models/retention_selector.rb +211 -0
  215. data/lib/harbor2_legacy_client/models/retention_selector_metadata.rb +205 -0
  216. data/lib/harbor2_legacy_client/models/robot_account.rb +256 -0
  217. data/lib/harbor2_legacy_client/models/robot_account_access.rb +195 -0
  218. data/lib/harbor2_legacy_client/models/robot_account_create.rb +217 -0
  219. data/lib/harbor2_legacy_client/models/robot_account_post_rep.rb +195 -0
  220. data/lib/harbor2_legacy_client/models/robot_account_update.rb +185 -0
  221. data/lib/harbor2_legacy_client/models/role.rb +214 -0
  222. data/lib/harbor2_legacy_client/models/role_param.rb +197 -0
  223. data/lib/harbor2_legacy_client/models/role_request.rb +185 -0
  224. data/lib/harbor2_legacy_client/models/scanner.rb +205 -0
  225. data/lib/harbor2_legacy_client/models/scanner_adapter_metadata.rb +207 -0
  226. data/lib/harbor2_legacy_client/models/scanner_capability.rb +197 -0
  227. data/lib/harbor2_legacy_client/models/scanner_registration.rb +328 -0
  228. data/lib/harbor2_legacy_client/models/scanner_registration_req.rb +263 -0
  229. data/lib/harbor2_legacy_client/models/scanner_registration_settings.rb +217 -0
  230. data/lib/harbor2_legacy_client/models/search.rb +211 -0
  231. data/lib/harbor2_legacy_client/models/search_repository.rb +235 -0
  232. data/lib/harbor2_legacy_client/models/search_result.rb +205 -0
  233. data/lib/harbor2_legacy_client/models/statistic_map.rb +235 -0
  234. data/lib/harbor2_legacy_client/models/stats.rb +228 -0
  235. data/lib/harbor2_legacy_client/models/storage.rb +195 -0
  236. data/lib/harbor2_legacy_client/models/string_config_item.rb +195 -0
  237. data/lib/harbor2_legacy_client/models/supported_webhook_event_types.rb +198 -0
  238. data/lib/harbor2_legacy_client/models/sys_admin_flag.rb +185 -0
  239. data/lib/harbor2_legacy_client/models/system_info.rb +187 -0
  240. data/lib/harbor2_legacy_client/models/trigger_settings.rb +185 -0
  241. data/lib/harbor2_legacy_client/models/unauthorized_chart_api_error.rb +191 -0
  242. data/lib/harbor2_legacy_client/models/user.rb +312 -0
  243. data/lib/harbor2_legacy_client/models/user_entity.rb +195 -0
  244. data/lib/harbor2_legacy_client/models/user_group.rb +215 -0
  245. data/lib/harbor2_legacy_client/models/user_profile.rb +205 -0
  246. data/lib/harbor2_legacy_client/models/user_search.rb +194 -0
  247. data/lib/harbor2_legacy_client/models/webhook_job.rb +256 -0
  248. data/lib/harbor2_legacy_client/models/webhook_last_trigger.rb +216 -0
  249. data/lib/harbor2_legacy_client/models/webhook_policy.rb +278 -0
  250. data/lib/harbor2_legacy_client/models/webhook_target_object.rb +216 -0
  251. data/lib/harbor2_legacy_client/version.rb +15 -0
  252. data/spec/api/chart_repository_api_spec.rb +79 -0
  253. data/spec/api/label_api_spec.rb +79 -0
  254. data/spec/api/products_api_spec.rb +1493 -0
  255. data/spec/api/quota_api_spec.rb +60 -0
  256. data/spec/api/retention_api_spec.rb +136 -0
  257. data/spec/api/robot_account_api_spec.rb +100 -0
  258. data/spec/api/scan_api_spec.rb +57 -0
  259. data/spec/api/scanners_api_spec.rb +169 -0
  260. data/spec/api/system_api_spec.rb +70 -0
  261. data/spec/api_client_spec.rb +243 -0
  262. data/spec/configuration_spec.rb +42 -0
  263. data/spec/models/action_1_spec.rb +41 -0
  264. data/spec/models/action_spec.rb +41 -0
  265. data/spec/models/admin_job_schedule_obj_spec.rb +47 -0
  266. data/spec/models/admin_job_schedule_spec.rb +47 -0
  267. data/spec/models/bad_request_formated_error_spec.rb +41 -0
  268. data/spec/models/bool_config_item_spec.rb +47 -0
  269. data/spec/models/chart_api_error_spec.rb +41 -0
  270. data/spec/models/chart_metadata_spec.rb +101 -0
  271. data/spec/models/chart_version_spec.rb +131 -0
  272. data/spec/models/component_health_status_spec.rb +53 -0
  273. data/spec/models/component_overview_entry_spec.rb +47 -0
  274. data/spec/models/configurations_response_spec.rb +239 -0
  275. data/spec/models/configurations_scan_all_policy_parameter_spec.rb +41 -0
  276. data/spec/models/configurations_scan_all_policy_spec.rb +47 -0
  277. data/spec/models/configurations_spec.rb +245 -0
  278. data/spec/models/conflict_formated_error_spec.rb +41 -0
  279. data/spec/models/cve_allowlist_item_spec.rb +41 -0
  280. data/spec/models/cve_allowlist_spec.rb +59 -0
  281. data/spec/models/email_server_setting_spec.rb +71 -0
  282. data/spec/models/endpoint_spec.rb +47 -0
  283. data/spec/models/event_type_spec.rb +35 -0
  284. data/spec/models/filter_style_spec.rb +53 -0
  285. data/spec/models/forbidden_chart_api_error_spec.rb +41 -0
  286. data/spec/models/gc_result_spec.rb +89 -0
  287. data/spec/models/general_info_spec.rb +89 -0
  288. data/spec/models/input_secret_spec.rb +41 -0
  289. data/spec/models/insufficient_storage_chart_api_error_spec.rb +41 -0
  290. data/spec/models/integer_config_item_spec.rb +47 -0
  291. data/spec/models/internal_chart_api_error_spec.rb +41 -0
  292. data/spec/models/is_default_spec.rb +41 -0
  293. data/spec/models/label_spec.rb +89 -0
  294. data/spec/models/labels_spec.rb +35 -0
  295. data/spec/models/ldap_conf_spec.rb +83 -0
  296. data/spec/models/ldap_failed_import_users_spec.rb +47 -0
  297. data/spec/models/ldap_import_users_spec.rb +41 -0
  298. data/spec/models/ldap_users_spec.rb +53 -0
  299. data/spec/models/namespace_spec.rb +47 -0
  300. data/spec/models/not_found_chart_api_error_spec.rb +41 -0
  301. data/spec/models/notify_type_spec.rb +35 -0
  302. data/spec/models/overall_health_status_spec.rb +47 -0
  303. data/spec/models/password_spec.rb +47 -0
  304. data/spec/models/permission_spec.rb +47 -0
  305. data/spec/models/ping_registry_spec.rb +77 -0
  306. data/spec/models/project_member_entity_spec.rb +77 -0
  307. data/spec/models/project_member_spec.rb +53 -0
  308. data/spec/models/project_metadata_spec.rb +71 -0
  309. data/spec/models/project_req_spec.rb +71 -0
  310. data/spec/models/project_scanner_spec.rb +41 -0
  311. data/spec/models/project_spec.rb +125 -0
  312. data/spec/models/project_summary_quota_spec.rb +47 -0
  313. data/spec/models/project_summary_spec.rb +83 -0
  314. data/spec/models/put_registry_spec.rb +77 -0
  315. data/spec/models/quota_ref_object_spec.rb +35 -0
  316. data/spec/models/quota_spec.rb +71 -0
  317. data/spec/models/quota_switcher_spec.rb +41 -0
  318. data/spec/models/quota_update_req_spec.rb +41 -0
  319. data/spec/models/registry_credential_spec.rb +53 -0
  320. data/spec/models/registry_info_spec.rb +59 -0
  321. data/spec/models/registry_spec.rb +95 -0
  322. data/spec/models/replication_execution_spec.rb +107 -0
  323. data/spec/models/replication_filter_spec.rb +47 -0
  324. data/spec/models/replication_policy_spec.rb +113 -0
  325. data/spec/models/replication_task_spec.rb +89 -0
  326. data/spec/models/replication_trigger_spec.rb +47 -0
  327. data/spec/models/resource_list_spec.rb +35 -0
  328. data/spec/models/retention_execution_spec.rb +77 -0
  329. data/spec/models/retention_execution_task_spec.rb +101 -0
  330. data/spec/models/retention_metadata_spec.rb +53 -0
  331. data/spec/models/retention_policy_scope_spec.rb +47 -0
  332. data/spec/models/retention_policy_spec.rb +65 -0
  333. data/spec/models/retention_rule_metadata_spec.rb +59 -0
  334. data/spec/models/retention_rule_param_metadata_spec.rb +53 -0
  335. data/spec/models/retention_rule_spec.rb +83 -0
  336. data/spec/models/retention_rule_trigger_spec.rb +53 -0
  337. data/spec/models/retention_selector_metadata_spec.rb +53 -0
  338. data/spec/models/retention_selector_spec.rb +59 -0
  339. data/spec/models/robot_account_access_spec.rb +47 -0
  340. data/spec/models/robot_account_create_spec.rb +59 -0
  341. data/spec/models/robot_account_post_rep_spec.rb +47 -0
  342. data/spec/models/robot_account_spec.rb +83 -0
  343. data/spec/models/robot_account_update_spec.rb +41 -0
  344. data/spec/models/role_param_spec.rb +47 -0
  345. data/spec/models/role_request_spec.rb +41 -0
  346. data/spec/models/role_spec.rb +59 -0
  347. data/spec/models/scanner_adapter_metadata_spec.rb +53 -0
  348. data/spec/models/scanner_capability_spec.rb +47 -0
  349. data/spec/models/scanner_registration_req_spec.rb +83 -0
  350. data/spec/models/scanner_registration_settings_spec.rb +59 -0
  351. data/spec/models/scanner_registration_spec.rb +119 -0
  352. data/spec/models/scanner_spec.rb +53 -0
  353. data/spec/models/search_repository_spec.rb +71 -0
  354. data/spec/models/search_result_spec.rb +53 -0
  355. data/spec/models/search_spec.rb +53 -0
  356. data/spec/models/statistic_map_spec.rb +71 -0
  357. data/spec/models/stats_spec.rb +65 -0
  358. data/spec/models/storage_spec.rb +47 -0
  359. data/spec/models/string_config_item_spec.rb +47 -0
  360. data/spec/models/supported_webhook_event_types_spec.rb +47 -0
  361. data/spec/models/sys_admin_flag_spec.rb +41 -0
  362. data/spec/models/system_info_spec.rb +41 -0
  363. data/spec/models/trigger_settings_spec.rb +41 -0
  364. data/spec/models/unauthorized_chart_api_error_spec.rb +41 -0
  365. data/spec/models/user_entity_spec.rb +47 -0
  366. data/spec/models/user_group_spec.rb +59 -0
  367. data/spec/models/user_profile_spec.rb +53 -0
  368. data/spec/models/user_search_spec.rb +47 -0
  369. data/spec/models/user_spec.rb +125 -0
  370. data/spec/models/webhook_job_spec.rb +83 -0
  371. data/spec/models/webhook_last_trigger_spec.rb +59 -0
  372. data/spec/models/webhook_policy_spec.rb +95 -0
  373. data/spec/models/webhook_target_object_spec.rb +59 -0
  374. data/spec/spec_helper.rb +111 -0
  375. metadata +740 -0
@@ -0,0 +1,11 @@
1
+ # Harbor2LegacyClient::RobotAccountCreate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of robot account | [optional]
7
+ **description** | **String** | The description of robot account | [optional]
8
+ **expires_at** | **Integer** | The expiration time on or after which the JWT MUST NOT be accepted for processing. | [optional]
9
+ **access** | [**Array<RobotAccountAccess>**](RobotAccountAccess.md) | The permission of robot account | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # Harbor2LegacyClient::RobotAccountPostRep
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | the name of robot account | [optional]
7
+ **token** | **String** | the token of robot account | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # Harbor2LegacyClient::RobotAccountUpdate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **disabled** | **BOOLEAN** | The robot account is disable or enable | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # Harbor2LegacyClient::Role
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **role_id** | **Integer** | ID in table. | [optional]
7
+ **role_code** | **String** | Description of permissions for the role. | [optional]
8
+ **role_name** | **String** | Name the the role. | [optional]
9
+ **role_mask** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # Harbor2LegacyClient::RoleParam
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **roles** | **Array<Integer>** | Role ID for updating project role member. | [optional]
7
+ **username** | **String** | Username relevant to a project role member. | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # Harbor2LegacyClient::RoleRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **role_id** | **Integer** | The role id 1 for projectAdmin, 2 for developer, 3 for guest, 4 for maintainer | [optional]
7
+
8
+
@@ -0,0 +1,104 @@
1
+ # Harbor2LegacyClient::ScanApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**scans_all_metrics_get**](ScanApi.md#scans_all_metrics_get) | **GET** /scans/all/metrics | Get the metrics of the latest scan all process
8
+ [**scans_schedule_metrics_get**](ScanApi.md#scans_schedule_metrics_get) | **GET** /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process
9
+
10
+
11
+ # **scans_all_metrics_get**
12
+ > Stats scans_all_metrics_get
13
+
14
+ Get the metrics of the latest scan all process
15
+
16
+ Get the metrics of the latest scan all process
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'harbor2_legacy_client'
22
+ # setup authorization
23
+ Harbor2LegacyClient.configure do |config|
24
+ # Configure HTTP basic authorization: basicAuth
25
+ config.username = 'YOUR USERNAME'
26
+ config.password = 'YOUR PASSWORD'
27
+ end
28
+
29
+ api_instance = Harbor2LegacyClient::ScanApi.new
30
+
31
+ begin
32
+ #Get the metrics of the latest scan all process
33
+ result = api_instance.scans_all_metrics_get
34
+ p result
35
+ rescue Harbor2LegacyClient::ApiError => e
36
+ puts "Exception when calling ScanApi->scans_all_metrics_get: #{e}"
37
+ end
38
+ ```
39
+
40
+ ### Parameters
41
+ This endpoint does not need any parameter.
42
+
43
+ ### Return type
44
+
45
+ [**Stats**](Stats.md)
46
+
47
+ ### Authorization
48
+
49
+ [basicAuth](../README.md#basicAuth)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: application/json
54
+ - **Accept**: application/json, text/plain
55
+
56
+
57
+
58
+ # **scans_schedule_metrics_get**
59
+ > Stats scans_schedule_metrics_get
60
+
61
+ Get the metrics of the latest scheduled scan all process
62
+
63
+ Get the metrics of the latest scheduled scan all process
64
+
65
+ ### Example
66
+ ```ruby
67
+ # load the gem
68
+ require 'harbor2_legacy_client'
69
+ # setup authorization
70
+ Harbor2LegacyClient.configure do |config|
71
+ # Configure HTTP basic authorization: basicAuth
72
+ config.username = 'YOUR USERNAME'
73
+ config.password = 'YOUR PASSWORD'
74
+ end
75
+
76
+ api_instance = Harbor2LegacyClient::ScanApi.new
77
+
78
+ begin
79
+ #Get the metrics of the latest scheduled scan all process
80
+ result = api_instance.scans_schedule_metrics_get
81
+ p result
82
+ rescue Harbor2LegacyClient::ApiError => e
83
+ puts "Exception when calling ScanApi->scans_schedule_metrics_get: #{e}"
84
+ end
85
+ ```
86
+
87
+ ### Parameters
88
+ This endpoint does not need any parameter.
89
+
90
+ ### Return type
91
+
92
+ [**Stats**](Stats.md)
93
+
94
+ ### Authorization
95
+
96
+ [basicAuth](../README.md#basicAuth)
97
+
98
+ ### HTTP request headers
99
+
100
+ - **Content-Type**: application/json
101
+ - **Accept**: application/json, text/plain
102
+
103
+
104
+
@@ -0,0 +1,10 @@
1
+ # Harbor2LegacyClient::Scanner
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name of the scanner | [optional]
7
+ **vendor** | **String** | Name of the scanner provider | [optional]
8
+ **version** | **String** | Version of the scanner adapter | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # Harbor2LegacyClient::ScannerAdapterMetadata
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | [**Scanner**](Scanner.md) | | [optional]
7
+ **capabilities** | [**Array<ScannerCapability>**](ScannerCapability.md) | | [optional]
8
+ **properties** | **Hash<String, String>** | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # Harbor2LegacyClient::ScannerCapability
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **consumes_mime_types** | **Array<String>** | | [optional]
7
+ **produces_mime_types** | **Array<String>** | | [optional]
8
+
9
+
@@ -0,0 +1,21 @@
1
+ # Harbor2LegacyClient::ScannerRegistration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **uuid** | **String** | The unique identifier of this registration. | [optional]
7
+ **name** | **String** | The name of this registration. | [optional]
8
+ **description** | **String** | An optional description of this registration. | [optional]
9
+ **url** | **String** | A base URL of the scanner adapter | [optional]
10
+ **disabled** | **BOOLEAN** | Indicate whether the registration is enabled or not | [optional] [default to false]
11
+ **is_default** | **BOOLEAN** | Indicate if the registration is set as the system default one | [optional] [default to false]
12
+ **health** | **String** | Indicate the healthy of the registration | [optional] [default to '']
13
+ **auth** | **String** | Specify what authentication approach is adopted for the HTTP communications. Supported types Basic\", \"Bearer\" and api key header \"X-ScannerAdapter-API-Key\" | [optional] [default to '']
14
+ **access_credential** | **String** | An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API. | [optional]
15
+ **skip_cert_verify** | **BOOLEAN** | Indicate if skip the certificate verification when sending HTTP requests | [optional] [default to false]
16
+ **use_internal_addr** | **BOOLEAN** | Indicate whether use internal registry addr for the scanner to pull content or not | [optional] [default to false]
17
+ **adapter** | **String** | Optional property to describe the name of the scanner registration | [optional]
18
+ **vendor** | **String** | Optional property to describe the vendor of the scanner registration | [optional]
19
+ **version** | **String** | Optional property to describe the version of the scanner registration | [optional]
20
+
21
+
@@ -0,0 +1,15 @@
1
+ # Harbor2LegacyClient::ScannerRegistrationReq
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of this registration | [optional]
7
+ **description** | **String** | An optional description of this registration. | [optional]
8
+ **url** | **String** | A base URL of the scanner adapter. | [optional]
9
+ **auth** | **String** | Specify what authentication approach is adopted for the HTTP communications. Supported types Basic\", \"Bearer\" and api key header \"X-ScannerAdapter-API-Key\" | [optional] [default to '']
10
+ **access_credential** | **String** | An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API. | [optional]
11
+ **skip_cert_verify** | **BOOLEAN** | Indicate if skip the certificate verification when sending HTTP requests | [optional] [default to false]
12
+ **use_internal_addr** | **BOOLEAN** | Indicate whether use internal registry addr for the scanner to pull content or not | [optional] [default to false]
13
+ **disabled** | **BOOLEAN** | Indicate whether the registration is enabled or not | [optional] [default to false]
14
+
15
+
@@ -0,0 +1,11 @@
1
+ # Harbor2LegacyClient::ScannerRegistrationSettings
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The name of this registration | [optional]
7
+ **url** | **String** | A base URL of the scanner adapter. | [optional]
8
+ **auth** | **String** | Specify what authentication approach is adopted for the HTTP communications. Supported types Basic\", \"Bearer\" and api key header \"X-ScannerAdapter-API-Key\" | [optional] [default to '']
9
+ **access_credential** | **String** | An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API. | [optional]
10
+
11
+
@@ -0,0 +1,600 @@
1
+ # Harbor2LegacyClient::ScannersApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**projects_project_id_scanner_candidates_get**](ScannersApi.md#projects_project_id_scanner_candidates_get) | **GET** /projects/{project_id}/scanner/candidates | Get scanner registration candidates for configurating project level scanner
8
+ [**projects_project_id_scanner_get**](ScannersApi.md#projects_project_id_scanner_get) | **GET** /projects/{project_id}/scanner | Get project level scanner
9
+ [**projects_project_id_scanner_put**](ScannersApi.md#projects_project_id_scanner_put) | **PUT** /projects/{project_id}/scanner | Configure scanner for the specified project
10
+ [**scanners_get**](ScannersApi.md#scanners_get) | **GET** /scanners | List scanner registrations
11
+ [**scanners_ping_post**](ScannersApi.md#scanners_ping_post) | **POST** /scanners/ping | Tests scanner registration settings
12
+ [**scanners_post**](ScannersApi.md#scanners_post) | **POST** /scanners | Create a scanner registration
13
+ [**scanners_registration_id_delete**](ScannersApi.md#scanners_registration_id_delete) | **DELETE** /scanners/{registration_id} | Delete a scanner registration
14
+ [**scanners_registration_id_get**](ScannersApi.md#scanners_registration_id_get) | **GET** /scanners/{registration_id} | Get a scanner registration details
15
+ [**scanners_registration_id_metadata_get**](ScannersApi.md#scanners_registration_id_metadata_get) | **GET** /scanners/{registration_id}/metadata | Get the metadata of the specified scanner registration
16
+ [**scanners_registration_id_patch**](ScannersApi.md#scanners_registration_id_patch) | **PATCH** /scanners/{registration_id} | Set system default scanner registration
17
+ [**scanners_registration_id_put**](ScannersApi.md#scanners_registration_id_put) | **PUT** /scanners/{registration_id} | Update a scanner registration
18
+
19
+
20
+ # **projects_project_id_scanner_candidates_get**
21
+ > Array<ScannerRegistration> projects_project_id_scanner_candidates_get(project_id)
22
+
23
+ Get scanner registration candidates for configurating project level scanner
24
+
25
+ Retrieve the system configured scanner registrations as candidates of setting project level scanner.
26
+
27
+ ### Example
28
+ ```ruby
29
+ # load the gem
30
+ require 'harbor2_legacy_client'
31
+ # setup authorization
32
+ Harbor2LegacyClient.configure do |config|
33
+ # Configure HTTP basic authorization: basicAuth
34
+ config.username = 'YOUR USERNAME'
35
+ config.password = 'YOUR PASSWORD'
36
+ end
37
+
38
+ api_instance = Harbor2LegacyClient::ScannersApi.new
39
+
40
+ project_id = 789 # Integer | The project identifier.
41
+
42
+
43
+ begin
44
+ #Get scanner registration candidates for configurating project level scanner
45
+ result = api_instance.projects_project_id_scanner_candidates_get(project_id)
46
+ p result
47
+ rescue Harbor2LegacyClient::ApiError => e
48
+ puts "Exception when calling ScannersApi->projects_project_id_scanner_candidates_get: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ Name | Type | Description | Notes
55
+ ------------- | ------------- | ------------- | -------------
56
+ **project_id** | **Integer**| The project identifier. |
57
+
58
+ ### Return type
59
+
60
+ [**Array<ScannerRegistration>**](ScannerRegistration.md)
61
+
62
+ ### Authorization
63
+
64
+ [basicAuth](../README.md#basicAuth)
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: application/json
69
+ - **Accept**: application/json, text/plain
70
+
71
+
72
+
73
+ # **projects_project_id_scanner_get**
74
+ > ScannerRegistration projects_project_id_scanner_get(project_id)
75
+
76
+ Get project level scanner
77
+
78
+ Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.
79
+
80
+ ### Example
81
+ ```ruby
82
+ # load the gem
83
+ require 'harbor2_legacy_client'
84
+ # setup authorization
85
+ Harbor2LegacyClient.configure do |config|
86
+ # Configure HTTP basic authorization: basicAuth
87
+ config.username = 'YOUR USERNAME'
88
+ config.password = 'YOUR PASSWORD'
89
+ end
90
+
91
+ api_instance = Harbor2LegacyClient::ScannersApi.new
92
+
93
+ project_id = 789 # Integer | The project identifier.
94
+
95
+
96
+ begin
97
+ #Get project level scanner
98
+ result = api_instance.projects_project_id_scanner_get(project_id)
99
+ p result
100
+ rescue Harbor2LegacyClient::ApiError => e
101
+ puts "Exception when calling ScannersApi->projects_project_id_scanner_get: #{e}"
102
+ end
103
+ ```
104
+
105
+ ### Parameters
106
+
107
+ Name | Type | Description | Notes
108
+ ------------- | ------------- | ------------- | -------------
109
+ **project_id** | **Integer**| The project identifier. |
110
+
111
+ ### Return type
112
+
113
+ [**ScannerRegistration**](ScannerRegistration.md)
114
+
115
+ ### Authorization
116
+
117
+ [basicAuth](../README.md#basicAuth)
118
+
119
+ ### HTTP request headers
120
+
121
+ - **Content-Type**: application/json
122
+ - **Accept**: application/json, text/plain
123
+
124
+
125
+
126
+ # **projects_project_id_scanner_put**
127
+ > projects_project_id_scanner_put(project_id, payload)
128
+
129
+ Configure scanner for the specified project
130
+
131
+ Set one of the system configured scanner registration as the indepndent scanner of the specified project.
132
+
133
+ ### Example
134
+ ```ruby
135
+ # load the gem
136
+ require 'harbor2_legacy_client'
137
+ # setup authorization
138
+ Harbor2LegacyClient.configure do |config|
139
+ # Configure HTTP basic authorization: basicAuth
140
+ config.username = 'YOUR USERNAME'
141
+ config.password = 'YOUR PASSWORD'
142
+ end
143
+
144
+ api_instance = Harbor2LegacyClient::ScannersApi.new
145
+
146
+ project_id = 789 # Integer | The project identifier.
147
+
148
+ payload = Harbor2LegacyClient::ProjectScanner.new # ProjectScanner |
149
+
150
+
151
+ begin
152
+ #Configure scanner for the specified project
153
+ api_instance.projects_project_id_scanner_put(project_id, payload)
154
+ rescue Harbor2LegacyClient::ApiError => e
155
+ puts "Exception when calling ScannersApi->projects_project_id_scanner_put: #{e}"
156
+ end
157
+ ```
158
+
159
+ ### Parameters
160
+
161
+ Name | Type | Description | Notes
162
+ ------------- | ------------- | ------------- | -------------
163
+ **project_id** | **Integer**| The project identifier. |
164
+ **payload** | [**ProjectScanner**](ProjectScanner.md)| |
165
+
166
+ ### Return type
167
+
168
+ nil (empty response body)
169
+
170
+ ### Authorization
171
+
172
+ [basicAuth](../README.md#basicAuth)
173
+
174
+ ### HTTP request headers
175
+
176
+ - **Content-Type**: application/json
177
+ - **Accept**: application/json, text/plain
178
+
179
+
180
+
181
+ # **scanners_get**
182
+ > Array<ScannerRegistration> scanners_get
183
+
184
+ List scanner registrations
185
+
186
+ Returns a list of currently configured scanner registrations.
187
+
188
+ ### Example
189
+ ```ruby
190
+ # load the gem
191
+ require 'harbor2_legacy_client'
192
+ # setup authorization
193
+ Harbor2LegacyClient.configure do |config|
194
+ # Configure HTTP basic authorization: basicAuth
195
+ config.username = 'YOUR USERNAME'
196
+ config.password = 'YOUR PASSWORD'
197
+ end
198
+
199
+ api_instance = Harbor2LegacyClient::ScannersApi.new
200
+
201
+ begin
202
+ #List scanner registrations
203
+ result = api_instance.scanners_get
204
+ p result
205
+ rescue Harbor2LegacyClient::ApiError => e
206
+ puts "Exception when calling ScannersApi->scanners_get: #{e}"
207
+ end
208
+ ```
209
+
210
+ ### Parameters
211
+ This endpoint does not need any parameter.
212
+
213
+ ### Return type
214
+
215
+ [**Array<ScannerRegistration>**](ScannerRegistration.md)
216
+
217
+ ### Authorization
218
+
219
+ [basicAuth](../README.md#basicAuth)
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: application/json
224
+ - **Accept**: application/json, text/plain
225
+
226
+
227
+
228
+ # **scanners_ping_post**
229
+ > scanners_ping_post(settings)
230
+
231
+ Tests scanner registration settings
232
+
233
+ Pings scanner adapter to test endpoint URL and authorization settings.
234
+
235
+ ### Example
236
+ ```ruby
237
+ # load the gem
238
+ require 'harbor2_legacy_client'
239
+ # setup authorization
240
+ Harbor2LegacyClient.configure do |config|
241
+ # Configure HTTP basic authorization: basicAuth
242
+ config.username = 'YOUR USERNAME'
243
+ config.password = 'YOUR PASSWORD'
244
+ end
245
+
246
+ api_instance = Harbor2LegacyClient::ScannersApi.new
247
+
248
+ settings = Harbor2LegacyClient::ScannerRegistrationSettings.new # ScannerRegistrationSettings | A scanner registration settings to be tested.
249
+
250
+
251
+ begin
252
+ #Tests scanner registration settings
253
+ api_instance.scanners_ping_post(settings)
254
+ rescue Harbor2LegacyClient::ApiError => e
255
+ puts "Exception when calling ScannersApi->scanners_ping_post: #{e}"
256
+ end
257
+ ```
258
+
259
+ ### Parameters
260
+
261
+ Name | Type | Description | Notes
262
+ ------------- | ------------- | ------------- | -------------
263
+ **settings** | [**ScannerRegistrationSettings**](ScannerRegistrationSettings.md)| A scanner registration settings to be tested. |
264
+
265
+ ### Return type
266
+
267
+ nil (empty response body)
268
+
269
+ ### Authorization
270
+
271
+ [basicAuth](../README.md#basicAuth)
272
+
273
+ ### HTTP request headers
274
+
275
+ - **Content-Type**: application/json
276
+ - **Accept**: application/json, text/plain
277
+
278
+
279
+
280
+ # **scanners_post**
281
+ > scanners_post(registration)
282
+
283
+ Create a scanner registration
284
+
285
+ Creats a new scanner registration with the given data.
286
+
287
+ ### Example
288
+ ```ruby
289
+ # load the gem
290
+ require 'harbor2_legacy_client'
291
+ # setup authorization
292
+ Harbor2LegacyClient.configure do |config|
293
+ # Configure HTTP basic authorization: basicAuth
294
+ config.username = 'YOUR USERNAME'
295
+ config.password = 'YOUR PASSWORD'
296
+ end
297
+
298
+ api_instance = Harbor2LegacyClient::ScannersApi.new
299
+
300
+ registration = Harbor2LegacyClient::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registration to be created.
301
+
302
+
303
+ begin
304
+ #Create a scanner registration
305
+ api_instance.scanners_post(registration)
306
+ rescue Harbor2LegacyClient::ApiError => e
307
+ puts "Exception when calling ScannersApi->scanners_post: #{e}"
308
+ end
309
+ ```
310
+
311
+ ### Parameters
312
+
313
+ Name | Type | Description | Notes
314
+ ------------- | ------------- | ------------- | -------------
315
+ **registration** | [**ScannerRegistrationReq**](ScannerRegistrationReq.md)| A scanner registration to be created. |
316
+
317
+ ### Return type
318
+
319
+ nil (empty response body)
320
+
321
+ ### Authorization
322
+
323
+ [basicAuth](../README.md#basicAuth)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: application/json
328
+ - **Accept**: application/json, text/plain
329
+
330
+
331
+
332
+ # **scanners_registration_id_delete**
333
+ > ScannerRegistration scanners_registration_id_delete(registration_id)
334
+
335
+ Delete a scanner registration
336
+
337
+ Deletes the specified scanner registration.
338
+
339
+ ### Example
340
+ ```ruby
341
+ # load the gem
342
+ require 'harbor2_legacy_client'
343
+ # setup authorization
344
+ Harbor2LegacyClient.configure do |config|
345
+ # Configure HTTP basic authorization: basicAuth
346
+ config.username = 'YOUR USERNAME'
347
+ config.password = 'YOUR PASSWORD'
348
+ end
349
+
350
+ api_instance = Harbor2LegacyClient::ScannersApi.new
351
+
352
+ registration_id = 'registration_id_example' # String | The scanner registration identifier.
353
+
354
+
355
+ begin
356
+ #Delete a scanner registration
357
+ result = api_instance.scanners_registration_id_delete(registration_id)
358
+ p result
359
+ rescue Harbor2LegacyClient::ApiError => e
360
+ puts "Exception when calling ScannersApi->scanners_registration_id_delete: #{e}"
361
+ end
362
+ ```
363
+
364
+ ### Parameters
365
+
366
+ Name | Type | Description | Notes
367
+ ------------- | ------------- | ------------- | -------------
368
+ **registration_id** | **String**| The scanner registration identifier. |
369
+
370
+ ### Return type
371
+
372
+ [**ScannerRegistration**](ScannerRegistration.md)
373
+
374
+ ### Authorization
375
+
376
+ [basicAuth](../README.md#basicAuth)
377
+
378
+ ### HTTP request headers
379
+
380
+ - **Content-Type**: application/json
381
+ - **Accept**: application/json, text/plain
382
+
383
+
384
+
385
+ # **scanners_registration_id_get**
386
+ > ScannerRegistration scanners_registration_id_get(registration_id)
387
+
388
+ Get a scanner registration details
389
+
390
+ Retruns the details of the specified scanner registration.
391
+
392
+ ### Example
393
+ ```ruby
394
+ # load the gem
395
+ require 'harbor2_legacy_client'
396
+ # setup authorization
397
+ Harbor2LegacyClient.configure do |config|
398
+ # Configure HTTP basic authorization: basicAuth
399
+ config.username = 'YOUR USERNAME'
400
+ config.password = 'YOUR PASSWORD'
401
+ end
402
+
403
+ api_instance = Harbor2LegacyClient::ScannersApi.new
404
+
405
+ registration_id = 'registration_id_example' # String | The scanner registration identifer.
406
+
407
+
408
+ begin
409
+ #Get a scanner registration details
410
+ result = api_instance.scanners_registration_id_get(registration_id)
411
+ p result
412
+ rescue Harbor2LegacyClient::ApiError => e
413
+ puts "Exception when calling ScannersApi->scanners_registration_id_get: #{e}"
414
+ end
415
+ ```
416
+
417
+ ### Parameters
418
+
419
+ Name | Type | Description | Notes
420
+ ------------- | ------------- | ------------- | -------------
421
+ **registration_id** | **String**| The scanner registration identifer. |
422
+
423
+ ### Return type
424
+
425
+ [**ScannerRegistration**](ScannerRegistration.md)
426
+
427
+ ### Authorization
428
+
429
+ [basicAuth](../README.md#basicAuth)
430
+
431
+ ### HTTP request headers
432
+
433
+ - **Content-Type**: application/json
434
+ - **Accept**: application/json, text/plain
435
+
436
+
437
+
438
+ # **scanners_registration_id_metadata_get**
439
+ > ScannerAdapterMetadata scanners_registration_id_metadata_get(registration_id)
440
+
441
+ Get the metadata of the specified scanner registration
442
+
443
+ Get the metadata of the specified scanner registration, including the capabilities and customzied properties.
444
+
445
+ ### Example
446
+ ```ruby
447
+ # load the gem
448
+ require 'harbor2_legacy_client'
449
+ # setup authorization
450
+ Harbor2LegacyClient.configure do |config|
451
+ # Configure HTTP basic authorization: basicAuth
452
+ config.username = 'YOUR USERNAME'
453
+ config.password = 'YOUR PASSWORD'
454
+ end
455
+
456
+ api_instance = Harbor2LegacyClient::ScannersApi.new
457
+
458
+ registration_id = 'registration_id_example' # String | The scanner registration identifier.
459
+
460
+
461
+ begin
462
+ #Get the metadata of the specified scanner registration
463
+ result = api_instance.scanners_registration_id_metadata_get(registration_id)
464
+ p result
465
+ rescue Harbor2LegacyClient::ApiError => e
466
+ puts "Exception when calling ScannersApi->scanners_registration_id_metadata_get: #{e}"
467
+ end
468
+ ```
469
+
470
+ ### Parameters
471
+
472
+ Name | Type | Description | Notes
473
+ ------------- | ------------- | ------------- | -------------
474
+ **registration_id** | **String**| The scanner registration identifier. |
475
+
476
+ ### Return type
477
+
478
+ [**ScannerAdapterMetadata**](ScannerAdapterMetadata.md)
479
+
480
+ ### Authorization
481
+
482
+ [basicAuth](../README.md#basicAuth)
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: application/json
487
+ - **Accept**: application/json, text/plain
488
+
489
+
490
+
491
+ # **scanners_registration_id_patch**
492
+ > scanners_registration_id_patch(registration_id, payload)
493
+
494
+ Set system default scanner registration
495
+
496
+ Set the specified scanner registration as the system default one.
497
+
498
+ ### Example
499
+ ```ruby
500
+ # load the gem
501
+ require 'harbor2_legacy_client'
502
+ # setup authorization
503
+ Harbor2LegacyClient.configure do |config|
504
+ # Configure HTTP basic authorization: basicAuth
505
+ config.username = 'YOUR USERNAME'
506
+ config.password = 'YOUR PASSWORD'
507
+ end
508
+
509
+ api_instance = Harbor2LegacyClient::ScannersApi.new
510
+
511
+ registration_id = 'registration_id_example' # String | The scanner registration identifier.
512
+
513
+ payload = Harbor2LegacyClient::IsDefault.new # IsDefault |
514
+
515
+
516
+ begin
517
+ #Set system default scanner registration
518
+ api_instance.scanners_registration_id_patch(registration_id, payload)
519
+ rescue Harbor2LegacyClient::ApiError => e
520
+ puts "Exception when calling ScannersApi->scanners_registration_id_patch: #{e}"
521
+ end
522
+ ```
523
+
524
+ ### Parameters
525
+
526
+ Name | Type | Description | Notes
527
+ ------------- | ------------- | ------------- | -------------
528
+ **registration_id** | **String**| The scanner registration identifier. |
529
+ **payload** | [**IsDefault**](IsDefault.md)| |
530
+
531
+ ### Return type
532
+
533
+ nil (empty response body)
534
+
535
+ ### Authorization
536
+
537
+ [basicAuth](../README.md#basicAuth)
538
+
539
+ ### HTTP request headers
540
+
541
+ - **Content-Type**: application/json
542
+ - **Accept**: application/json, text/plain
543
+
544
+
545
+
546
+ # **scanners_registration_id_put**
547
+ > scanners_registration_id_put(registration_id, registration)
548
+
549
+ Update a scanner registration
550
+
551
+ Updates the specified scanner registration.
552
+
553
+ ### Example
554
+ ```ruby
555
+ # load the gem
556
+ require 'harbor2_legacy_client'
557
+ # setup authorization
558
+ Harbor2LegacyClient.configure do |config|
559
+ # Configure HTTP basic authorization: basicAuth
560
+ config.username = 'YOUR USERNAME'
561
+ config.password = 'YOUR PASSWORD'
562
+ end
563
+
564
+ api_instance = Harbor2LegacyClient::ScannersApi.new
565
+
566
+ registration_id = 'registration_id_example' # String | The scanner registration identifier.
567
+
568
+ registration = Harbor2LegacyClient::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registraiton to be updated.
569
+
570
+
571
+ begin
572
+ #Update a scanner registration
573
+ api_instance.scanners_registration_id_put(registration_id, registration)
574
+ rescue Harbor2LegacyClient::ApiError => e
575
+ puts "Exception when calling ScannersApi->scanners_registration_id_put: #{e}"
576
+ end
577
+ ```
578
+
579
+ ### Parameters
580
+
581
+ Name | Type | Description | Notes
582
+ ------------- | ------------- | ------------- | -------------
583
+ **registration_id** | **String**| The scanner registration identifier. |
584
+ **registration** | [**ScannerRegistrationReq**](ScannerRegistrationReq.md)| A scanner registraiton to be updated. |
585
+
586
+ ### Return type
587
+
588
+ nil (empty response body)
589
+
590
+ ### Authorization
591
+
592
+ [basicAuth](../README.md#basicAuth)
593
+
594
+ ### HTTP request headers
595
+
596
+ - **Content-Type**: application/json
597
+ - **Accept**: application/json, text/plain
598
+
599
+
600
+