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
data/docs/ProjectMember.md DELETED
@@ -1,10 +0,0 @@
1
- # SwaggerClient::ProjectMember
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
- **member_user** | [**UserEntity**](UserEntity.md) | | [optional]
8
- **member_group** | [**UserGroup**](UserGroup.md) | | [optional]
9
-
10
-
data/docs/ProjectMemberEntity.md DELETED
@@ -1,14 +0,0 @@
1
- # SwaggerClient::ProjectMemberEntity
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **Integer** | the project member id | [optional]
7
- **project_id** | **Integer** | the project id | [optional]
8
- **entity_name** | **String** | the name of the group member. | [optional]
9
- **role_name** | **String** | the name of the role | [optional]
10
- **role_id** | **Integer** | the role id | [optional]
11
- **entity_id** | **Integer** | the id of entity, if the member is a user, it is user_id in user table. if the member is a user group, it is the user group's ID in user_group table. | [optional]
12
- **entity_type** | **String** | the entity's type, u for user entity, g for group entity. | [optional]
13
-
14
-
data/docs/ProjectScanner.md DELETED
@@ -1,8 +0,0 @@
1
- # SwaggerClient::ProjectScanner
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **uuid** | **String** | The identifier of the scanner registration | [optional]
7
-
8
-
data/docs/PutRegistry.md DELETED
@@ -1,14 +0,0 @@
1
- # SwaggerClient::PutRegistry
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | The registry name. | [optional]
7
- **description** | **String** | Description of the registry. | [optional]
8
- **url** | **String** | The registry address URL string. | [optional]
9
- **credential_type** | **String** | Credential type of the registry, e.g. 'basic'. | [optional]
10
- **access_key** | **String** | The registry access key. | [optional]
11
- **access_secret** | **String** | The registry access secret. | [optional]
12
- **insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the server. | [optional]
13
-
14
-
data/docs/Quota.md DELETED
@@ -1,13 +0,0 @@
1
- # SwaggerClient::Quota
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **Integer** | ID of the quota | [optional]
7
- **ref** | [**QuotaRefObject**](QuotaRefObject.md) | The reference object of the quota | [optional]
8
- **hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional]
9
- **used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional]
10
- **creation_time** | **String** | the creation time of the quota | [optional]
11
- **update_time** | **String** | the update time of the quota | [optional]
12
-
13
-
data/docs/QuotaApi.md DELETED
@@ -1,118 +0,0 @@
1
- # SwaggerClient::QuotaApi
2
-
3
- All URIs are relative to *http://localhost/api/v2.0*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**quotas_id_get**](QuotaApi.md#quotas_id_get) | **GET** /quotas/{id} | Get the specified quota
8
- [**quotas_id_put**](QuotaApi.md#quotas_id_put) | **PUT** /quotas/{id} | Update the specified quota
9
-
10
-
11
- # **quotas_id_get**
12
- > Quota quotas_id_get(id)
13
-
14
- Get the specified quota
15
-
16
- Get the specified quota
17
-
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'harbor_swagger_client'
22
- # setup authorization
23
- SwaggerClient.configure do |config|
24
- # Configure HTTP basic authorization: basicAuth
25
- config.username = 'YOUR USERNAME'
26
- config.password = 'YOUR PASSWORD'
27
- end
28
-
29
- api_instance = SwaggerClient::QuotaApi.new
30
-
31
- id = 56 # Integer | Quota ID
32
-
33
-
34
- begin
35
- #Get the specified quota
36
- result = api_instance.quotas_id_get(id)
37
- p result
38
- rescue SwaggerClient::ApiError => e
39
- puts "Exception when calling QuotaApi->quotas_id_get: #{e}"
40
- end
41
- ```
42
-
43
- ### Parameters
44
-
45
- Name | Type | Description | Notes
46
- ------------- | ------------- | ------------- | -------------
47
- **id** | **Integer**| Quota ID |
48
-
49
- ### Return type
50
-
51
- [**Quota**](Quota.md)
52
-
53
- ### Authorization
54
-
55
- [basicAuth](../README.md#basicAuth)
56
-
57
- ### HTTP request headers
58
-
59
- - **Content-Type**: application/json
60
- - **Accept**: application/json, text/plain
61
-
62
-
63
-
64
- # **quotas_id_put**
65
- > quotas_id_put(id, hard)
66
-
67
- Update the specified quota
68
-
69
- Update hard limits of the specified quota
70
-
71
- ### Example
72
- ```ruby
73
- # load the gem
74
- require 'harbor_swagger_client'
75
- # setup authorization
76
- SwaggerClient.configure do |config|
77
- # Configure HTTP basic authorization: basicAuth
78
- config.username = 'YOUR USERNAME'
79
- config.password = 'YOUR PASSWORD'
80
- end
81
-
82
- api_instance = SwaggerClient::QuotaApi.new
83
-
84
- id = 56 # Integer | Quota ID
85
-
86
- hard = SwaggerClient::QuotaUpdateReq.new # QuotaUpdateReq | The new hard limits for the quota
87
-
88
-
89
- begin
90
- #Update the specified quota
91
- api_instance.quotas_id_put(id, hard)
92
- rescue SwaggerClient::ApiError => e
93
- puts "Exception when calling QuotaApi->quotas_id_put: #{e}"
94
- end
95
- ```
96
-
97
- ### Parameters
98
-
99
- Name | Type | Description | Notes
100
- ------------- | ------------- | ------------- | -------------
101
- **id** | **Integer**| Quota ID |
102
- **hard** | [**QuotaUpdateReq**](QuotaUpdateReq.md)| The new hard limits for the quota |
103
-
104
- ### Return type
105
-
106
- nil (empty response body)
107
-
108
- ### Authorization
109
-
110
- [basicAuth](../README.md#basicAuth)
111
-
112
- ### HTTP request headers
113
-
114
- - **Content-Type**: application/json
115
- - **Accept**: application/json, text/plain
116
-
117
-
118
-
data/docs/QuotaSwitcher.md DELETED
@@ -1,8 +0,0 @@
1
- # SwaggerClient::QuotaSwitcher
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **enabled** | **BOOLEAN** | The quota is enable or disable | [optional]
7
-
8
-
data/docs/QuotaUpdateReq.md DELETED
@@ -1,8 +0,0 @@
1
- # SwaggerClient::QuotaUpdateReq
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **hard** | [**ResourceList**](ResourceList.md) | The new hard limits for the quota | [optional]
7
-
8
-
data/docs/RegistryInfo.md DELETED
@@ -1,11 +0,0 @@
1
- # SwaggerClient::RegistryInfo
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The registry type | [optional]
7
- **description** | **String** | The description | [optional]
8
- **supported_resource_filters** | [**Array<FilterStyle>**](FilterStyle.md) | The filters that the registry supports | [optional]
9
- **supported_triggers** | **Array<String>** | The triggers that the registry supports | [optional]
10
-
11
-
data/docs/ReplicationFilter.md DELETED
@@ -1,9 +0,0 @@
1
- # SwaggerClient::ReplicationFilter
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The replication policy filter type. | [optional]
7
- **value** | **String** | The value of replication policy filter. | [optional]
8
-
9
-
data/docs/ReplicationPolicy.md DELETED
@@ -1,20 +0,0 @@
1
- # SwaggerClient::ReplicationPolicy
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **Integer** | The policy ID. | [optional]
7
- **name** | **String** | The policy name. | [optional]
8
- **description** | **String** | The description of the policy. | [optional]
9
- **src_registry** | [**Registry**](Registry.md) | The source registry. | [optional]
10
- **dest_registry** | [**Registry**](Registry.md) | The destination registry. | [optional]
11
- **dest_namespace** | **String** | The destination namespace. | [optional]
12
- **trigger** | [**ReplicationTrigger**](ReplicationTrigger.md) | | [optional]
13
- **filters** | [**Array<ReplicationFilter>**](ReplicationFilter.md) | The replication policy filter array. | [optional]
14
- **deletion** | **BOOLEAN** | Whether to replicate the deletion operation. | [optional]
15
- **override** | **BOOLEAN** | Whether to override the resources on the destination registry. | [optional]
16
- **enabled** | **BOOLEAN** | Whether the policy is enabled or not. | [optional]
17
- **creation_time** | **String** | The create time of the policy. | [optional]
18
- **update_time** | **String** | The update time of the policy. | [optional]
19
-
20
-
data/docs/ReplicationTrigger.md DELETED
@@ -1,9 +0,0 @@
1
- # SwaggerClient::ReplicationTrigger
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The replication policy trigger type. The valid values are manual, event_based and scheduled. | [optional]
7
- **trigger_settings** | [**TriggerSettings**](TriggerSettings.md) | | [optional]
8
-
9
-
data/docs/RetentionApi.md DELETED
@@ -1,449 +0,0 @@
1
- # SwaggerClient::RetentionApi
2
-
3
- All URIs are relative to *http://localhost/api/v2.0*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**retentions_id_executions_eid_patch**](RetentionApi.md#retentions_id_executions_eid_patch) | **PATCH** /retentions/{id}/executions/{eid} | Stop a Retention job
8
- [**retentions_id_executions_eid_tasks_get**](RetentionApi.md#retentions_id_executions_eid_tasks_get) | **GET** /retentions/{id}/executions/{eid}/tasks | Get Retention job tasks
9
- [**retentions_id_executions_eid_tasks_tid_get**](RetentionApi.md#retentions_id_executions_eid_tasks_tid_get) | **GET** /retentions/{id}/executions/{eid}/tasks/{tid} | Get Retention job task log
10
- [**retentions_id_executions_get**](RetentionApi.md#retentions_id_executions_get) | **GET** /retentions/{id}/executions | Get a Retention job
11
- [**retentions_id_executions_post**](RetentionApi.md#retentions_id_executions_post) | **POST** /retentions/{id}/executions | Trigger a Retention job
12
- [**retentions_id_get**](RetentionApi.md#retentions_id_get) | **GET** /retentions/{id} | Get Retention Policy
13
- [**retentions_metadatas_get**](RetentionApi.md#retentions_metadatas_get) | **GET** /retentions/metadatas | Get Retention Metadatas
14
- [**retentions_post**](RetentionApi.md#retentions_post) | **POST** /retentions | Create Retention Policy
15
-
16
-
17
- # **retentions_id_executions_eid_patch**
18
- > retentions_id_executions_eid_patch(id, eid, action)
19
-
20
- Stop a Retention job
21
-
22
- Stop a Retention job, only support \"stop\" action now.
23
-
24
- ### Example
25
- ```ruby
26
- # load the gem
27
- require 'harbor_swagger_client'
28
- # setup authorization
29
- SwaggerClient.configure do |config|
30
- # Configure HTTP basic authorization: basicAuth
31
- config.username = 'YOUR USERNAME'
32
- config.password = 'YOUR PASSWORD'
33
- end
34
-
35
- api_instance = SwaggerClient::RetentionApi.new
36
-
37
- id = 789 # Integer | Retention ID.
38
-
39
- eid = 789 # Integer | Retention execution ID.
40
-
41
- action = SwaggerClient::Action1.new # Action1 | The action, only support \"stop\" now.
42
-
43
-
44
- begin
45
- #Stop a Retention job
46
- api_instance.retentions_id_executions_eid_patch(id, eid, action)
47
- rescue SwaggerClient::ApiError => e
48
- puts "Exception when calling RetentionApi->retentions_id_executions_eid_patch: #{e}"
49
- end
50
- ```
51
-
52
- ### Parameters
53
-
54
- Name | Type | Description | Notes
55
- ------------- | ------------- | ------------- | -------------
56
- **id** | **Integer**| Retention ID. |
57
- **eid** | **Integer**| Retention execution ID. |
58
- **action** | [**Action1**](Action1.md)| The action, only support \"stop\" now. |
59
-
60
- ### Return type
61
-
62
- nil (empty response body)
63
-
64
- ### Authorization
65
-
66
- [basicAuth](../README.md#basicAuth)
67
-
68
- ### HTTP request headers
69
-
70
- - **Content-Type**: application/json
71
- - **Accept**: application/json, text/plain
72
-
73
-
74
-
75
- # **retentions_id_executions_eid_tasks_get**
76
- > Array<RetentionExecutionTask> retentions_id_executions_eid_tasks_get(id, eid)
77
-
78
- Get Retention job tasks
79
-
80
- Get Retention job tasks, each repository as a task.
81
-
82
- ### Example
83
- ```ruby
84
- # load the gem
85
- require 'harbor_swagger_client'
86
- # setup authorization
87
- SwaggerClient.configure do |config|
88
- # Configure HTTP basic authorization: basicAuth
89
- config.username = 'YOUR USERNAME'
90
- config.password = 'YOUR PASSWORD'
91
- end
92
-
93
- api_instance = SwaggerClient::RetentionApi.new
94
-
95
- id = 789 # Integer | Retention ID.
96
-
97
- eid = 789 # Integer | Retention execution ID.
98
-
99
-
100
- begin
101
- #Get Retention job tasks
102
- result = api_instance.retentions_id_executions_eid_tasks_get(id, eid)
103
- p result
104
- rescue SwaggerClient::ApiError => e
105
- puts "Exception when calling RetentionApi->retentions_id_executions_eid_tasks_get: #{e}"
106
- end
107
- ```
108
-
109
- ### Parameters
110
-
111
- Name | Type | Description | Notes
112
- ------------- | ------------- | ------------- | -------------
113
- **id** | **Integer**| Retention ID. |
114
- **eid** | **Integer**| Retention execution ID. |
115
-
116
- ### Return type
117
-
118
- [**Array<RetentionExecutionTask>**](RetentionExecutionTask.md)
119
-
120
- ### Authorization
121
-
122
- [basicAuth](../README.md#basicAuth)
123
-
124
- ### HTTP request headers
125
-
126
- - **Content-Type**: application/json
127
- - **Accept**: application/json, text/plain
128
-
129
-
130
-
131
- # **retentions_id_executions_eid_tasks_tid_get**
132
- > String retentions_id_executions_eid_tasks_tid_get(id, eid, tid)
133
-
134
- Get Retention job task log
135
-
136
- Get Retention job task log, tags ratain or deletion detail will be shown in a table.
137
-
138
- ### Example
139
- ```ruby
140
- # load the gem
141
- require 'harbor_swagger_client'
142
- # setup authorization
143
- SwaggerClient.configure do |config|
144
- # Configure HTTP basic authorization: basicAuth
145
- config.username = 'YOUR USERNAME'
146
- config.password = 'YOUR PASSWORD'
147
- end
148
-
149
- api_instance = SwaggerClient::RetentionApi.new
150
-
151
- id = 789 # Integer | Retention ID.
152
-
153
- eid = 789 # Integer | Retention execution ID.
154
-
155
- tid = 789 # Integer | Retention execution ID.
156
-
157
-
158
- begin
159
- #Get Retention job task log
160
- result = api_instance.retentions_id_executions_eid_tasks_tid_get(id, eid, tid)
161
- p result
162
- rescue SwaggerClient::ApiError => e
163
- puts "Exception when calling RetentionApi->retentions_id_executions_eid_tasks_tid_get: #{e}"
164
- end
165
- ```
166
-
167
- ### Parameters
168
-
169
- Name | Type | Description | Notes
170
- ------------- | ------------- | ------------- | -------------
171
- **id** | **Integer**| Retention ID. |
172
- **eid** | **Integer**| Retention execution ID. |
173
- **tid** | **Integer**| Retention execution ID. |
174
-
175
- ### Return type
176
-
177
- **String**
178
-
179
- ### Authorization
180
-
181
- [basicAuth](../README.md#basicAuth)
182
-
183
- ### HTTP request headers
184
-
185
- - **Content-Type**: application/json
186
- - **Accept**: application/json, text/plain
187
-
188
-
189
-
190
- # **retentions_id_executions_get**
191
- > Array<RetentionExecution> retentions_id_executions_get(id)
192
-
193
- Get a Retention job
194
-
195
- Get a Retention job, job status may be delayed before job service schedule it up.
196
-
197
- ### Example
198
- ```ruby
199
- # load the gem
200
- require 'harbor_swagger_client'
201
- # setup authorization
202
- SwaggerClient.configure do |config|
203
- # Configure HTTP basic authorization: basicAuth
204
- config.username = 'YOUR USERNAME'
205
- config.password = 'YOUR PASSWORD'
206
- end
207
-
208
- api_instance = SwaggerClient::RetentionApi.new
209
-
210
- id = 789 # Integer | Retention ID.
211
-
212
-
213
- begin
214
- #Get a Retention job
215
- result = api_instance.retentions_id_executions_get(id)
216
- p result
217
- rescue SwaggerClient::ApiError => e
218
- puts "Exception when calling RetentionApi->retentions_id_executions_get: #{e}"
219
- end
220
- ```
221
-
222
- ### Parameters
223
-
224
- Name | Type | Description | Notes
225
- ------------- | ------------- | ------------- | -------------
226
- **id** | **Integer**| Retention ID. |
227
-
228
- ### Return type
229
-
230
- [**Array<RetentionExecution>**](RetentionExecution.md)
231
-
232
- ### Authorization
233
-
234
- [basicAuth](../README.md#basicAuth)
235
-
236
- ### HTTP request headers
237
-
238
- - **Content-Type**: application/json
239
- - **Accept**: application/json, text/plain
240
-
241
-
242
-
243
- # **retentions_id_executions_post**
244
- > retentions_id_executions_post(id, action)
245
-
246
- Trigger a Retention job
247
-
248
- Trigger a Retention job, if dry_run is True, nothing would be deleted actually.
249
-
250
- ### Example
251
- ```ruby
252
- # load the gem
253
- require 'harbor_swagger_client'
254
- # setup authorization
255
- SwaggerClient.configure do |config|
256
- # Configure HTTP basic authorization: basicAuth
257
- config.username = 'YOUR USERNAME'
258
- config.password = 'YOUR PASSWORD'
259
- end
260
-
261
- api_instance = SwaggerClient::RetentionApi.new
262
-
263
- id = 789 # Integer | Retention ID.
264
-
265
- action = SwaggerClient::Action.new # Action |
266
-
267
-
268
- begin
269
- #Trigger a Retention job
270
- api_instance.retentions_id_executions_post(id, action)
271
- rescue SwaggerClient::ApiError => e
272
- puts "Exception when calling RetentionApi->retentions_id_executions_post: #{e}"
273
- end
274
- ```
275
-
276
- ### Parameters
277
-
278
- Name | Type | Description | Notes
279
- ------------- | ------------- | ------------- | -------------
280
- **id** | **Integer**| Retention ID. |
281
- **action** | [**Action**](Action.md)| |
282
-
283
- ### Return type
284
-
285
- nil (empty response body)
286
-
287
- ### Authorization
288
-
289
- [basicAuth](../README.md#basicAuth)
290
-
291
- ### HTTP request headers
292
-
293
- - **Content-Type**: application/json
294
- - **Accept**: application/json, text/plain
295
-
296
-
297
-
298
- # **retentions_id_get**
299
- > RetentionPolicy retentions_id_get(id)
300
-
301
- Get Retention Policy
302
-
303
- Get Retention Policy.
304
-
305
- ### Example
306
- ```ruby
307
- # load the gem
308
- require 'harbor_swagger_client'
309
- # setup authorization
310
- SwaggerClient.configure do |config|
311
- # Configure HTTP basic authorization: basicAuth
312
- config.username = 'YOUR USERNAME'
313
- config.password = 'YOUR PASSWORD'
314
- end
315
-
316
- api_instance = SwaggerClient::RetentionApi.new
317
-
318
- id = 789 # Integer | Retention ID.
319
-
320
-
321
- begin
322
- #Get Retention Policy
323
- result = api_instance.retentions_id_get(id)
324
- p result
325
- rescue SwaggerClient::ApiError => e
326
- puts "Exception when calling RetentionApi->retentions_id_get: #{e}"
327
- end
328
- ```
329
-
330
- ### Parameters
331
-
332
- Name | Type | Description | Notes
333
- ------------- | ------------- | ------------- | -------------
334
- **id** | **Integer**| Retention ID. |
335
-
336
- ### Return type
337
-
338
- [**RetentionPolicy**](RetentionPolicy.md)
339
-
340
- ### Authorization
341
-
342
- [basicAuth](../README.md#basicAuth)
343
-
344
- ### HTTP request headers
345
-
346
- - **Content-Type**: application/json
347
- - **Accept**: application/json, text/plain
348
-
349
-
350
-
351
- # **retentions_metadatas_get**
352
- > RetentionMetadata retentions_metadatas_get
353
-
354
- Get Retention Metadatas
355
-
356
- Get Retention Metadatas.
357
-
358
- ### Example
359
- ```ruby
360
- # load the gem
361
- require 'harbor_swagger_client'
362
- # setup authorization
363
- SwaggerClient.configure do |config|
364
- # Configure HTTP basic authorization: basicAuth
365
- config.username = 'YOUR USERNAME'
366
- config.password = 'YOUR PASSWORD'
367
- end
368
-
369
- api_instance = SwaggerClient::RetentionApi.new
370
-
371
- begin
372
- #Get Retention Metadatas
373
- result = api_instance.retentions_metadatas_get
374
- p result
375
- rescue SwaggerClient::ApiError => e
376
- puts "Exception when calling RetentionApi->retentions_metadatas_get: #{e}"
377
- end
378
- ```
379
-
380
- ### Parameters
381
- This endpoint does not need any parameter.
382
-
383
- ### Return type
384
-
385
- [**RetentionMetadata**](RetentionMetadata.md)
386
-
387
- ### Authorization
388
-
389
- [basicAuth](../README.md#basicAuth)
390
-
391
- ### HTTP request headers
392
-
393
- - **Content-Type**: application/json
394
- - **Accept**: application/json, text/plain
395
-
396
-
397
-
398
- # **retentions_post**
399
- > retentions_post(policy)
400
-
401
- Create Retention Policy
402
-
403
- Create Retention Policy, you can reference metadatas API for the policy model. You can check project metadatas to find whether a retention policy is already binded. This method should only be called when no retention policy binded to project yet.
404
-
405
- ### Example
406
- ```ruby
407
- # load the gem
408
- require 'harbor_swagger_client'
409
- # setup authorization
410
- SwaggerClient.configure do |config|
411
- # Configure HTTP basic authorization: basicAuth
412
- config.username = 'YOUR USERNAME'
413
- config.password = 'YOUR PASSWORD'
414
- end
415
-
416
- api_instance = SwaggerClient::RetentionApi.new
417
-
418
- policy = SwaggerClient::RetentionPolicy.new # RetentionPolicy | Create Retention Policy successfully.
419
-
420
-
421
- begin
422
- #Create Retention Policy
423
- api_instance.retentions_post(policy)
424
- rescue SwaggerClient::ApiError => e
425
- puts "Exception when calling RetentionApi->retentions_post: #{e}"
426
- end
427
- ```
428
-
429
- ### Parameters
430
-
431
- Name | Type | Description | Notes
432
- ------------- | ------------- | ------------- | -------------
433
- **policy** | [**RetentionPolicy**](RetentionPolicy.md)| Create Retention Policy successfully. |
434
-
435
- ### Return type
436
-
437
- nil (empty response body)
438
-
439
- ### Authorization
440
-
441
- [basicAuth](../README.md#basicAuth)
442
-
443
- ### HTTP request headers
444
-
445
- - **Content-Type**: application/json
446
- - **Accept**: application/json, text/plain
447
-
448
-
449
-