harbor_swagger_client 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (622) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +49 -7
  3. data/docs/ChartRepositoryApi.md +2 -2
  4. data/docs/Configurations.md +6 -0
  5. data/docs/ConfigurationsResponse.md +5 -0
  6. data/docs/DetailedTag.md +1 -1
  7. data/docs/ImmutableTagRule.md +11 -0
  8. data/docs/InlineResponse200.md +1 -1
  9. data/docs/InputSecret.md +8 -0
  10. data/docs/IsDefault.md +8 -0
  11. data/docs/NativeReportSummary.md +14 -0
  12. data/docs/ProductsApi.md +904 -90
  13. data/docs/Project.md +2 -1
  14. data/docs/ProjectMetadata.md +1 -1
  15. data/docs/ProjectScanner.md +8 -0
  16. data/docs/QuotaApi.md +0 -61
  17. data/docs/Report.md +11 -0
  18. data/docs/RetentionPolicy.md +2 -2
  19. data/docs/ScanApi.md +281 -0
  20. data/docs/ScanOverview.md +7 -0
  21. data/docs/Scanner.md +10 -0
  22. data/docs/ScannerAdapterMetadata.md +10 -0
  23. data/docs/ScannerCapability.md +9 -0
  24. data/docs/ScannerRegistration.md +21 -0
  25. data/docs/ScannerRegistrationReq.md +15 -0
  26. data/docs/ScannerRegistrationSettings.md +11 -0
  27. data/docs/ScannersApi.md +600 -0
  28. data/docs/Stats.md +11 -0
  29. data/docs/VulnerabilityItem.md +7 -6
  30. data/docs/VulnerabilitySummary.md +10 -0
  31. data/harbor_swagger_client.gemspec +1 -1
  32. data/lib/harbor_swagger_client.rb +18 -4
  33. data/lib/harbor_swagger_client/api/chart_repository_api.rb +4 -4
  34. data/lib/harbor_swagger_client/api/label_api.rb +1 -1
  35. data/lib/harbor_swagger_client/api/products_api.rb +888 -63
  36. data/lib/harbor_swagger_client/api/quota_api.rb +1 -61
  37. data/lib/harbor_swagger_client/api/retention_api.rb +1 -1
  38. data/lib/harbor_swagger_client/api/robot_account_api.rb +1 -1
  39. data/lib/harbor_swagger_client/api/scan_api.rb +307 -0
  40. data/lib/harbor_swagger_client/api/scanners_api.rb +624 -0
  41. data/lib/harbor_swagger_client/api/system_api.rb +1 -1
  42. data/lib/harbor_swagger_client/api_client.rb +1 -1
  43. data/lib/harbor_swagger_client/api_error.rb +1 -1
  44. data/lib/harbor_swagger_client/configuration.rb +1 -1
  45. data/lib/harbor_swagger_client/models/access_log.rb +1 -1
  46. data/lib/harbor_swagger_client/models/action.rb +1 -1
  47. data/lib/harbor_swagger_client/models/action_1.rb +1 -1
  48. data/lib/harbor_swagger_client/models/admin_job_schedule.rb +1 -1
  49. data/lib/harbor_swagger_client/models/admin_job_schedule_obj.rb +1 -1
  50. data/lib/harbor_swagger_client/models/bad_request_formated_error.rb +1 -1
  51. data/lib/harbor_swagger_client/models/bool_config_item.rb +1 -1
  52. data/lib/harbor_swagger_client/models/chart_api_error.rb +1 -1
  53. data/lib/harbor_swagger_client/models/chart_info_entry.rb +1 -1
  54. data/lib/harbor_swagger_client/models/chart_info_list.rb +1 -1
  55. data/lib/harbor_swagger_client/models/chart_metadata.rb +1 -1
  56. data/lib/harbor_swagger_client/models/chart_version.rb +1 -1
  57. data/lib/harbor_swagger_client/models/chart_version_details.rb +1 -1
  58. data/lib/harbor_swagger_client/models/chart_versions.rb +1 -1
  59. data/lib/harbor_swagger_client/models/component_health_status.rb +1 -1
  60. data/lib/harbor_swagger_client/models/component_overview_entry.rb +1 -1
  61. data/lib/harbor_swagger_client/models/configurations.rb +62 -2
  62. data/lib/harbor_swagger_client/models/configurations_response.rb +52 -2
  63. data/lib/harbor_swagger_client/models/configurations_scan_all_policy.rb +1 -1
  64. data/lib/harbor_swagger_client/models/configurations_scan_all_policy_parameter.rb +1 -1
  65. data/lib/harbor_swagger_client/models/conflict_formated_error.rb +1 -1
  66. data/lib/harbor_swagger_client/models/cve_whitelist.rb +1 -1
  67. data/lib/harbor_swagger_client/models/cve_whitelist_item.rb +1 -1
  68. data/lib/harbor_swagger_client/models/dependency.rb +1 -1
  69. data/lib/harbor_swagger_client/models/detailed_tag.rb +3 -2
  70. data/lib/harbor_swagger_client/models/digital_signature.rb +1 -1
  71. data/lib/harbor_swagger_client/models/email_server_setting.rb +1 -1
  72. data/lib/harbor_swagger_client/models/endpoint.rb +1 -1
  73. data/lib/harbor_swagger_client/models/filter_style.rb +1 -1
  74. data/lib/harbor_swagger_client/models/forbidden_chart_api_error.rb +1 -1
  75. data/lib/harbor_swagger_client/models/gc_result.rb +1 -1
  76. data/lib/harbor_swagger_client/models/general_info.rb +1 -1
  77. data/lib/harbor_swagger_client/models/general_info_clair_vulnerability_status.rb +1 -1
  78. data/lib/harbor_swagger_client/models/has_admin_role.rb +1 -1
  79. data/lib/harbor_swagger_client/models/immutable_tag_rule.rb +210 -0
  80. data/lib/harbor_swagger_client/models/inline_response_200.rb +8 -9
  81. data/lib/harbor_swagger_client/models/input_secret.rb +184 -0
  82. data/lib/harbor_swagger_client/models/insufficient_storage_chart_api_error.rb +1 -1
  83. data/lib/harbor_swagger_client/models/integer_config_item.rb +1 -1
  84. data/lib/harbor_swagger_client/models/internal_chart_api_error.rb +1 -1
  85. data/lib/harbor_swagger_client/models/is_default.rb +184 -0
  86. data/lib/harbor_swagger_client/models/job_status.rb +1 -1
  87. data/lib/harbor_swagger_client/models/label.rb +1 -1
  88. data/lib/harbor_swagger_client/models/labels.rb +1 -1
  89. data/lib/harbor_swagger_client/models/ldap_conf.rb +1 -1
  90. data/lib/harbor_swagger_client/models/ldap_failed_import_users.rb +1 -1
  91. data/lib/harbor_swagger_client/models/ldap_import_users.rb +1 -1
  92. data/lib/harbor_swagger_client/models/ldap_users.rb +1 -1
  93. data/lib/harbor_swagger_client/models/manifest.rb +1 -1
  94. data/lib/harbor_swagger_client/models/namespace.rb +1 -1
  95. data/lib/harbor_swagger_client/models/native_report_summary.rb +244 -0
  96. data/lib/harbor_swagger_client/models/not_found_chart_api_error.rb +1 -1
  97. data/lib/harbor_swagger_client/models/overall_health_status.rb +1 -1
  98. data/lib/harbor_swagger_client/models/password.rb +1 -1
  99. data/lib/harbor_swagger_client/models/permission.rb +1 -1
  100. data/lib/harbor_swagger_client/models/ping_registry.rb +1 -1
  101. data/lib/harbor_swagger_client/models/project.rb +15 -3
  102. data/lib/harbor_swagger_client/models/project_member.rb +1 -1
  103. data/lib/harbor_swagger_client/models/project_member_entity.rb +1 -1
  104. data/lib/harbor_swagger_client/models/project_metadata.rb +2 -2
  105. data/lib/harbor_swagger_client/models/project_req.rb +1 -1
  106. data/lib/harbor_swagger_client/models/project_scanner.rb +184 -0
  107. data/lib/harbor_swagger_client/models/project_summary.rb +1 -1
  108. data/lib/harbor_swagger_client/models/project_summary_quota.rb +1 -1
  109. data/lib/harbor_swagger_client/models/put_registry.rb +1 -1
  110. data/lib/harbor_swagger_client/models/quota.rb +1 -1
  111. data/lib/harbor_swagger_client/models/quota_ref_object.rb +1 -1
  112. data/lib/harbor_swagger_client/models/quota_switcher.rb +1 -1
  113. data/lib/harbor_swagger_client/models/quota_update_req.rb +1 -1
  114. data/lib/harbor_swagger_client/models/registry.rb +1 -1
  115. data/lib/harbor_swagger_client/models/registry_credential.rb +1 -1
  116. data/lib/harbor_swagger_client/models/registry_info.rb +1 -1
  117. data/lib/harbor_swagger_client/models/replication_execution.rb +1 -1
  118. data/lib/harbor_swagger_client/models/replication_filter.rb +1 -1
  119. data/lib/harbor_swagger_client/models/replication_policy.rb +1 -1
  120. data/lib/harbor_swagger_client/models/replication_task.rb +1 -1
  121. data/lib/harbor_swagger_client/models/replication_trigger.rb +1 -1
  122. data/lib/harbor_swagger_client/models/repo_signature.rb +1 -1
  123. data/lib/harbor_swagger_client/models/report.rb +215 -0
  124. data/lib/harbor_swagger_client/models/repository.rb +1 -1
  125. data/lib/harbor_swagger_client/models/repository_description.rb +1 -1
  126. data/lib/harbor_swagger_client/models/resource.rb +1 -1
  127. data/lib/harbor_swagger_client/models/resource_list.rb +1 -1
  128. data/lib/harbor_swagger_client/models/retag_req.rb +1 -1
  129. data/lib/harbor_swagger_client/models/retention_execution.rb +1 -1
  130. data/lib/harbor_swagger_client/models/retention_execution_task.rb +1 -1
  131. data/lib/harbor_swagger_client/models/retention_metadata.rb +1 -1
  132. data/lib/harbor_swagger_client/models/retention_policy.rb +3 -3
  133. data/lib/harbor_swagger_client/models/retention_policy_scope.rb +1 -1
  134. data/lib/harbor_swagger_client/models/retention_rule.rb +1 -1
  135. data/lib/harbor_swagger_client/models/retention_rule_metadata.rb +1 -1
  136. data/lib/harbor_swagger_client/models/retention_rule_param_metadata.rb +1 -1
  137. data/lib/harbor_swagger_client/models/retention_rule_trigger.rb +1 -1
  138. data/lib/harbor_swagger_client/models/retention_selector.rb +1 -1
  139. data/lib/harbor_swagger_client/models/retention_selector_metadata.rb +1 -1
  140. data/lib/harbor_swagger_client/models/robot_account.rb +1 -1
  141. data/lib/harbor_swagger_client/models/robot_account_access.rb +1 -1
  142. data/lib/harbor_swagger_client/models/robot_account_create.rb +1 -1
  143. data/lib/harbor_swagger_client/models/robot_account_post_rep.rb +1 -1
  144. data/lib/harbor_swagger_client/models/robot_account_update.rb +1 -1
  145. data/lib/harbor_swagger_client/models/role.rb +1 -1
  146. data/lib/harbor_swagger_client/models/role_param.rb +1 -1
  147. data/lib/harbor_swagger_client/models/role_request.rb +1 -1
  148. data/lib/harbor_swagger_client/models/scan_overview.rb +175 -0
  149. data/lib/harbor_swagger_client/models/scanner.rb +204 -0
  150. data/lib/harbor_swagger_client/models/scanner_adapter_metadata.rb +206 -0
  151. data/lib/harbor_swagger_client/models/scanner_capability.rb +196 -0
  152. data/lib/harbor_swagger_client/models/scanner_registration.rb +327 -0
  153. data/lib/harbor_swagger_client/models/scanner_registration_req.rb +262 -0
  154. data/lib/harbor_swagger_client/models/scanner_registration_settings.rb +216 -0
  155. data/lib/harbor_swagger_client/models/search.rb +1 -1
  156. data/lib/harbor_swagger_client/models/search_repository.rb +1 -1
  157. data/lib/harbor_swagger_client/models/search_result.rb +1 -1
  158. data/lib/harbor_swagger_client/models/security_report.rb +1 -1
  159. data/lib/harbor_swagger_client/models/statistic_map.rb +1 -1
  160. data/lib/harbor_swagger_client/models/stats.rb +217 -0
  161. data/lib/harbor_swagger_client/models/storage.rb +1 -1
  162. data/lib/harbor_swagger_client/models/string_config_item.rb +1 -1
  163. data/lib/harbor_swagger_client/models/system_info.rb +1 -1
  164. data/lib/harbor_swagger_client/models/tags.rb +1 -1
  165. data/lib/harbor_swagger_client/models/trigger_settings.rb +1 -1
  166. data/lib/harbor_swagger_client/models/unauthorized_chart_api_error.rb +1 -1
  167. data/lib/harbor_swagger_client/models/user.rb +1 -1
  168. data/lib/harbor_swagger_client/models/user_entity.rb +1 -1
  169. data/lib/harbor_swagger_client/models/user_group.rb +1 -1
  170. data/lib/harbor_swagger_client/models/user_profile.rb +1 -1
  171. data/lib/harbor_swagger_client/models/user_search.rb +1 -1
  172. data/lib/harbor_swagger_client/models/vuln_namespace_timestamp.rb +1 -1
  173. data/lib/harbor_swagger_client/models/vulnerability_item.rb +35 -23
  174. data/lib/harbor_swagger_client/models/vulnerability_summary.rb +207 -0
  175. data/lib/harbor_swagger_client/models/webhook_job.rb +1 -1
  176. data/lib/harbor_swagger_client/models/webhook_last_trigger.rb +1 -1
  177. data/lib/harbor_swagger_client/models/webhook_policy.rb +1 -1
  178. data/lib/harbor_swagger_client/models/webhook_target_object.rb +1 -1
  179. data/lib/harbor_swagger_client/version.rb +2 -2
  180. data/spec/Gemfile +7 -0
  181. data/spec/README.md +438 -0
  182. data/spec/Rakefile +8 -0
  183. data/spec/api/chart_repository_api_spec.rb +2 -2
  184. data/spec/api/label_api_spec.rb +1 -1
  185. data/spec/api/products_api_spec.rb +205 -19
  186. data/spec/api/quota_api_spec.rb +1 -16
  187. data/spec/api/retention_api_spec.rb +1 -1
  188. data/spec/api/robot_account_api_spec.rb +1 -1
  189. data/spec/api/scan_api_spec.rb +98 -0
  190. data/spec/api/scanners_api_spec.rb +169 -0
  191. data/spec/api/system_api_spec.rb +1 -1
  192. data/spec/api_client_spec.rb +1 -1
  193. data/spec/configuration_spec.rb +1 -1
  194. data/spec/docs/AccessLog.md +13 -0
  195. data/spec/docs/Action.md +8 -0
  196. data/spec/docs/Action1.md +8 -0
  197. data/spec/docs/AdminJobSchedule.md +8 -0
  198. data/spec/docs/AdminJobScheduleObj.md +9 -0
  199. data/spec/docs/BadRequestFormatedError.md +8 -0
  200. data/spec/docs/BoolConfigItem.md +9 -0
  201. data/spec/docs/CVEWhitelist.md +11 -0
  202. data/spec/docs/CVEWhitelistItem.md +8 -0
  203. data/spec/docs/ChartAPIError.md +8 -0
  204. data/spec/docs/ChartInfoEntry.md +15 -0
  205. data/spec/docs/ChartInfoList.md +7 -0
  206. data/spec/docs/ChartMetadata.md +18 -0
  207. data/spec/docs/ChartRepositoryApi.md +698 -0
  208. data/spec/docs/ChartVersion.md +22 -0
  209. data/spec/docs/ChartVersionDetails.md +13 -0
  210. data/spec/docs/ChartVersions.md +7 -0
  211. data/spec/docs/ComponentHealthStatus.md +10 -0
  212. data/spec/docs/ComponentOverviewEntry.md +9 -0
  213. data/spec/docs/Configurations.md +42 -0
  214. data/spec/docs/ConfigurationsResponse.md +41 -0
  215. data/spec/docs/ConfigurationsScanAllPolicy.md +9 -0
  216. data/spec/docs/ConfigurationsScanAllPolicyParameter.md +8 -0
  217. data/spec/docs/ConflictFormatedError.md +8 -0
  218. data/spec/docs/Dependency.md +10 -0
  219. data/spec/docs/DetailedTag.md +18 -0
  220. data/spec/docs/DigitalSignature.md +9 -0
  221. data/spec/docs/EmailServerSetting.md +13 -0
  222. data/spec/docs/Endpoint.md +9 -0
  223. data/spec/docs/FilterStyle.md +10 -0
  224. data/spec/docs/ForbiddenChartAPIError.md +8 -0
  225. data/spec/docs/GCResult.md +15 -0
  226. data/spec/docs/GeneralInfo.md +20 -0
  227. data/spec/docs/GeneralInfoClairVulnerabilityStatus.md +9 -0
  228. data/spec/docs/HasAdminRole.md +8 -0
  229. data/spec/docs/ImmutableTagRule.md +11 -0
  230. data/spec/docs/InlineResponse200.md +8 -0
  231. data/spec/docs/InputSecret.md +8 -0
  232. data/spec/docs/InsufficientStorageChartAPIError.md +8 -0
  233. data/spec/docs/IntegerConfigItem.md +9 -0
  234. data/spec/docs/InternalChartAPIError.md +8 -0
  235. data/spec/docs/IsDefault.md +8 -0
  236. data/spec/docs/JobStatus.md +15 -0
  237. data/spec/docs/Label.md +16 -0
  238. data/spec/docs/LabelApi.md +191 -0
  239. data/spec/docs/Labels.md +7 -0
  240. data/spec/docs/LdapConf.md +15 -0
  241. data/spec/docs/LdapFailedImportUsers.md +9 -0
  242. data/spec/docs/LdapImportUsers.md +8 -0
  243. data/spec/docs/LdapUsers.md +10 -0
  244. data/spec/docs/Manifest.md +9 -0
  245. data/spec/docs/Namespace.md +9 -0
  246. data/spec/docs/NativeReportSummary.md +14 -0
  247. data/spec/docs/NotFoundChartAPIError.md +8 -0
  248. data/spec/docs/OverallHealthStatus.md +9 -0
  249. data/spec/docs/Password.md +9 -0
  250. data/spec/docs/Permission.md +9 -0
  251. data/spec/docs/PingRegistry.md +14 -0
  252. data/spec/docs/ProductsApi.md +8594 -0
  253. data/spec/docs/Project.md +21 -0
  254. data/spec/docs/ProjectMember.md +10 -0
  255. data/spec/docs/ProjectMemberEntity.md +14 -0
  256. data/spec/docs/ProjectMetadata.md +13 -0
  257. data/spec/docs/ProjectReq.md +12 -0
  258. data/spec/docs/ProjectScanner.md +8 -0
  259. data/spec/docs/ProjectSummary.md +14 -0
  260. data/spec/docs/ProjectSummaryQuota.md +9 -0
  261. data/spec/docs/PutRegistry.md +14 -0
  262. data/spec/docs/Quota.md +13 -0
  263. data/spec/docs/QuotaApi.md +118 -0
  264. data/spec/docs/QuotaRefObject.md +7 -0
  265. data/spec/docs/QuotaSwitcher.md +8 -0
  266. data/spec/docs/QuotaUpdateReq.md +8 -0
  267. data/spec/docs/Registry.md +17 -0
  268. data/spec/docs/RegistryCredential.md +10 -0
  269. data/spec/docs/RegistryInfo.md +11 -0
  270. data/spec/docs/ReplicationExecution.md +19 -0
  271. data/spec/docs/ReplicationFilter.md +9 -0
  272. data/spec/docs/ReplicationPolicy.md +20 -0
  273. data/spec/docs/ReplicationTask.md +16 -0
  274. data/spec/docs/ReplicationTrigger.md +9 -0
  275. data/spec/docs/RepoSignature.md +9 -0
  276. data/spec/docs/Report.md +11 -0
  277. data/spec/docs/Repository.md +17 -0
  278. data/spec/docs/RepositoryDescription.md +8 -0
  279. data/spec/docs/Resource.md +8 -0
  280. data/spec/docs/ResourceList.md +7 -0
  281. data/spec/docs/RetagReq.md +10 -0
  282. data/spec/docs/RetentionApi.md +449 -0
  283. data/spec/docs/RetentionExecution.md +14 -0
  284. data/spec/docs/RetentionExecutionTask.md +18 -0
  285. data/spec/docs/RetentionMetadata.md +10 -0
  286. data/spec/docs/RetentionPolicy.md +12 -0
  287. data/spec/docs/RetentionPolicyScope.md +9 -0
  288. data/spec/docs/RetentionRule.md +15 -0
  289. data/spec/docs/RetentionRuleMetadata.md +11 -0
  290. data/spec/docs/RetentionRuleParamMetadata.md +10 -0
  291. data/spec/docs/RetentionRuleTrigger.md +10 -0
  292. data/spec/docs/RetentionSelector.md +10 -0
  293. data/spec/docs/RetentionSelectorMetadata.md +10 -0
  294. data/spec/docs/RobotAccount.md +15 -0
  295. data/spec/docs/RobotAccountAccess.md +9 -0
  296. data/spec/docs/RobotAccountApi.md +291 -0
  297. data/spec/docs/RobotAccountCreate.md +10 -0
  298. data/spec/docs/RobotAccountPostRep.md +9 -0
  299. data/spec/docs/RobotAccountUpdate.md +8 -0
  300. data/spec/docs/Role.md +11 -0
  301. data/spec/docs/RoleParam.md +9 -0
  302. data/spec/docs/RoleRequest.md +8 -0
  303. data/spec/docs/ScanApi.md +281 -0
  304. data/spec/docs/ScanOverview.md +7 -0
  305. data/spec/docs/Scanner.md +10 -0
  306. data/spec/docs/ScannerAdapterMetadata.md +10 -0
  307. data/spec/docs/ScannerCapability.md +9 -0
  308. data/spec/docs/ScannerRegistration.md +21 -0
  309. data/spec/docs/ScannerRegistrationReq.md +15 -0
  310. data/spec/docs/ScannerRegistrationSettings.md +11 -0
  311. data/spec/docs/ScannersApi.md +600 -0
  312. data/spec/docs/Search.md +10 -0
  313. data/spec/docs/SearchRepository.md +13 -0
  314. data/spec/docs/SearchResult.md +10 -0
  315. data/spec/docs/SecurityReport.md +8 -0
  316. data/spec/docs/StatisticMap.md +13 -0
  317. data/spec/docs/Stats.md +11 -0
  318. data/spec/docs/Storage.md +9 -0
  319. data/spec/docs/StringConfigItem.md +9 -0
  320. data/spec/docs/SystemApi.md +163 -0
  321. data/spec/docs/SystemInfo.md +8 -0
  322. data/spec/docs/Tags.md +8 -0
  323. data/spec/docs/TriggerSettings.md +8 -0
  324. data/spec/docs/UnauthorizedChartAPIError.md +8 -0
  325. data/spec/docs/User.md +21 -0
  326. data/spec/docs/UserEntity.md +9 -0
  327. data/spec/docs/UserGroup.md +11 -0
  328. data/spec/docs/UserProfile.md +10 -0
  329. data/spec/docs/UserSearch.md +9 -0
  330. data/spec/docs/VulnNamespaceTimestamp.md +9 -0
  331. data/spec/docs/VulnerabilityItem.md +14 -0
  332. data/spec/docs/VulnerabilitySummary.md +10 -0
  333. data/spec/docs/WebhookJob.md +15 -0
  334. data/spec/docs/WebhookLastTrigger.md +11 -0
  335. data/spec/docs/WebhookPolicy.md +17 -0
  336. data/spec/docs/WebhookTargetObject.md +11 -0
  337. data/spec/git_push.sh +55 -0
  338. data/spec/harbor_swagger_client.gemspec +45 -0
  339. data/spec/lib/harbor_swagger_client.rb +182 -0
  340. data/spec/lib/harbor_swagger_client/api/chart_repository_api.rb +762 -0
  341. data/spec/lib/harbor_swagger_client/api/label_api.rb +230 -0
  342. data/spec/lib/harbor_swagger_client/api/products_api.rb +8783 -0
  343. data/spec/lib/harbor_swagger_client/api/quota_api.rb +136 -0
  344. data/spec/lib/harbor_swagger_client/api/retention_api.rb +482 -0
  345. data/spec/lib/harbor_swagger_client/api/robot_account_api.rb +321 -0
  346. data/spec/lib/harbor_swagger_client/api/scan_api.rb +307 -0
  347. data/spec/lib/harbor_swagger_client/api/scanners_api.rb +624 -0
  348. data/spec/lib/harbor_swagger_client/api/system_api.rb +173 -0
  349. data/spec/lib/harbor_swagger_client/api_client.rb +389 -0
  350. data/spec/lib/harbor_swagger_client/api_error.rb +38 -0
  351. data/spec/lib/harbor_swagger_client/configuration.rb +209 -0
  352. data/spec/lib/harbor_swagger_client/models/access_log.rb +234 -0
  353. data/spec/lib/harbor_swagger_client/models/action.rb +183 -0
  354. data/spec/lib/harbor_swagger_client/models/action_1.rb +183 -0
  355. data/spec/lib/harbor_swagger_client/models/admin_job_schedule.rb +183 -0
  356. data/spec/lib/harbor_swagger_client/models/admin_job_schedule_obj.rb +194 -0
  357. data/spec/lib/harbor_swagger_client/models/bad_request_formated_error.rb +190 -0
  358. data/spec/lib/harbor_swagger_client/models/bool_config_item.rb +194 -0
  359. data/spec/lib/harbor_swagger_client/models/chart_api_error.rb +190 -0
  360. data/spec/lib/harbor_swagger_client/models/chart_info_entry.rb +270 -0
  361. data/spec/lib/harbor_swagger_client/models/chart_info_list.rb +175 -0
  362. data/spec/lib/harbor_swagger_client/models/chart_metadata.rb +319 -0
  363. data/spec/lib/harbor_swagger_client/models/chart_version.rb +361 -0
  364. data/spec/lib/harbor_swagger_client/models/chart_version_details.rb +235 -0
  365. data/spec/lib/harbor_swagger_client/models/chart_versions.rb +175 -0
  366. data/spec/lib/harbor_swagger_client/models/component_health_status.rb +205 -0
  367. data/spec/lib/harbor_swagger_client/models/component_overview_entry.rb +194 -0
  368. data/spec/lib/harbor_swagger_client/models/configurations.rb +523 -0
  369. data/spec/lib/harbor_swagger_client/models/configurations_response.rb +513 -0
  370. data/spec/lib/harbor_swagger_client/models/configurations_scan_all_policy.rb +193 -0
  371. data/spec/lib/harbor_swagger_client/models/configurations_scan_all_policy_parameter.rb +185 -0
  372. data/spec/lib/harbor_swagger_client/models/conflict_formated_error.rb +190 -0
  373. data/spec/lib/harbor_swagger_client/models/cve_whitelist.rb +216 -0
  374. data/spec/lib/harbor_swagger_client/models/cve_whitelist_item.rb +185 -0
  375. data/spec/lib/harbor_swagger_client/models/dependency.rb +215 -0
  376. data/spec/lib/harbor_swagger_client/models/detailed_tag.rb +286 -0
  377. data/spec/lib/harbor_swagger_client/models/digital_signature.rb +195 -0
  378. data/spec/lib/harbor_swagger_client/models/email_server_setting.rb +234 -0
  379. data/spec/lib/harbor_swagger_client/models/endpoint.rb +194 -0
  380. data/spec/lib/harbor_swagger_client/models/filter_style.rb +207 -0
  381. data/spec/lib/harbor_swagger_client/models/forbidden_chart_api_error.rb +190 -0
  382. data/spec/lib/harbor_swagger_client/models/gc_result.rb +253 -0
  383. data/spec/lib/harbor_swagger_client/models/general_info.rb +303 -0
  384. data/spec/lib/harbor_swagger_client/models/general_info_clair_vulnerability_status.rb +197 -0
  385. data/spec/lib/harbor_swagger_client/models/has_admin_role.rb +184 -0
  386. data/spec/lib/harbor_swagger_client/models/immutable_tag_rule.rb +210 -0
  387. data/spec/lib/harbor_swagger_client/models/inline_response_200.rb +183 -0
  388. data/spec/lib/harbor_swagger_client/models/input_secret.rb +184 -0
  389. data/spec/lib/harbor_swagger_client/models/insufficient_storage_chart_api_error.rb +190 -0
  390. data/spec/lib/harbor_swagger_client/models/integer_config_item.rb +194 -0
  391. data/spec/lib/harbor_swagger_client/models/internal_chart_api_error.rb +190 -0
  392. data/spec/lib/harbor_swagger_client/models/is_default.rb +184 -0
  393. data/spec/lib/harbor_swagger_client/models/job_status.rb +256 -0
  394. data/spec/lib/harbor_swagger_client/models/label.rb +264 -0
  395. data/spec/lib/harbor_swagger_client/models/labels.rb +175 -0
  396. data/spec/lib/harbor_swagger_client/models/ldap_conf.rb +254 -0
  397. data/spec/lib/harbor_swagger_client/models/ldap_failed_import_users.rb +194 -0
  398. data/spec/lib/harbor_swagger_client/models/ldap_import_users.rb +186 -0
  399. data/spec/lib/harbor_swagger_client/models/ldap_users.rb +204 -0
  400. data/spec/lib/harbor_swagger_client/models/manifest.rb +194 -0
  401. data/spec/lib/harbor_swagger_client/models/namespace.rb +195 -0
  402. data/spec/lib/harbor_swagger_client/models/native_report_summary.rb +244 -0
  403. data/spec/lib/harbor_swagger_client/models/not_found_chart_api_error.rb +190 -0
  404. data/spec/lib/harbor_swagger_client/models/overall_health_status.rb +196 -0
  405. data/spec/lib/harbor_swagger_client/models/password.rb +194 -0
  406. data/spec/lib/harbor_swagger_client/models/permission.rb +195 -0
  407. data/spec/lib/harbor_swagger_client/models/ping_registry.rb +244 -0
  408. data/spec/lib/harbor_swagger_client/models/project.rb +316 -0
  409. data/spec/lib/harbor_swagger_client/models/project_member.rb +202 -0
  410. data/spec/lib/harbor_swagger_client/models/project_member_entity.rb +244 -0
  411. data/spec/lib/harbor_swagger_client/models/project_metadata.rb +234 -0
  412. data/spec/lib/harbor_swagger_client/models/project_req.rb +224 -0
  413. data/spec/lib/harbor_swagger_client/models/project_scanner.rb +184 -0
  414. data/spec/lib/harbor_swagger_client/models/project_summary.rb +243 -0
  415. data/spec/lib/harbor_swagger_client/models/project_summary_quota.rb +194 -0
  416. data/spec/lib/harbor_swagger_client/models/put_registry.rb +244 -0
  417. data/spec/lib/harbor_swagger_client/models/quota.rb +235 -0
  418. data/spec/lib/harbor_swagger_client/models/quota_ref_object.rb +174 -0
  419. data/spec/lib/harbor_swagger_client/models/quota_switcher.rb +184 -0
  420. data/spec/lib/harbor_swagger_client/models/quota_update_req.rb +184 -0
  421. data/spec/lib/harbor_swagger_client/models/registry.rb +273 -0
  422. data/spec/lib/harbor_swagger_client/models/registry_credential.rb +204 -0
  423. data/spec/lib/harbor_swagger_client/models/registry_info.rb +219 -0
  424. data/spec/lib/harbor_swagger_client/models/replication_execution.rb +295 -0
  425. data/spec/lib/harbor_swagger_client/models/replication_filter.rb +194 -0
  426. data/spec/lib/harbor_swagger_client/models/replication_policy.rb +305 -0
  427. data/spec/lib/harbor_swagger_client/models/replication_task.rb +265 -0
  428. data/spec/lib/harbor_swagger_client/models/replication_trigger.rb +193 -0
  429. data/spec/lib/harbor_swagger_client/models/repo_signature.rb +194 -0
  430. data/spec/lib/harbor_swagger_client/models/report.rb +215 -0
  431. data/spec/lib/harbor_swagger_client/models/repository.rb +276 -0
  432. data/spec/lib/harbor_swagger_client/models/repository_description.rb +184 -0
  433. data/spec/lib/harbor_swagger_client/models/resource.rb +186 -0
  434. data/spec/lib/harbor_swagger_client/models/resource_list.rb +174 -0
  435. data/spec/lib/harbor_swagger_client/models/retag_req.rb +204 -0
  436. data/spec/lib/harbor_swagger_client/models/retention_execution.rb +237 -0
  437. data/spec/lib/harbor_swagger_client/models/retention_execution_task.rb +273 -0
  438. data/spec/lib/harbor_swagger_client/models/retention_metadata.rb +211 -0
  439. data/spec/lib/harbor_swagger_client/models/retention_policy.rb +222 -0
  440. data/spec/lib/harbor_swagger_client/models/retention_policy_scope.rb +192 -0
  441. data/spec/lib/harbor_swagger_client/models/retention_rule.rb +252 -0
  442. data/spec/lib/harbor_swagger_client/models/retention_rule_metadata.rb +217 -0
  443. data/spec/lib/harbor_swagger_client/models/retention_rule_param_metadata.rb +202 -0
  444. data/spec/lib/harbor_swagger_client/models/retention_rule_trigger.rb +201 -0
  445. data/spec/lib/harbor_swagger_client/models/retention_selector.rb +201 -0
  446. data/spec/lib/harbor_swagger_client/models/retention_selector_metadata.rb +204 -0
  447. data/spec/lib/harbor_swagger_client/models/robot_account.rb +255 -0
  448. data/spec/lib/harbor_swagger_client/models/robot_account_access.rb +194 -0
  449. data/spec/lib/harbor_swagger_client/models/robot_account_create.rb +206 -0
  450. data/spec/lib/harbor_swagger_client/models/robot_account_post_rep.rb +194 -0
  451. data/spec/lib/harbor_swagger_client/models/robot_account_update.rb +184 -0
  452. data/spec/lib/harbor_swagger_client/models/role.rb +213 -0
  453. data/spec/lib/harbor_swagger_client/models/role_param.rb +196 -0
  454. data/spec/lib/harbor_swagger_client/models/role_request.rb +184 -0
  455. data/spec/lib/harbor_swagger_client/models/scan_overview.rb +175 -0
  456. data/spec/lib/harbor_swagger_client/models/scanner.rb +204 -0
  457. data/spec/lib/harbor_swagger_client/models/scanner_adapter_metadata.rb +206 -0
  458. data/spec/lib/harbor_swagger_client/models/scanner_capability.rb +196 -0
  459. data/spec/lib/harbor_swagger_client/models/scanner_registration.rb +327 -0
  460. data/spec/lib/harbor_swagger_client/models/scanner_registration_req.rb +262 -0
  461. data/spec/lib/harbor_swagger_client/models/scanner_registration_settings.rb +216 -0
  462. data/spec/lib/harbor_swagger_client/models/search.rb +210 -0
  463. data/spec/lib/harbor_swagger_client/models/search_repository.rb +234 -0
  464. data/spec/lib/harbor_swagger_client/models/search_result.rb +204 -0
  465. data/spec/lib/harbor_swagger_client/models/security_report.rb +184 -0
  466. data/spec/lib/harbor_swagger_client/models/statistic_map.rb +234 -0
  467. data/spec/lib/harbor_swagger_client/models/stats.rb +217 -0
  468. data/spec/lib/harbor_swagger_client/models/storage.rb +194 -0
  469. data/spec/lib/harbor_swagger_client/models/string_config_item.rb +194 -0
  470. data/spec/lib/harbor_swagger_client/models/system_info.rb +186 -0
  471. data/spec/lib/harbor_swagger_client/models/tags.rb +184 -0
  472. data/spec/lib/harbor_swagger_client/models/trigger_settings.rb +184 -0
  473. data/spec/lib/harbor_swagger_client/models/unauthorized_chart_api_error.rb +190 -0
  474. data/spec/lib/harbor_swagger_client/models/user.rb +301 -0
  475. data/spec/lib/harbor_swagger_client/models/user_entity.rb +194 -0
  476. data/spec/lib/harbor_swagger_client/models/user_group.rb +214 -0
  477. data/spec/lib/harbor_swagger_client/models/user_profile.rb +204 -0
  478. data/spec/lib/harbor_swagger_client/models/user_search.rb +193 -0
  479. data/spec/lib/harbor_swagger_client/models/vuln_namespace_timestamp.rb +194 -0
  480. data/spec/lib/harbor_swagger_client/models/vulnerability_item.rb +246 -0
  481. data/spec/lib/harbor_swagger_client/models/vulnerability_summary.rb +207 -0
  482. data/spec/lib/harbor_swagger_client/models/webhook_job.rb +255 -0
  483. data/spec/lib/harbor_swagger_client/models/webhook_last_trigger.rb +215 -0
  484. data/spec/lib/harbor_swagger_client/models/webhook_policy.rb +277 -0
  485. data/spec/lib/harbor_swagger_client/models/webhook_target_object.rb +215 -0
  486. data/spec/lib/harbor_swagger_client/version.rb +15 -0
  487. data/spec/models/access_log_spec.rb +1 -1
  488. data/spec/models/action_1_spec.rb +1 -1
  489. data/spec/models/action_spec.rb +1 -1
  490. data/spec/models/admin_job_schedule_obj_spec.rb +1 -1
  491. data/spec/models/admin_job_schedule_spec.rb +1 -1
  492. data/spec/models/bad_request_formated_error_spec.rb +1 -1
  493. data/spec/models/bool_config_item_spec.rb +1 -1
  494. data/spec/models/chart_api_error_spec.rb +1 -1
  495. data/spec/models/chart_info_entry_spec.rb +1 -1
  496. data/spec/models/chart_info_list_spec.rb +1 -1
  497. data/spec/models/chart_metadata_spec.rb +1 -1
  498. data/spec/models/chart_version_details_spec.rb +1 -1
  499. data/spec/models/chart_version_spec.rb +1 -1
  500. data/spec/models/chart_versions_spec.rb +1 -1
  501. data/spec/models/component_health_status_spec.rb +1 -1
  502. data/spec/models/component_overview_entry_spec.rb +1 -1
  503. data/spec/models/configurations_response_spec.rb +31 -1
  504. data/spec/models/configurations_scan_all_policy_parameter_spec.rb +1 -1
  505. data/spec/models/configurations_scan_all_policy_spec.rb +1 -1
  506. data/spec/models/configurations_spec.rb +37 -1
  507. data/spec/models/conflict_formated_error_spec.rb +1 -1
  508. data/spec/models/cve_whitelist_item_spec.rb +1 -1
  509. data/spec/models/cve_whitelist_spec.rb +1 -1
  510. data/spec/models/dependency_spec.rb +1 -1
  511. data/spec/models/detailed_tag_spec.rb +1 -1
  512. data/spec/models/digital_signature_spec.rb +1 -1
  513. data/spec/models/email_server_setting_spec.rb +1 -1
  514. data/spec/models/endpoint_spec.rb +1 -1
  515. data/spec/models/filter_style_spec.rb +1 -1
  516. data/spec/models/forbidden_chart_api_error_spec.rb +1 -1
  517. data/spec/models/gc_result_spec.rb +1 -1
  518. data/spec/models/general_info_clair_vulnerability_status_spec.rb +1 -1
  519. data/spec/models/general_info_spec.rb +1 -1
  520. data/spec/models/has_admin_role_spec.rb +1 -1
  521. data/spec/models/immutable_tag_rule_spec.rb +59 -0
  522. data/spec/models/inline_response_200_spec.rb +2 -2
  523. data/spec/models/input_secret_spec.rb +41 -0
  524. data/spec/models/insufficient_storage_chart_api_error_spec.rb +1 -1
  525. data/spec/models/integer_config_item_spec.rb +1 -1
  526. data/spec/models/internal_chart_api_error_spec.rb +1 -1
  527. data/spec/models/is_default_spec.rb +41 -0
  528. data/spec/models/job_status_spec.rb +1 -1
  529. data/spec/models/label_spec.rb +1 -1
  530. data/spec/models/labels_spec.rb +1 -1
  531. data/spec/models/ldap_conf_spec.rb +1 -1
  532. data/spec/models/ldap_failed_import_users_spec.rb +1 -1
  533. data/spec/models/ldap_import_users_spec.rb +1 -1
  534. data/spec/models/ldap_users_spec.rb +1 -1
  535. data/spec/models/manifest_spec.rb +1 -1
  536. data/spec/models/namespace_spec.rb +1 -1
  537. data/spec/models/native_report_summary_spec.rb +77 -0
  538. data/spec/models/not_found_chart_api_error_spec.rb +1 -1
  539. data/spec/models/overall_health_status_spec.rb +1 -1
  540. data/spec/models/password_spec.rb +1 -1
  541. data/spec/models/permission_spec.rb +1 -1
  542. data/spec/models/ping_registry_spec.rb +1 -1
  543. data/spec/models/project_member_entity_spec.rb +1 -1
  544. data/spec/models/project_member_spec.rb +1 -1
  545. data/spec/models/project_metadata_spec.rb +1 -1
  546. data/spec/models/project_req_spec.rb +1 -1
  547. data/spec/models/project_scanner_spec.rb +41 -0
  548. data/spec/models/project_spec.rb +7 -1
  549. data/spec/models/project_summary_quota_spec.rb +1 -1
  550. data/spec/models/project_summary_spec.rb +1 -1
  551. data/spec/models/put_registry_spec.rb +1 -1
  552. data/spec/models/quota_ref_object_spec.rb +1 -1
  553. data/spec/models/quota_spec.rb +1 -1
  554. data/spec/models/quota_switcher_spec.rb +1 -1
  555. data/spec/models/quota_update_req_spec.rb +1 -1
  556. data/spec/models/registry_credential_spec.rb +1 -1
  557. data/spec/models/registry_info_spec.rb +1 -1
  558. data/spec/models/registry_spec.rb +1 -1
  559. data/spec/models/replication_execution_spec.rb +1 -1
  560. data/spec/models/replication_filter_spec.rb +1 -1
  561. data/spec/models/replication_policy_spec.rb +1 -1
  562. data/spec/models/replication_task_spec.rb +1 -1
  563. data/spec/models/replication_trigger_spec.rb +1 -1
  564. data/spec/models/repo_signature_spec.rb +1 -1
  565. data/spec/models/report_spec.rb +59 -0
  566. data/spec/models/repository_description_spec.rb +1 -1
  567. data/spec/models/repository_spec.rb +1 -1
  568. data/spec/models/resource_list_spec.rb +1 -1
  569. data/spec/models/resource_spec.rb +1 -1
  570. data/spec/models/retag_req_spec.rb +1 -1
  571. data/spec/models/retention_execution_spec.rb +1 -1
  572. data/spec/models/retention_execution_task_spec.rb +1 -1
  573. data/spec/models/retention_metadata_spec.rb +1 -1
  574. data/spec/models/retention_policy_scope_spec.rb +1 -1
  575. data/spec/models/retention_policy_spec.rb +1 -1
  576. data/spec/models/retention_rule_metadata_spec.rb +1 -1
  577. data/spec/models/retention_rule_param_metadata_spec.rb +1 -1
  578. data/spec/models/retention_rule_spec.rb +1 -1
  579. data/spec/models/retention_rule_trigger_spec.rb +1 -1
  580. data/spec/models/retention_selector_metadata_spec.rb +1 -1
  581. data/spec/models/retention_selector_spec.rb +1 -1
  582. data/spec/models/robot_account_access_spec.rb +1 -1
  583. data/spec/models/robot_account_create_spec.rb +1 -1
  584. data/spec/models/robot_account_post_rep_spec.rb +1 -1
  585. data/spec/models/robot_account_spec.rb +1 -1
  586. data/spec/models/robot_account_update_spec.rb +1 -1
  587. data/spec/models/role_param_spec.rb +1 -1
  588. data/spec/models/role_request_spec.rb +1 -1
  589. data/spec/models/role_spec.rb +1 -1
  590. data/spec/models/scan_overview_spec.rb +35 -0
  591. data/spec/models/scanner_adapter_metadata_spec.rb +53 -0
  592. data/spec/models/scanner_capability_spec.rb +47 -0
  593. data/spec/models/scanner_registration_req_spec.rb +83 -0
  594. data/spec/models/scanner_registration_settings_spec.rb +59 -0
  595. data/spec/models/scanner_registration_spec.rb +119 -0
  596. data/spec/models/scanner_spec.rb +53 -0
  597. data/spec/models/search_repository_spec.rb +1 -1
  598. data/spec/models/search_result_spec.rb +1 -1
  599. data/spec/models/search_spec.rb +1 -1
  600. data/spec/models/security_report_spec.rb +1 -1
  601. data/spec/models/statistic_map_spec.rb +1 -1
  602. data/spec/models/stats_spec.rb +59 -0
  603. data/spec/models/storage_spec.rb +1 -1
  604. data/spec/models/string_config_item_spec.rb +1 -1
  605. data/spec/models/system_info_spec.rb +1 -1
  606. data/spec/models/tags_spec.rb +1 -1
  607. data/spec/models/trigger_settings_spec.rb +1 -1
  608. data/spec/models/unauthorized_chart_api_error_spec.rb +1 -1
  609. data/spec/models/user_entity_spec.rb +1 -1
  610. data/spec/models/user_group_spec.rb +1 -1
  611. data/spec/models/user_profile_spec.rb +1 -1
  612. data/spec/models/user_search_spec.rb +1 -1
  613. data/spec/models/user_spec.rb +1 -1
  614. data/spec/models/vuln_namespace_timestamp_spec.rb +1 -1
  615. data/spec/models/vulnerability_item_spec.rb +11 -5
  616. data/spec/models/vulnerability_summary_spec.rb +53 -0
  617. data/spec/models/webhook_job_spec.rb +1 -1
  618. data/spec/models/webhook_last_trigger_spec.rb +1 -1
  619. data/spec/models/webhook_policy_spec.rb +1 -1
  620. data/spec/models/webhook_target_object_spec.rb +1 -1
  621. data/spec/spec_helper.rb +1 -1
  622. metadata +662 -2
