harbor_swagger_client 1.0.4 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (432) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +1 -1
  3. data/README.md +119 -271
  4. data/docs/Access.md +10 -0
  5. data/docs/AdditionLink.md +9 -0
  6. data/docs/{QuotaRefObject.md → AdditionLinks.md} +1 -1
  7. data/docs/{EventType.md → Annotations.md} +1 -1
  8. data/docs/Artifact.md +25 -0
  9. data/docs/ArtifactApi.md +694 -0
  10. data/docs/AuditLog.md +13 -0
  11. data/docs/AuditlogApi.md +69 -0
  12. data/docs/AuthproxySetting.md +12 -0
  13. data/docs/CVEAllowlist.md +13 -0
  14. data/docs/{CVEWhitelistItem.md → CVEAllowlistItem.md} +1 -1
  15. data/docs/Error.md +9 -0
  16. data/docs/{Action.md → Errors.md} +2 -2
  17. data/docs/Execution.md +17 -0
  18. data/docs/{NotifyType.md → ExtraAttrs.md} +1 -1
  19. data/docs/GeneralInfo.md +4 -0
  20. data/docs/Icon.md +9 -0
  21. data/docs/IconApi.md +66 -0
  22. data/docs/Instance.md +19 -0
  23. data/docs/Label.md +8 -9
  24. data/docs/Metadata.md +13 -0
  25. data/docs/Metrics.md +14 -0
  26. data/docs/NativeReportSummary.md +15 -0
  27. data/docs/Permission.md +3 -2
  28. data/docs/PingApi.md +56 -0
  29. data/docs/Platform.md +12 -0
  30. data/docs/PreheatApi.md +1176 -0
  31. data/docs/PreheatPolicy.md +18 -0
  32. data/docs/Project.md +4 -3
  33. data/docs/ProjectApi.md +544 -0
  34. data/docs/ProjectDeletable.md +9 -0
  35. data/docs/ProjectMetadata.md +2 -1
  36. data/docs/ProjectReq.md +3 -2
  37. data/docs/ProjectSummary.md +3 -1
  38. data/docs/{ImmutableTagRule.md → ProviderUnderProject.md} +3 -3
  39. data/docs/Reference.md +13 -0
  40. data/docs/ReplicationApi.md +352 -0
  41. data/docs/ReplicationExecution.md +11 -11
  42. data/docs/ReplicationTask.md +10 -9
  43. data/docs/Repository.md +15 -0
  44. data/docs/RepositoryApi.md +256 -0
  45. data/docs/Robot.md +19 -0
  46. data/docs/RobotApi.md +363 -0
  47. data/docs/RobotCreate.md +14 -0
  48. data/docs/{RobotAccountCreate.md → RobotCreateV1.md} +2 -2
  49. data/docs/RobotCreated.md +12 -0
  50. data/docs/{Action1.md → RobotSec.md} +2 -2
  51. data/docs/Robotv1Api.md +317 -0
  52. data/docs/ScanApi.md +61 -27
  53. data/docs/{Labels.md → ScanOverview.md} +1 -1
  54. data/docs/StartReplicationExecution.md +8 -0
  55. data/docs/SysteminfoApi.md +152 -0
  56. data/docs/Tag.md +15 -0
  57. data/docs/Task.md +17 -0
  58. data/docs/VulnerabilitySummary.md +10 -0
  59. data/harbor_swagger_client-1.0.3.gem +0 -0
  60. data/harbor_swagger_client.gemspec +2 -1
  61. data/lib/harbor_swagger_client.rb +46 -106
  62. data/lib/harbor_swagger_client/api/artifact_api.rb +848 -0
  63. data/lib/harbor_swagger_client/api/auditlog_api.rb +91 -0
  64. data/lib/harbor_swagger_client/api/icon_api.rb +84 -0
  65. data/lib/harbor_swagger_client/api/ping_api.rb +71 -0
  66. data/lib/harbor_swagger_client/api/preheat_api.rb +1327 -0
  67. data/lib/harbor_swagger_client/api/project_api.rb +604 -0
  68. data/lib/harbor_swagger_client/api/replication_api.rb +380 -0
  69. data/lib/harbor_swagger_client/api/repository_api.rb +302 -0
  70. data/lib/harbor_swagger_client/api/robot_api.rb +406 -0
  71. data/lib/harbor_swagger_client/api/robotv1_api.rb +369 -0
  72. data/lib/harbor_swagger_client/api/scan_api.rb +89 -34
  73. data/lib/harbor_swagger_client/api/systeminfo_api.rb +167 -0
  74. data/lib/harbor_swagger_client/api_client.rb +6 -4
  75. data/lib/harbor_swagger_client/api_error.rb +1 -1
  76. data/lib/harbor_swagger_client/configuration.rb +4 -4
  77. data/lib/harbor_swagger_client/models/{robot_account_access.rb → access.rb} +20 -9
  78. data/lib/harbor_swagger_client/models/{namespace.rb → addition_link.rb} +19 -19
  79. data/lib/harbor_swagger_client/models/{quota_ref_object.rb → addition_links.rb} +4 -3
  80. data/lib/harbor_swagger_client/models/{labels.rb → annotations.rb} +4 -4
  81. data/lib/harbor_swagger_client/models/{chart_version.rb → artifact.rb} +133 -139
  82. data/lib/harbor_swagger_client/models/audit_log.rb +235 -0
  83. data/lib/harbor_swagger_client/models/{email_server_setting.rb → authproxy_setting.rb} +40 -49
  84. data/lib/harbor_swagger_client/models/{cve_whitelist.rb → cve_allowlist.rb} +32 -11
  85. data/lib/harbor_swagger_client/models/{cve_whitelist_item.rb → cve_allowlist_item.rb} +5 -4
  86. data/lib/harbor_swagger_client/models/{ldap_failed_import_users.rb → error.rb} +20 -18
  87. data/lib/harbor_swagger_client/models/{action_1.rb → errors.rb} +14 -10
  88. data/lib/harbor_swagger_client/models/{retention_execution.rb → execution.rb} +67 -31
  89. data/lib/harbor_swagger_client/models/{event_type.rb → extra_attrs.rb} +4 -4
  90. data/lib/harbor_swagger_client/models/general_info.rb +47 -6
  91. data/lib/harbor_swagger_client/models/{endpoint.rb → icon.rb} +19 -18
  92. data/lib/harbor_swagger_client/models/instance.rb +297 -0
  93. data/lib/harbor_swagger_client/models/label.rb +16 -25
  94. data/lib/harbor_swagger_client/models/{scanner.rb → metadata.rb} +49 -16
  95. data/lib/harbor_swagger_client/models/{webhook_job.rb → metrics.rb} +54 -64
  96. data/lib/harbor_swagger_client/models/{component_overview_entry.rb → native_report_summary.rb} +74 -13
  97. data/lib/harbor_swagger_client/models/permission.rb +29 -18
  98. data/lib/harbor_swagger_client/models/{retention_policy.rb → platform.rb} +42 -37
  99. data/lib/harbor_swagger_client/models/{webhook_policy.rb → preheat_policy.rb} +56 -48
  100. data/lib/harbor_swagger_client/models/project.rb +23 -12
  101. data/lib/harbor_swagger_client/models/{configurations_scan_all_policy.rb → project_deletable.rb} +19 -17
  102. data/lib/harbor_swagger_client/models/project_metadata.rb +21 -10
  103. data/lib/harbor_swagger_client/models/project_req.rb +34 -23
  104. data/lib/harbor_swagger_client/models/project_summary.rb +33 -13
  105. data/lib/harbor_swagger_client/models/project_summary_quota.rb +3 -2
  106. data/lib/harbor_swagger_client/models/{immutable_tag_rule.rb → provider_under_project.rb} +23 -22
  107. data/lib/harbor_swagger_client/models/{stats.rb → reference.rb} +52 -34
  108. data/lib/harbor_swagger_client/models/registry.rb +3 -2
  109. data/lib/harbor_swagger_client/models/registry_credential.rb +3 -2
  110. data/lib/harbor_swagger_client/models/replication_execution.rb +45 -44
  111. data/lib/harbor_swagger_client/models/replication_task.rb +43 -32
  112. data/lib/harbor_swagger_client/models/{robot_account.rb → repository.rb} +36 -36
  113. data/lib/harbor_swagger_client/models/resource_list.rb +3 -2
  114. data/lib/harbor_swagger_client/models/{replication_policy.rb → robot.rb} +62 -71
  115. data/lib/harbor_swagger_client/models/{put_registry.rb → robot_create.rb} +44 -41
  116. data/lib/harbor_swagger_client/models/{robot_account_create.rb → robot_create_v1.rb} +5 -4
  117. data/lib/harbor_swagger_client/models/{quota.rb → robot_created.rb} +30 -39
  118. data/lib/harbor_swagger_client/models/{input_secret.rb → robot_sec.rb} +6 -4
  119. data/lib/harbor_swagger_client/models/{notify_type.rb → scan_overview.rb} +5 -4
  120. data/lib/harbor_swagger_client/models/{action.rb → start_replication_execution.rb} +12 -10
  121. data/lib/harbor_swagger_client/models/storage.rb +3 -2
  122. data/lib/harbor_swagger_client/models/system_info.rb +3 -2
  123. data/lib/harbor_swagger_client/models/{retention_rule.rb → tag.rb} +55 -52
  124. data/lib/harbor_swagger_client/models/{retention_execution_task.rb → task.rb} +53 -52
  125. data/lib/harbor_swagger_client/models/{scanner_adapter_metadata.rb → vulnerability_summary.rb} +28 -26
  126. data/lib/harbor_swagger_client/version.rb +2 -2
  127. data/spec/api/artifact_api_spec.rb +209 -0
  128. data/spec/api/auditlog_api_spec.rb +50 -0
  129. data/spec/api/icon_api_spec.rb +48 -0
  130. data/spec/api/ping_api_spec.rb +46 -0
  131. data/spec/api/preheat_api_spec.rb +311 -0
  132. data/spec/api/project_api_spec.rb +161 -0
  133. data/spec/api/replication_api_spec.rb +116 -0
  134. data/spec/api/repository_api_spec.rb +94 -0
  135. data/spec/api/robot_api_spec.rb +117 -0
  136. data/spec/api/robotv1_api_spec.rb +108 -0
  137. data/spec/api/scan_api_spec.rb +20 -11
  138. data/spec/api/systeminfo_api_spec.rb +68 -0
  139. data/spec/api_client_spec.rb +18 -1
  140. data/spec/configuration_spec.rb +1 -1
  141. data/spec/models/{search_spec.rb → access_spec.rb} +10 -10
  142. data/spec/models/{password_spec.rb → addition_link_spec.rb} +9 -9
  143. data/spec/models/{quota_ref_object_spec.rb → addition_links_spec.rb} +7 -7
  144. data/spec/models/{labels_spec.rb → annotations_spec.rb} +7 -7
  145. data/spec/models/{chart_version_spec.rb → artifact_spec.rb} +39 -21
  146. data/spec/models/{search_repository_spec.rb → audit_log_spec.rb} +13 -13
  147. data/spec/models/authproxy_setting_spec.rb +65 -0
  148. data/spec/models/{cve_whitelist_item_spec.rb → cve_allowlist_item_spec.rb} +7 -7
  149. data/spec/models/{quota_spec.rb → cve_allowlist_spec.rb} +10 -10
  150. data/spec/models/{endpoint_spec.rb → error_spec.rb} +9 -9
  151. data/spec/models/{action_spec.rb → errors_spec.rb} +8 -8
  152. data/spec/models/{gc_result_spec.rb → execution_spec.rb} +21 -15
  153. data/spec/models/{event_type_spec.rb → extra_attrs_spec.rb} +7 -7
  154. data/spec/models/general_info_spec.rb +25 -1
  155. data/spec/models/{namespace_spec.rb → icon_spec.rb} +9 -9
  156. data/spec/models/{chart_metadata_spec.rb → instance_spec.rb} +23 -17
  157. data/spec/models/label_spec.rb +1 -7
  158. data/spec/models/{email_server_setting_spec.rb → metadata_spec.rb} +13 -13
  159. data/spec/models/{ping_registry_spec.rb → metrics_spec.rb} +14 -14
  160. data/spec/models/{ldap_conf_spec.rb → native_report_summary_spec.rb} +15 -15
  161. data/spec/models/permission_spec.rb +9 -3
  162. data/spec/models/{registry_info_spec.rb → platform_spec.rb} +17 -11
  163. data/spec/models/{webhook_policy_spec.rb → preheat_policy_spec.rb} +19 -13
  164. data/spec/models/{bool_config_item_spec.rb → project_deletable_spec.rb} +9 -9
  165. data/spec/models/project_metadata_spec.rb +8 -2
  166. data/spec/models/project_req_spec.rb +10 -4
  167. data/spec/models/project_spec.rb +8 -2
  168. data/spec/models/project_summary_quota_spec.rb +1 -1
  169. data/spec/models/project_summary_spec.rb +14 -2
  170. data/spec/models/{immutable_tag_rule_spec.rb → provider_under_project_spec.rb} +10 -10
  171. data/spec/models/{statistic_map_spec.rb → reference_spec.rb} +13 -13
  172. data/spec/models/registry_credential_spec.rb +1 -1
  173. data/spec/models/registry_spec.rb +1 -1
  174. data/spec/models/replication_execution_spec.rb +10 -10
  175. data/spec/models/replication_task_spec.rb +12 -6
  176. data/spec/models/{robot_account_spec.rb → repository_spec.rb} +12 -12
  177. data/spec/models/resource_list_spec.rb +1 -1
  178. data/spec/models/{put_registry_spec.rb → robot_create_spec.rb} +12 -12
  179. data/spec/models/{robot_account_create_spec.rb → robot_create_v1_spec.rb} +7 -7
  180. data/spec/models/{retention_policy_spec.rb → robot_created_spec.rb} +11 -11
  181. data/spec/models/{input_secret_spec.rb → robot_sec_spec.rb} +7 -7
  182. data/spec/models/{replication_policy_spec.rb → robot_spec.rb} +14 -20
  183. data/spec/models/{notify_type_spec.rb → scan_overview_spec.rb} +7 -7
  184. data/spec/models/{unauthorized_chart_api_error_spec.rb → start_replication_execution_spec.rb} +8 -8
  185. data/spec/models/storage_spec.rb +1 -1
  186. data/spec/models/system_info_spec.rb +1 -1
  187. data/spec/models/{webhook_job_spec.rb → tag_spec.rb} +14 -14
  188. data/spec/models/{retention_execution_task_spec.rb → task_spec.rb} +15 -21
  189. data/spec/models/{project_member_spec.rb → vulnerability_summary_spec.rb} +10 -10
  190. data/spec/spec_helper.rb +1 -1
  191. metadata +204 -423
  192. data/docs/AdminJobSchedule.md +0 -9
  193. data/docs/AdminJobScheduleObj.md +0 -9
  194. data/docs/BadRequestFormatedError.md +0 -8
  195. data/docs/BoolConfigItem.md +0 -9
  196. data/docs/CVEWhitelist.md +0 -11
  197. data/docs/ChartAPIError.md +0 -8
  198. data/docs/ChartMetadata.md +0 -18
  199. data/docs/ChartRepositoryApi.md +0 -191
  200. data/docs/ChartVersion.md +0 -22
  201. data/docs/ComponentHealthStatus.md +0 -10
  202. data/docs/ComponentOverviewEntry.md +0 -9
  203. data/docs/Configurations.md +0 -42
  204. data/docs/ConfigurationsResponse.md +0 -41
  205. data/docs/ConfigurationsScanAllPolicy.md +0 -9
  206. data/docs/ConfigurationsScanAllPolicyParameter.md +0 -8
  207. data/docs/ConflictFormatedError.md +0 -8
  208. data/docs/EmailServerSetting.md +0 -13
  209. data/docs/Endpoint.md +0 -9
  210. data/docs/FilterStyle.md +0 -10
  211. data/docs/ForbiddenChartAPIError.md +0 -8
  212. data/docs/GCResult.md +0 -16
  213. data/docs/InputSecret.md +0 -8
  214. data/docs/InsufficientStorageChartAPIError.md +0 -8
  215. data/docs/IntegerConfigItem.md +0 -9
  216. data/docs/InternalChartAPIError.md +0 -8
  217. data/docs/IsDefault.md +0 -8
  218. data/docs/LabelApi.md +0 -191
  219. data/docs/LdapConf.md +0 -15
  220. data/docs/LdapFailedImportUsers.md +0 -9
  221. data/docs/LdapImportUsers.md +0 -8
  222. data/docs/LdapUsers.md +0 -10
  223. data/docs/Namespace.md +0 -9
  224. data/docs/NotFoundChartAPIError.md +0 -8
  225. data/docs/OverallHealthStatus.md +0 -9
  226. data/docs/Password.md +0 -9
  227. data/docs/PingRegistry.md +0 -14
  228. data/docs/ProductsApi.md +0 -6768
  229. data/docs/ProjectMember.md +0 -10
  230. data/docs/ProjectMemberEntity.md +0 -14
  231. data/docs/ProjectScanner.md +0 -8
  232. data/docs/PutRegistry.md +0 -14
  233. data/docs/Quota.md +0 -13
  234. data/docs/QuotaApi.md +0 -118
  235. data/docs/QuotaSwitcher.md +0 -8
  236. data/docs/QuotaUpdateReq.md +0 -8
  237. data/docs/RegistryInfo.md +0 -11
  238. data/docs/ReplicationFilter.md +0 -9
  239. data/docs/ReplicationPolicy.md +0 -20
  240. data/docs/ReplicationTrigger.md +0 -9
  241. data/docs/RetentionApi.md +0 -449
  242. data/docs/RetentionExecution.md +0 -14
  243. data/docs/RetentionExecutionTask.md +0 -18
  244. data/docs/RetentionMetadata.md +0 -10
  245. data/docs/RetentionPolicy.md +0 -12
  246. data/docs/RetentionPolicyScope.md +0 -9
  247. data/docs/RetentionRule.md +0 -15
  248. data/docs/RetentionRuleMetadata.md +0 -11
  249. data/docs/RetentionRuleParamMetadata.md +0 -10
  250. data/docs/RetentionRuleTrigger.md +0 -10
  251. data/docs/RetentionSelector.md +0 -11
  252. data/docs/RetentionSelectorMetadata.md +0 -10
  253. data/docs/RobotAccount.md +0 -15
  254. data/docs/RobotAccountAccess.md +0 -9
  255. data/docs/RobotAccountApi.md +0 -291
  256. data/docs/RobotAccountPostRep.md +0 -9
  257. data/docs/RobotAccountUpdate.md +0 -8
  258. data/docs/Role.md +0 -11
  259. data/docs/RoleParam.md +0 -9
  260. data/docs/RoleRequest.md +0 -8
  261. data/docs/Scanner.md +0 -10
  262. data/docs/ScannerAdapterMetadata.md +0 -10
  263. data/docs/ScannerCapability.md +0 -9
  264. data/docs/ScannerRegistration.md +0 -21
  265. data/docs/ScannerRegistrationReq.md +0 -15
  266. data/docs/ScannerRegistrationSettings.md +0 -11
  267. data/docs/ScannersApi.md +0 -600
  268. data/docs/Search.md +0 -10
  269. data/docs/SearchRepository.md +0 -13
  270. data/docs/SearchResult.md +0 -10
  271. data/docs/StatisticMap.md +0 -13
  272. data/docs/Stats.md +0 -11
  273. data/docs/StringConfigItem.md +0 -9
  274. data/docs/SupportedWebhookEventTypes.md +0 -9
  275. data/docs/SysAdminFlag.md +0 -8
  276. data/docs/SystemApi.md +0 -163
  277. data/docs/TriggerSettings.md +0 -8
  278. data/docs/UnauthorizedChartAPIError.md +0 -8
  279. data/docs/User.md +0 -22
  280. data/docs/UserEntity.md +0 -9
  281. data/docs/UserGroup.md +0 -11
  282. data/docs/UserProfile.md +0 -10
  283. data/docs/UserSearch.md +0 -9
  284. data/docs/WebhookJob.md +0 -15
  285. data/docs/WebhookLastTrigger.md +0 -11
  286. data/docs/WebhookPolicy.md +0 -17
  287. data/docs/WebhookTargetObject.md +0 -11
  288. data/lib/harbor_swagger_client/api/chart_repository_api.rb +0 -230
  289. data/lib/harbor_swagger_client/api/label_api.rb +0 -230
  290. data/lib/harbor_swagger_client/api/products_api.rb +0 -6879
  291. data/lib/harbor_swagger_client/api/quota_api.rb +0 -136
  292. data/lib/harbor_swagger_client/api/retention_api.rb +0 -482
  293. data/lib/harbor_swagger_client/api/robot_account_api.rb +0 -321
  294. data/lib/harbor_swagger_client/api/scanners_api.rb +0 -624
  295. data/lib/harbor_swagger_client/api/system_api.rb +0 -173
  296. data/lib/harbor_swagger_client/models/admin_job_schedule.rb +0 -195
  297. data/lib/harbor_swagger_client/models/admin_job_schedule_obj.rb +0 -194
  298. data/lib/harbor_swagger_client/models/bad_request_formated_error.rb +0 -190
  299. data/lib/harbor_swagger_client/models/bool_config_item.rb +0 -194
  300. data/lib/harbor_swagger_client/models/chart_api_error.rb +0 -190
  301. data/lib/harbor_swagger_client/models/chart_metadata.rb +0 -319
  302. data/lib/harbor_swagger_client/models/component_health_status.rb +0 -205
  303. data/lib/harbor_swagger_client/models/configurations.rb +0 -523
  304. data/lib/harbor_swagger_client/models/configurations_response.rb +0 -513
  305. data/lib/harbor_swagger_client/models/configurations_scan_all_policy_parameter.rb +0 -185
  306. data/lib/harbor_swagger_client/models/conflict_formated_error.rb +0 -190
  307. data/lib/harbor_swagger_client/models/filter_style.rb +0 -207
  308. data/lib/harbor_swagger_client/models/forbidden_chart_api_error.rb +0 -190
  309. data/lib/harbor_swagger_client/models/gc_result.rb +0 -263
  310. data/lib/harbor_swagger_client/models/insufficient_storage_chart_api_error.rb +0 -190
  311. data/lib/harbor_swagger_client/models/integer_config_item.rb +0 -194
  312. data/lib/harbor_swagger_client/models/internal_chart_api_error.rb +0 -190
  313. data/lib/harbor_swagger_client/models/is_default.rb +0 -184
  314. data/lib/harbor_swagger_client/models/ldap_conf.rb +0 -254
  315. data/lib/harbor_swagger_client/models/ldap_import_users.rb +0 -186
  316. data/lib/harbor_swagger_client/models/ldap_users.rb +0 -204
  317. data/lib/harbor_swagger_client/models/not_found_chart_api_error.rb +0 -190
  318. data/lib/harbor_swagger_client/models/overall_health_status.rb +0 -196
  319. data/lib/harbor_swagger_client/models/password.rb +0 -194
  320. data/lib/harbor_swagger_client/models/ping_registry.rb +0 -244
  321. data/lib/harbor_swagger_client/models/project_member.rb +0 -202
  322. data/lib/harbor_swagger_client/models/project_member_entity.rb +0 -244
  323. data/lib/harbor_swagger_client/models/project_scanner.rb +0 -184
  324. data/lib/harbor_swagger_client/models/quota_switcher.rb +0 -184
  325. data/lib/harbor_swagger_client/models/quota_update_req.rb +0 -184
  326. data/lib/harbor_swagger_client/models/registry_info.rb +0 -219
  327. data/lib/harbor_swagger_client/models/replication_filter.rb +0 -194
  328. data/lib/harbor_swagger_client/models/replication_trigger.rb +0 -193
  329. data/lib/harbor_swagger_client/models/retention_metadata.rb +0 -211
  330. data/lib/harbor_swagger_client/models/retention_policy_scope.rb +0 -192
  331. data/lib/harbor_swagger_client/models/retention_rule_metadata.rb +0 -217
  332. data/lib/harbor_swagger_client/models/retention_rule_param_metadata.rb +0 -202
  333. data/lib/harbor_swagger_client/models/retention_rule_trigger.rb +0 -201
  334. data/lib/harbor_swagger_client/models/retention_selector.rb +0 -210
  335. data/lib/harbor_swagger_client/models/retention_selector_metadata.rb +0 -204
  336. data/lib/harbor_swagger_client/models/robot_account_post_rep.rb +0 -194
  337. data/lib/harbor_swagger_client/models/robot_account_update.rb +0 -184
  338. data/lib/harbor_swagger_client/models/role.rb +0 -213
  339. data/lib/harbor_swagger_client/models/role_param.rb +0 -196
  340. data/lib/harbor_swagger_client/models/role_request.rb +0 -184
  341. data/lib/harbor_swagger_client/models/scanner_capability.rb +0 -196
  342. data/lib/harbor_swagger_client/models/scanner_registration.rb +0 -327
  343. data/lib/harbor_swagger_client/models/scanner_registration_req.rb +0 -262
  344. data/lib/harbor_swagger_client/models/scanner_registration_settings.rb +0 -216
  345. data/lib/harbor_swagger_client/models/search.rb +0 -210
  346. data/lib/harbor_swagger_client/models/search_repository.rb +0 -234
  347. data/lib/harbor_swagger_client/models/search_result.rb +0 -204
  348. data/lib/harbor_swagger_client/models/statistic_map.rb +0 -234
  349. data/lib/harbor_swagger_client/models/string_config_item.rb +0 -194
  350. data/lib/harbor_swagger_client/models/supported_webhook_event_types.rb +0 -197
  351. data/lib/harbor_swagger_client/models/sys_admin_flag.rb +0 -184
  352. data/lib/harbor_swagger_client/models/trigger_settings.rb +0 -184
  353. data/lib/harbor_swagger_client/models/unauthorized_chart_api_error.rb +0 -190
  354. data/lib/harbor_swagger_client/models/user.rb +0 -311
  355. data/lib/harbor_swagger_client/models/user_entity.rb +0 -194
  356. data/lib/harbor_swagger_client/models/user_group.rb +0 -214
  357. data/lib/harbor_swagger_client/models/user_profile.rb +0 -204
  358. data/lib/harbor_swagger_client/models/user_search.rb +0 -193
  359. data/lib/harbor_swagger_client/models/webhook_last_trigger.rb +0 -215
  360. data/lib/harbor_swagger_client/models/webhook_target_object.rb +0 -215
  361. data/spec/api/chart_repository_api_spec.rb +0 -79
  362. data/spec/api/label_api_spec.rb +0 -79
  363. data/spec/api/products_api_spec.rb +0 -1581
  364. data/spec/api/quota_api_spec.rb +0 -60
  365. data/spec/api/retention_api_spec.rb +0 -136
  366. data/spec/api/robot_account_api_spec.rb +0 -100
  367. data/spec/api/scanners_api_spec.rb +0 -169
  368. data/spec/api/system_api_spec.rb +0 -70
  369. data/spec/models/action_1_spec.rb +0 -41
  370. data/spec/models/admin_job_schedule_obj_spec.rb +0 -47
  371. data/spec/models/admin_job_schedule_spec.rb +0 -47
  372. data/spec/models/bad_request_formated_error_spec.rb +0 -41
  373. data/spec/models/chart_api_error_spec.rb +0 -41
  374. data/spec/models/component_health_status_spec.rb +0 -53
  375. data/spec/models/component_overview_entry_spec.rb +0 -47
  376. data/spec/models/configurations_response_spec.rb +0 -239
  377. data/spec/models/configurations_scan_all_policy_parameter_spec.rb +0 -41
  378. data/spec/models/configurations_scan_all_policy_spec.rb +0 -47
  379. data/spec/models/configurations_spec.rb +0 -245
  380. data/spec/models/conflict_formated_error_spec.rb +0 -41
  381. data/spec/models/cve_whitelist_spec.rb +0 -59
  382. data/spec/models/filter_style_spec.rb +0 -53
  383. data/spec/models/forbidden_chart_api_error_spec.rb +0 -41
  384. data/spec/models/insufficient_storage_chart_api_error_spec.rb +0 -41
  385. data/spec/models/integer_config_item_spec.rb +0 -47
  386. data/spec/models/internal_chart_api_error_spec.rb +0 -41
  387. data/spec/models/is_default_spec.rb +0 -41
  388. data/spec/models/ldap_failed_import_users_spec.rb +0 -47
  389. data/spec/models/ldap_import_users_spec.rb +0 -41
  390. data/spec/models/ldap_users_spec.rb +0 -53
  391. data/spec/models/not_found_chart_api_error_spec.rb +0 -41
  392. data/spec/models/overall_health_status_spec.rb +0 -47
  393. data/spec/models/project_member_entity_spec.rb +0 -77
  394. data/spec/models/project_scanner_spec.rb +0 -41
  395. data/spec/models/quota_switcher_spec.rb +0 -41
  396. data/spec/models/quota_update_req_spec.rb +0 -41
  397. data/spec/models/replication_filter_spec.rb +0 -47
  398. data/spec/models/replication_trigger_spec.rb +0 -47
  399. data/spec/models/retention_execution_spec.rb +0 -77
  400. data/spec/models/retention_metadata_spec.rb +0 -53
  401. data/spec/models/retention_policy_scope_spec.rb +0 -47
  402. data/spec/models/retention_rule_metadata_spec.rb +0 -59
  403. data/spec/models/retention_rule_param_metadata_spec.rb +0 -53
  404. data/spec/models/retention_rule_spec.rb +0 -83
  405. data/spec/models/retention_rule_trigger_spec.rb +0 -53
  406. data/spec/models/retention_selector_metadata_spec.rb +0 -53
  407. data/spec/models/retention_selector_spec.rb +0 -59
  408. data/spec/models/robot_account_access_spec.rb +0 -47
  409. data/spec/models/robot_account_post_rep_spec.rb +0 -47
  410. data/spec/models/robot_account_update_spec.rb +0 -41
  411. data/spec/models/role_param_spec.rb +0 -47
  412. data/spec/models/role_request_spec.rb +0 -41
  413. data/spec/models/role_spec.rb +0 -59
  414. data/spec/models/scanner_adapter_metadata_spec.rb +0 -53
  415. data/spec/models/scanner_capability_spec.rb +0 -47
  416. data/spec/models/scanner_registration_req_spec.rb +0 -83
  417. data/spec/models/scanner_registration_settings_spec.rb +0 -59
  418. data/spec/models/scanner_registration_spec.rb +0 -119
  419. data/spec/models/scanner_spec.rb +0 -53
  420. data/spec/models/search_result_spec.rb +0 -53
  421. data/spec/models/stats_spec.rb +0 -59
  422. data/spec/models/string_config_item_spec.rb +0 -47
  423. data/spec/models/supported_webhook_event_types_spec.rb +0 -47
  424. data/spec/models/sys_admin_flag_spec.rb +0 -41
  425. data/spec/models/trigger_settings_spec.rb +0 -41
  426. data/spec/models/user_entity_spec.rb +0 -47
  427. data/spec/models/user_group_spec.rb +0 -59
  428. data/spec/models/user_profile_spec.rb +0 -53
  429. data/spec/models/user_search_spec.rb +0 -47
  430. data/spec/models/user_spec.rb +0 -125
  431. data/spec/models/webhook_last_trigger_spec.rb +0 -59
  432. data/spec/models/webhook_target_object_spec.rb +0 -59
@@ -1,9 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,8 +0,0 @@
1
- # SwaggerClient::RobotAccountUpdate
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **disabled** | **BOOLEAN** | The robot account is disable or enable | [optional]
7
-
8
-
@@ -1,11 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,9 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,8 +0,0 @@
1
- # SwaggerClient::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 master | [optional]
7
-
8
-
@@ -1,10 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,10 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,9 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,21 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,15 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,11 +0,0 @@
1
- # SwaggerClient::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
-
@@ -1,600 +0,0 @@
1
- # SwaggerClient::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 'harbor_swagger_client'
31
- # setup authorization
32
- SwaggerClient.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 = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
84
- # setup authorization
85
- SwaggerClient.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 = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
137
- # setup authorization
138
- SwaggerClient.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 = SwaggerClient::ScannersApi.new
145
-
146
- project_id = 789 # Integer | The project identifier.
147
-
148
- payload = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
192
- # setup authorization
193
- SwaggerClient.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 = SwaggerClient::ScannersApi.new
200
-
201
- begin
202
- #List scanner registrations
203
- result = api_instance.scanners_get
204
- p result
205
- rescue SwaggerClient::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 'harbor_swagger_client'
239
- # setup authorization
240
- SwaggerClient.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 = SwaggerClient::ScannersApi.new
247
-
248
- settings = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
291
- # setup authorization
292
- SwaggerClient.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 = SwaggerClient::ScannersApi.new
299
-
300
- registration = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
343
- # setup authorization
344
- SwaggerClient.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 = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
396
- # setup authorization
397
- SwaggerClient.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 = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
449
- # setup authorization
450
- SwaggerClient.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 = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
502
- # setup authorization
503
- SwaggerClient.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 = SwaggerClient::ScannersApi.new
510
-
511
- registration_id = 'registration_id_example' # String | The scanner registration identifier.
512
-
513
- payload = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
557
- # setup authorization
558
- SwaggerClient.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 = SwaggerClient::ScannersApi.new
565
-
566
- registration_id = 'registration_id_example' # String | The scanner registration identifier.
567
-
568
- registration = SwaggerClient::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 SwaggerClient::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
-