@@ -0,0 +1,10 @@
1
+ # SwaggerClient::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
+ **access** | [**Array<RobotAccountAccess>**](RobotAccountAccess.md) | The permission of robot account | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
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
+
@@ -0,0 +1,8 @@
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
+
data/spec/docs/Role.md ADDED
@@ -0,0 +1,11 @@
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
+
@@ -0,0 +1,9 @@
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
+
@@ -0,0 +1,8 @@
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
+
@@ -0,0 +1,281 @@
1
+ # SwaggerClient::ScanApi
2
+
3
+ All URIs are relative to *http://localhost/api*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**repositories_repo_name_tags_tag_scan_get**](ScanApi.md#repositories_repo_name_tags_tag_scan_get) | **GET** /repositories/{repo_name}/tags/{tag}/scan | Get the scan report
8
+ [**repositories_repo_name_tags_tag_scan_post**](ScanApi.md#repositories_repo_name_tags_tag_scan_post) | **POST** /repositories/{repo_name}/tags/{tag}/scan | Scan the image.
9
+ [**repositories_repo_name_tags_tag_scan_uuid_log_get**](ScanApi.md#repositories_repo_name_tags_tag_scan_uuid_log_get) | **GET** /repositories/{repo_name}/tags/{tag}/scan/{uuid}/log | Get scan log
10
+ [**scans_all_metrics_get**](ScanApi.md#scans_all_metrics_get) | **GET** /scans/all/metrics | Get the metrics of the latest scan all process
11
+ [**scans_schedule_metrics_get**](ScanApi.md#scans_schedule_metrics_get) | **GET** /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process
12
+
13
+
14
+ # **repositories_repo_name_tags_tag_scan_get**
15
+ > Report repositories_repo_name_tags_tag_scan_get(repo_name, tag, opts)
16
+
17
+ Get the scan report
18
+
19
+ Retrieve the scan report for the artifact identified by the repo_name and tag.
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'harbor_swagger_client'
25
+ # setup authorization
26
+ SwaggerClient.configure do |config|
27
+ # Configure HTTP basic authorization: basicAuth
28
+ config.username = 'YOUR USERNAME'
29
+ config.password = 'YOUR PASSWORD'
30
+ end
31
+
32
+ api_instance = SwaggerClient::ScanApi.new
33
+
34
+ repo_name = 'repo_name_example' # String | Repository name
35
+
36
+ tag = 'tag_example' # String | Tag name
37
+
38
+ opts = {
39
+ accept: 'accept_example' # String | Mimetype in header. e.g: \"application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0\"
40
+ }
41
+
42
+ begin
43
+ #Get the scan report
44
+ result = api_instance.repositories_repo_name_tags_tag_scan_get(repo_name, tag, opts)
45
+ p result
46
+ rescue SwaggerClient::ApiError => e
47
+ puts "Exception when calling ScanApi->repositories_repo_name_tags_tag_scan_get: #{e}"
48
+ end
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ Name | Type | Description | Notes
54
+ ------------- | ------------- | ------------- | -------------
55
+ **repo_name** | **String**| Repository name |
56
+ **tag** | **String**| Tag name |
57
+ **accept** | **String**| Mimetype in header. e.g: \"application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0\" | [optional]
58
+
59
+ ### Return type
60
+
61
+ [**Report**](Report.md)
62
+
63
+ ### Authorization
64
+
65
+ [basicAuth](../README.md#basicAuth)
66
+
67
+ ### HTTP request headers
68
+
69
+ - **Content-Type**: application/json
70
+ - **Accept**: application/json, text/plain
71
+
72
+
73
+
74
+ # **repositories_repo_name_tags_tag_scan_post**
75
+ > repositories_repo_name_tags_tag_scan_post(repo_name, tag)
76
+
77
+ Scan the image.
78
+
79
+ Trigger a scan targeting the artifact identified by the repo_name and tag.
80
+
81
+ ### Example
82
+ ```ruby
83
+ # load the gem
84
+ require 'harbor_swagger_client'
85
+ # setup authorization
86
+ SwaggerClient.configure do |config|
87
+ # Configure HTTP basic authorization: basicAuth
88
+ config.username = 'YOUR USERNAME'
89
+ config.password = 'YOUR PASSWORD'
90
+ end
91
+
92
+ api_instance = SwaggerClient::ScanApi.new
93
+
94
+ repo_name = 'repo_name_example' # String | Repository name
95
+
96
+ tag = 'tag_example' # String | Tag name
97
+
98
+
99
+ begin
100
+ #Scan the image.
101
+ api_instance.repositories_repo_name_tags_tag_scan_post(repo_name, tag)
102
+ rescue SwaggerClient::ApiError => e
103
+ puts "Exception when calling ScanApi->repositories_repo_name_tags_tag_scan_post: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ Name | Type | Description | Notes
110
+ ------------- | ------------- | ------------- | -------------
111
+ **repo_name** | **String**| Repository name |
112
+ **tag** | **String**| Tag name |
113
+
114
+ ### Return type
115
+
116
+ nil (empty response body)
117
+
118
+ ### Authorization
119
+
120
+ [basicAuth](../README.md#basicAuth)
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: application/json
125
+ - **Accept**: application/json, text/plain
126
+
127
+
128
+
129
+ # **repositories_repo_name_tags_tag_scan_uuid_log_get**
130
+ > String repositories_repo_name_tags_tag_scan_uuid_log_get(repo_name, tag, uuid)
131
+
132
+ Get scan log
133
+
134
+ Get the log text stream for the given artifact and scan action.
135
+
136
+ ### Example
137
+ ```ruby
138
+ # load the gem
139
+ require 'harbor_swagger_client'
140
+ # setup authorization
141
+ SwaggerClient.configure do |config|
142
+ # Configure HTTP basic authorization: basicAuth
143
+ config.username = 'YOUR USERNAME'
144
+ config.password = 'YOUR PASSWORD'
145
+ end
146
+
147
+ api_instance = SwaggerClient::ScanApi.new
148
+
149
+ repo_name = 'repo_name_example' # String | Repository name
150
+
151
+ tag = 'tag_example' # String | Tag name
152
+
153
+ uuid = 'uuid_example' # String | the scan unique identifier
154
+
155
+
156
+ begin
157
+ #Get scan log
158
+ result = api_instance.repositories_repo_name_tags_tag_scan_uuid_log_get(repo_name, tag, uuid)
159
+ p result
160
+ rescue SwaggerClient::ApiError => e
161
+ puts "Exception when calling ScanApi->repositories_repo_name_tags_tag_scan_uuid_log_get: #{e}"
162
+ end
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ Name | Type | Description | Notes
168
+ ------------- | ------------- | ------------- | -------------
169
+ **repo_name** | **String**| Repository name |
170
+ **tag** | **String**| Tag name |
171
+ **uuid** | **String**| the scan unique identifier |
172
+
173
+ ### Return type
174
+
175
+ **String**
176
+
177
+ ### Authorization
178
+
179
+ [basicAuth](../README.md#basicAuth)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: application/json
184
+ - **Accept**: text/plain
185
+
186
+
187
+
188
+ # **scans_all_metrics_get**
189
+ > Stats scans_all_metrics_get
190
+
191
+ Get the metrics of the latest scan all process
192
+
193
+ Get the metrics of the latest scan all process
194
+
195
+ ### Example
196
+ ```ruby
197
+ # load the gem
198
+ require 'harbor_swagger_client'
199
+ # setup authorization
200
+ SwaggerClient.configure do |config|
201
+ # Configure HTTP basic authorization: basicAuth
202
+ config.username = 'YOUR USERNAME'
203
+ config.password = 'YOUR PASSWORD'
204
+ end
205
+
206
+ api_instance = SwaggerClient::ScanApi.new
207
+
208
+ begin
209
+ #Get the metrics of the latest scan all process
210
+ result = api_instance.scans_all_metrics_get
211
+ p result
212
+ rescue SwaggerClient::ApiError => e
213
+ puts "Exception when calling ScanApi->scans_all_metrics_get: #{e}"
214
+ end
215
+ ```
216
+
217
+ ### Parameters
218
+ This endpoint does not need any parameter.
219
+
220
+ ### Return type
221
+
222
+ [**Stats**](Stats.md)
223
+
224
+ ### Authorization
225
+
226
+ [basicAuth](../README.md#basicAuth)
227
+
228
+ ### HTTP request headers
229
+
230
+ - **Content-Type**: application/json
231
+ - **Accept**: application/json, text/plain
232
+
233
+
234
+
235
+ # **scans_schedule_metrics_get**
236
+ > Stats scans_schedule_metrics_get
237
+
238
+ Get the metrics of the latest scheduled scan all process
239
+
240
+ Get the metrics of the latest scheduled scan all process
241
+
242
+ ### Example
243
+ ```ruby
244
+ # load the gem
245
+ require 'harbor_swagger_client'
246
+ # setup authorization
247
+ SwaggerClient.configure do |config|
248
+ # Configure HTTP basic authorization: basicAuth
249
+ config.username = 'YOUR USERNAME'
250
+ config.password = 'YOUR PASSWORD'
251
+ end
252
+
253
+ api_instance = SwaggerClient::ScanApi.new
254
+
255
+ begin
256
+ #Get the metrics of the latest scheduled scan all process
257
+ result = api_instance.scans_schedule_metrics_get
258
+ p result
259
+ rescue SwaggerClient::ApiError => e
260
+ puts "Exception when calling ScanApi->scans_schedule_metrics_get: #{e}"
261
+ end
262
+ ```
263
+
264
+ ### Parameters
265
+ This endpoint does not need any parameter.
266
+
267
+ ### Return type
268
+
269
+ [**Stats**](Stats.md)
270
+
271
+ ### Authorization
272
+
273
+ [basicAuth](../README.md#basicAuth)
274
+
275
+ ### HTTP request headers
276
+
277
+ - **Content-Type**: application/json
278
+ - **Accept**: application/json, text/plain
279
+
280
+
281
+
@@ -0,0 +1,7 @@
1
+ # SwaggerClient::ScanOverview
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,10 @@
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
+
@@ -0,0 +1,10 @@
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
+
@@ -0,0 +1,9 @@
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
+
@@ -0,0 +1,21 @@
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
+
@@ -0,0 +1,15 @@
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
+
@@ -0,0 +1,11 @@
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
+
@@ -0,0 +1,600 @@
1
+ # SwaggerClient::ScannersApi
2
+
3
+ All URIs are relative to *http://localhost/api*
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
+