harbor2_client 0.1.0 → 2.3.3.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (484) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +241 -13
  3. data/build_scripts/generate.sh +8 -0
  4. data/build_scripts/swagger-codegen-cli-ruby-config.json +12 -0
  5. data/docs/Access.md +10 -0
  6. data/docs/ArtifactApi.md +76 -2
  7. data/docs/AuditlogApi.md +3 -1
  8. data/docs/AuthproxySetting.md +12 -0
  9. data/docs/Body.md +8 -0
  10. data/docs/Body1.md +8 -0
  11. data/docs/BoolConfigItem.md +9 -0
  12. data/docs/ChartMetadata.md +18 -0
  13. data/docs/ChartVersion.md +23 -0
  14. data/docs/ComponentHealthStatus.md +10 -0
  15. data/docs/Configurations.md +62 -0
  16. data/docs/ConfigurationsResponse.md +60 -0
  17. data/docs/ConfigurationsResponseScanAllPolicy.md +9 -0
  18. data/docs/ConfigurationsResponseScanAllPolicyParameter.md +8 -0
  19. data/docs/ConfigureApi.md +175 -0
  20. data/docs/Endpoint.md +9 -0
  21. data/docs/EventType.md +7 -0
  22. data/docs/FilterStyle.md +10 -0
  23. data/docs/GCHistory.md +16 -0
  24. data/docs/GcApi.md +356 -0
  25. data/docs/GeneralInfo.md +20 -0
  26. data/docs/HealthApi.md +63 -0
  27. data/docs/ImmutableApi.md +261 -0
  28. data/docs/ImmutableRule.md +15 -0
  29. data/docs/ImmutableSelector.md +11 -0
  30. data/docs/IntegerConfigItem.md +9 -0
  31. data/docs/InternalConfigurationsResponse.md +7 -0
  32. data/docs/IsDefault.md +8 -0
  33. data/docs/LabelApi.md +309 -0
  34. data/docs/LdapApi.md +238 -0
  35. data/docs/LdapConf.md +16 -0
  36. data/docs/LdapFailedImportUser.md +9 -0
  37. data/docs/LdapImportUsers.md +8 -0
  38. data/docs/LdapPingResult.md +9 -0
  39. data/docs/LdapUser.md +10 -0
  40. data/docs/MemberApi.md +322 -0
  41. data/docs/NativeReportSummary.md +1 -0
  42. data/docs/NotifyType.md +7 -0
  43. data/docs/OIDCCliSecretReq.md +8 -0
  44. data/docs/OIDCUserInfo.md +13 -0
  45. data/docs/OidcApi.md +65 -0
  46. data/docs/OverallHealthStatus.md +9 -0
  47. data/docs/PasswordReq.md +9 -0
  48. data/docs/Permission.md +9 -0
  49. data/docs/PingApi.md +63 -0
  50. data/docs/PreheatApi.md +12 -4
  51. data/docs/ProjectApi.md +237 -27
  52. data/docs/ProjectMember.md +10 -0
  53. data/docs/ProjectMemberEntity.md +14 -0
  54. data/docs/ProjectMetadataApi.md +318 -0
  55. data/docs/ProjectScanner.md +8 -0
  56. data/docs/Quota.md +13 -0
  57. data/docs/QuotaApi.md +191 -0
  58. data/docs/QuotaRefObject.md +7 -0
  59. data/docs/QuotaUpdateReq.md +8 -0
  60. data/docs/Registry.md +2 -2
  61. data/docs/RegistryApi.md +530 -0
  62. data/docs/RegistryEndpoint.md +9 -0
  63. data/docs/RegistryInfo.md +11 -0
  64. data/docs/RegistryPing.md +14 -0
  65. data/docs/RegistryProviderCredentialPattern.md +11 -0
  66. data/docs/RegistryProviderEndpointPattern.md +9 -0
  67. data/docs/RegistryProviderInfo.md +9 -0
  68. data/docs/RegistryUpdate.md +14 -0
  69. data/docs/ReplicationApi.md +673 -0
  70. data/docs/ReplicationExecution.md +19 -0
  71. data/docs/ReplicationFilter.md +9 -0
  72. data/docs/ReplicationPolicy.md +22 -0
  73. data/docs/ReplicationTask.md +17 -0
  74. data/docs/ReplicationTrigger.md +9 -0
  75. data/docs/ReplicationTriggerSettings.md +8 -0
  76. data/docs/RepositoryApi.md +66 -1
  77. data/docs/RetentionApi.md +609 -0
  78. data/docs/RetentionExecution.md +14 -0
  79. data/docs/RetentionExecutionTask.md +18 -0
  80. data/docs/RetentionMetadata.md +10 -0
  81. data/docs/RetentionPolicy.md +12 -0
  82. data/docs/RetentionPolicyScope.md +9 -0
  83. data/docs/RetentionRule.md +15 -0
  84. data/docs/RetentionRuleMetadata.md +11 -0
  85. data/docs/RetentionRuleParamMetadata.md +10 -0
  86. data/docs/RetentionRuleTrigger.md +10 -0
  87. data/docs/RetentionSelector.md +11 -0
  88. data/docs/RetentionSelectorMetadata.md +10 -0
  89. data/docs/Robot.md +19 -0
  90. data/docs/RobotApi.md +365 -0
  91. data/docs/RobotCreate.md +14 -0
  92. data/docs/RobotCreateV1.md +11 -0
  93. data/docs/RobotCreated.md +12 -0
  94. data/docs/RobotPermission.md +10 -0
  95. data/docs/RobotSec.md +8 -0
  96. data/docs/Robotv1Api.md +329 -0
  97. data/docs/RoleRequest.md +8 -0
  98. data/docs/ScanAllApi.md +287 -0
  99. data/docs/Scanner.md +10 -0
  100. data/docs/ScannerAdapterMetadata.md +10 -0
  101. data/docs/ScannerApi.md +479 -0
  102. data/docs/ScannerCapability.md +9 -0
  103. data/docs/ScannerRegistration.md +23 -0
  104. data/docs/ScannerRegistrationReq.md +15 -0
  105. data/docs/ScannerRegistrationSettings.md +11 -0
  106. data/docs/Schedule.md +13 -0
  107. data/docs/ScheduleObj.md +9 -0
  108. data/docs/Search.md +10 -0
  109. data/docs/SearchApi.md +66 -0
  110. data/docs/SearchRepository.md +13 -0
  111. data/docs/SearchResult.md +10 -0
  112. data/docs/StartReplicationExecution.md +8 -0
  113. data/docs/Statistic.md +14 -0
  114. data/docs/StatisticApi.md +63 -0
  115. data/docs/Stats.md +12 -0
  116. data/docs/Storage.md +9 -0
  117. data/docs/StringConfigItem.md +9 -0
  118. data/docs/SupportedWebhookEventTypes.md +9 -0
  119. data/docs/SystemCVEAllowlistApi.md +119 -0
  120. data/docs/SystemInfo.md +8 -0
  121. data/docs/SysteminfoApi.md +173 -0
  122. data/docs/UserApi.md +647 -0
  123. data/docs/UserCreationReq.md +12 -0
  124. data/docs/UserEntity.md +9 -0
  125. data/docs/UserGroup.md +11 -0
  126. data/docs/UserProfile.md +10 -0
  127. data/docs/UserResp.md +17 -0
  128. data/docs/UserSearch.md +9 -0
  129. data/docs/UserSearchRespItem.md +9 -0
  130. data/docs/UserSysAdminFlag.md +8 -0
  131. data/docs/UsergroupApi.md +293 -0
  132. data/docs/WebhookApi.md +448 -0
  133. data/docs/WebhookJob.md +15 -0
  134. data/docs/WebhookLastTrigger.md +12 -0
  135. data/docs/WebhookPolicy.md +17 -0
  136. data/docs/WebhookTargetObject.md +11 -0
  137. data/docs/WebhookjobApi.md +81 -0
  138. data/git_push.sh +3 -3
  139. data/harbor2_client.gemspec +7 -7
  140. data/lib/harbor2_client/api/artifact_api.rb +91 -3
  141. data/lib/harbor2_client/api/auditlog_api.rb +4 -1
  142. data/lib/harbor2_client/api/configure_api.rb +193 -0
  143. data/lib/harbor2_client/api/gc_api.rb +391 -0
  144. data/lib/harbor2_client/api/health_api.rb +78 -0
  145. data/lib/harbor2_client/api/icon_api.rb +1 -1
  146. data/lib/harbor2_client/api/immutable_api.rb +312 -0
  147. data/lib/harbor2_client/api/label_api.rb +350 -0
  148. data/lib/harbor2_client/api/ldap_api.rb +259 -0
  149. data/lib/harbor2_client/api/member_api.rb +373 -0
  150. data/lib/harbor2_client/api/oidc_api.rb +83 -0
  151. data/lib/harbor2_client/api/ping_api.rb +78 -0
  152. data/lib/harbor2_client/api/preheat_api.rb +13 -1
  153. data/lib/harbor2_client/api/project_api.rb +289 -46
  154. data/lib/harbor2_client/api/project_metadata_api.rb +362 -0
  155. data/lib/harbor2_client/api/quota_api.rb +224 -0
  156. data/lib/harbor2_client/api/registry_api.rb +575 -0
  157. data/lib/harbor2_client/api/replication_api.rb +749 -0
  158. data/lib/harbor2_client/api/repository_api.rb +75 -1
  159. data/lib/harbor2_client/api/retention_api.rb +676 -0
  160. data/lib/harbor2_client/api/robot_api.rb +409 -0
  161. data/lib/harbor2_client/api/robotv1_api.rb +387 -0
  162. data/lib/harbor2_client/api/scan_all_api.rb +308 -0
  163. data/lib/harbor2_client/api/scan_api.rb +1 -1
  164. data/lib/harbor2_client/api/scanner_api.rb +529 -0
  165. data/lib/harbor2_client/api/search_api.rb +85 -0
  166. data/lib/harbor2_client/api/statistic_api.rb +78 -0
  167. data/lib/harbor2_client/api/system_cve_allowlist_api.rb +134 -0
  168. data/lib/harbor2_client/api/systeminfo_api.rb +188 -0
  169. data/lib/harbor2_client/api/user_api.rb +715 -0
  170. data/lib/harbor2_client/api/usergroup_api.rb +317 -0
  171. data/lib/harbor2_client/api/webhook_api.rb +514 -0
  172. data/lib/harbor2_client/api/webhookjob_api.rb +113 -0
  173. data/lib/harbor2_client/api_client.rb +2 -2
  174. data/lib/harbor2_client/api_error.rb +1 -1
  175. data/lib/harbor2_client/configuration.rb +1 -1
  176. data/lib/harbor2_client/models/access.rb +205 -0
  177. data/lib/harbor2_client/models/addition_link.rb +1 -1
  178. data/lib/harbor2_client/models/addition_links.rb +1 -1
  179. data/lib/harbor2_client/models/annotations.rb +1 -1
  180. data/lib/harbor2_client/models/artifact.rb +1 -1
  181. data/lib/harbor2_client/models/audit_log.rb +1 -1
  182. data/lib/harbor2_client/models/authproxy_setting.rb +225 -0
  183. data/lib/harbor2_client/models/body.rb +184 -0
  184. data/lib/harbor2_client/models/body_1.rb +184 -0
  185. data/lib/harbor2_client/models/bool_config_item.rb +195 -0
  186. data/lib/harbor2_client/models/chart_metadata.rb +320 -0
  187. data/lib/harbor2_client/models/chart_version.rb +374 -0
  188. data/lib/harbor2_client/models/component_health_status.rb +206 -0
  189. data/lib/harbor2_client/models/configurations.rb +725 -0
  190. data/lib/harbor2_client/models/configurations_response.rb +704 -0
  191. data/lib/harbor2_client/models/configurations_response_scan_all_policy.rb +194 -0
  192. data/lib/harbor2_client/models/configurations_response_scan_all_policy_parameter.rb +186 -0
  193. data/lib/harbor2_client/models/cve_allowlist.rb +1 -1
  194. data/lib/harbor2_client/models/cve_allowlist_item.rb +1 -1
  195. data/lib/harbor2_client/models/endpoint.rb +195 -0
  196. data/lib/harbor2_client/models/error.rb +1 -1
  197. data/lib/harbor2_client/models/errors.rb +1 -1
  198. data/lib/harbor2_client/models/event_type.rb +176 -0
  199. data/lib/harbor2_client/models/execution.rb +1 -1
  200. data/lib/harbor2_client/models/extra_attrs.rb +1 -1
  201. data/lib/harbor2_client/models/filter_style.rb +208 -0
  202. data/lib/harbor2_client/models/gc_history.rb +264 -0
  203. data/lib/harbor2_client/models/general_info.rb +305 -0
  204. data/lib/harbor2_client/models/icon.rb +1 -1
  205. data/lib/harbor2_client/models/immutable_rule.rb +253 -0
  206. data/lib/harbor2_client/models/immutable_selector.rb +211 -0
  207. data/lib/harbor2_client/models/instance.rb +1 -1
  208. data/lib/harbor2_client/models/integer_config_item.rb +195 -0
  209. data/lib/harbor2_client/models/internal_configurations_response.rb +175 -0
  210. data/lib/harbor2_client/models/is_default.rb +185 -0
  211. data/lib/harbor2_client/models/label.rb +1 -1
  212. data/lib/harbor2_client/models/ldap_conf.rb +266 -0
  213. data/lib/harbor2_client/models/ldap_failed_import_user.rb +195 -0
  214. data/lib/harbor2_client/models/ldap_import_users.rb +187 -0
  215. data/lib/harbor2_client/models/ldap_ping_result.rb +196 -0
  216. data/lib/harbor2_client/models/ldap_user.rb +205 -0
  217. data/lib/harbor2_client/models/metadata.rb +1 -1
  218. data/lib/harbor2_client/models/metrics.rb +1 -1
  219. data/lib/harbor2_client/models/native_report_summary.rb +14 -5
  220. data/lib/harbor2_client/models/notify_type.rb +176 -0
  221. data/lib/harbor2_client/models/oidc_cli_secret_req.rb +185 -0
  222. data/lib/harbor2_client/models/oidc_user_info.rb +235 -0
  223. data/lib/harbor2_client/models/overall_health_status.rb +197 -0
  224. data/lib/harbor2_client/models/password_req.rb +195 -0
  225. data/lib/harbor2_client/models/permission.rb +195 -0
  226. data/lib/harbor2_client/models/platform.rb +7 -7
  227. data/lib/harbor2_client/models/preheat_policy.rb +1 -1
  228. data/lib/harbor2_client/models/project.rb +1 -1
  229. data/lib/harbor2_client/models/project_deletable.rb +1 -1
  230. data/lib/harbor2_client/models/project_member.rb +203 -0
  231. data/lib/harbor2_client/models/project_member_entity.rb +245 -0
  232. data/lib/harbor2_client/models/project_metadata.rb +1 -1
  233. data/lib/harbor2_client/models/project_req.rb +16 -1
  234. data/lib/harbor2_client/models/project_scanner.rb +190 -0
  235. data/lib/harbor2_client/models/project_summary.rb +1 -1
  236. data/lib/harbor2_client/models/project_summary_quota.rb +1 -1
  237. data/lib/harbor2_client/models/provider_under_project.rb +1 -1
  238. data/lib/harbor2_client/models/quota.rb +236 -0
  239. data/lib/harbor2_client/models/quota_ref_object.rb +175 -0
  240. data/lib/harbor2_client/models/quota_update_req.rb +185 -0
  241. data/lib/harbor2_client/models/reference.rb +1 -1
  242. data/lib/harbor2_client/models/registry.rb +3 -3
  243. data/lib/harbor2_client/models/registry_credential.rb +1 -1
  244. data/lib/harbor2_client/models/registry_endpoint.rb +196 -0
  245. data/lib/harbor2_client/models/registry_info.rb +220 -0
  246. data/lib/harbor2_client/models/registry_ping.rb +245 -0
  247. data/lib/harbor2_client/models/registry_provider_credential_pattern.rb +216 -0
  248. data/lib/harbor2_client/models/registry_provider_endpoint_pattern.rb +198 -0
  249. data/lib/harbor2_client/models/registry_provider_info.rb +196 -0
  250. data/lib/harbor2_client/models/registry_update.rb +245 -0
  251. data/lib/harbor2_client/models/replication_execution.rb +296 -0
  252. data/lib/harbor2_client/models/replication_filter.rb +195 -0
  253. data/lib/harbor2_client/models/replication_policy.rb +326 -0
  254. data/lib/harbor2_client/models/replication_task.rb +276 -0
  255. data/lib/harbor2_client/models/replication_trigger.rb +194 -0
  256. data/lib/harbor2_client/models/replication_trigger_settings.rb +185 -0
  257. data/lib/harbor2_client/models/repository.rb +1 -1
  258. data/lib/harbor2_client/models/resource_list.rb +1 -1
  259. data/lib/harbor2_client/models/retention_execution.rb +238 -0
  260. data/lib/harbor2_client/models/retention_execution_task.rb +274 -0
  261. data/lib/harbor2_client/models/retention_metadata.rb +212 -0
  262. data/lib/harbor2_client/models/retention_policy.rb +223 -0
  263. data/lib/harbor2_client/models/retention_policy_scope.rb +193 -0
  264. data/lib/harbor2_client/models/retention_rule.rb +253 -0
  265. data/lib/harbor2_client/models/retention_rule_metadata.rb +218 -0
  266. data/lib/harbor2_client/models/retention_rule_param_metadata.rb +203 -0
  267. data/lib/harbor2_client/models/retention_rule_trigger.rb +202 -0
  268. data/lib/harbor2_client/models/retention_selector.rb +211 -0
  269. data/lib/harbor2_client/models/retention_selector_metadata.rb +205 -0
  270. data/lib/harbor2_client/models/robot.rb +296 -0
  271. data/lib/harbor2_client/models/robot_create.rb +247 -0
  272. data/lib/harbor2_client/models/robot_create_v1.rb +217 -0
  273. data/lib/harbor2_client/models/robot_created.rb +226 -0
  274. data/lib/harbor2_client/models/robot_permission.rb +206 -0
  275. data/lib/harbor2_client/models/robot_sec.rb +186 -0
  276. data/lib/harbor2_client/models/role_request.rb +185 -0
  277. data/lib/harbor2_client/models/scan_overview.rb +1 -1
  278. data/lib/harbor2_client/models/scanner.rb +205 -0
  279. data/lib/harbor2_client/models/scanner_adapter_metadata.rb +207 -0
  280. data/lib/harbor2_client/models/scanner_capability.rb +197 -0
  281. data/lib/harbor2_client/models/scanner_registration.rb +348 -0
  282. data/lib/harbor2_client/models/scanner_registration_req.rb +271 -0
  283. data/lib/harbor2_client/models/scanner_registration_settings.rb +227 -0
  284. data/lib/harbor2_client/models/schedule.rb +236 -0
  285. data/lib/harbor2_client/models/schedule_obj.rb +229 -0
  286. data/lib/harbor2_client/models/search.rb +211 -0
  287. data/lib/harbor2_client/models/search_repository.rb +235 -0
  288. data/lib/harbor2_client/models/search_result.rb +205 -0
  289. data/lib/harbor2_client/models/start_replication_execution.rb +185 -0
  290. data/lib/harbor2_client/models/statistic.rb +245 -0
  291. data/lib/harbor2_client/models/stats.rb +262 -0
  292. data/lib/harbor2_client/models/storage.rb +195 -0
  293. data/lib/harbor2_client/models/string_config_item.rb +195 -0
  294. data/lib/harbor2_client/models/supported_webhook_event_types.rb +198 -0
  295. data/lib/harbor2_client/models/system_info.rb +187 -0
  296. data/lib/harbor2_client/models/tag.rb +1 -1
  297. data/lib/harbor2_client/models/task.rb +1 -1
  298. data/lib/harbor2_client/models/user_creation_req.rb +250 -0
  299. data/lib/harbor2_client/models/user_entity.rb +195 -0
  300. data/lib/harbor2_client/models/user_group.rb +215 -0
  301. data/lib/harbor2_client/models/user_profile.rb +202 -0
  302. data/lib/harbor2_client/models/user_resp.rb +268 -0
  303. data/lib/harbor2_client/models/user_search.rb +194 -0
  304. data/lib/harbor2_client/models/user_search_resp_item.rb +194 -0
  305. data/lib/harbor2_client/models/user_sys_admin_flag.rb +185 -0
  306. data/lib/harbor2_client/models/vulnerability_summary.rb +1 -1
  307. data/lib/harbor2_client/models/webhook_job.rb +256 -0
  308. data/lib/harbor2_client/models/webhook_last_trigger.rb +226 -0
  309. data/lib/harbor2_client/models/webhook_policy.rb +278 -0
  310. data/lib/harbor2_client/models/webhook_target_object.rb +216 -0
  311. data/lib/harbor2_client/version.rb +2 -2
  312. data/lib/harbor2_client.rb +127 -1
  313. data/spec/api/artifact_api_spec.rb +21 -1
  314. data/spec/api/auditlog_api_spec.rb +2 -1
  315. data/spec/api/configure_api_spec.rb +72 -0
  316. data/spec/api/gc_api_spec.rb +115 -0
  317. data/spec/api/health_api_spec.rb +47 -0
  318. data/spec/api/icon_api_spec.rb +1 -1
  319. data/spec/api/immutable_api_spec.rb +97 -0
  320. data/spec/api/label_api_spec.rb +107 -0
  321. data/spec/api/ldap_api_spec.rb +88 -0
  322. data/spec/api/member_api_spec.rb +112 -0
  323. data/spec/api/oidc_api_spec.rb +48 -0
  324. data/spec/api/ping_api_spec.rb +47 -0
  325. data/spec/api/preheat_api_spec.rb +5 -1
  326. data/spec/api/project_api_spec.rb +63 -6
  327. data/spec/api/project_metadata_api_spec.rb +110 -0
  328. data/spec/api/quota_api_spec.rb +79 -0
  329. data/spec/api/registry_api_spec.rb +155 -0
  330. data/spec/api/replication_api_spec.rb +194 -0
  331. data/spec/api/repository_api_spec.rb +18 -1
  332. data/spec/api/retention_api_spec.rb +175 -0
  333. data/spec/api/robot_api_spec.rb +118 -0
  334. data/spec/api/robotv1_api_spec.rb +114 -0
  335. data/spec/api/scan_all_api_spec.rb +97 -0
  336. data/spec/api/scan_api_spec.rb +1 -1
  337. data/spec/api/scanner_api_spec.rb +144 -0
  338. data/spec/api/search_api_spec.rb +48 -0
  339. data/spec/api/statistic_api_spec.rb +47 -0
  340. data/spec/api/system_cve_allowlist_api_spec.rb +60 -0
  341. data/spec/api/systeminfo_api_spec.rb +71 -0
  342. data/spec/api/user_api_spec.rb +181 -0
  343. data/spec/api/usergroup_api_spec.rb +100 -0
  344. data/spec/api/webhook_api_spec.rb +142 -0
  345. data/spec/api/webhookjob_api_spec.rb +55 -0
  346. data/spec/api_client_spec.rb +1 -1
  347. data/spec/configuration_spec.rb +1 -1
  348. data/spec/models/access_spec.rb +53 -0
  349. data/spec/models/addition_link_spec.rb +1 -1
  350. data/spec/models/addition_links_spec.rb +1 -1
  351. data/spec/models/annotations_spec.rb +1 -1
  352. data/spec/models/artifact_spec.rb +1 -1
  353. data/spec/models/audit_log_spec.rb +1 -1
  354. data/spec/models/authproxy_setting_spec.rb +65 -0
  355. data/spec/models/body_1_spec.rb +41 -0
  356. data/spec/models/body_spec.rb +41 -0
  357. data/spec/models/bool_config_item_spec.rb +47 -0
  358. data/spec/models/chart_metadata_spec.rb +101 -0
  359. data/spec/models/chart_version_spec.rb +131 -0
  360. data/spec/models/component_health_status_spec.rb +53 -0
  361. data/spec/models/configurations_response_scan_all_policy_parameter_spec.rb +41 -0
  362. data/spec/models/configurations_response_scan_all_policy_spec.rb +47 -0
  363. data/spec/models/configurations_response_spec.rb +353 -0
  364. data/spec/models/configurations_spec.rb +365 -0
  365. data/spec/models/cve_allowlist_item_spec.rb +1 -1
  366. data/spec/models/cve_allowlist_spec.rb +1 -1
  367. data/spec/models/endpoint_spec.rb +47 -0
  368. data/spec/models/error_spec.rb +1 -1
  369. data/spec/models/errors_spec.rb +1 -1
  370. data/spec/models/event_type_spec.rb +35 -0
  371. data/spec/models/execution_spec.rb +1 -1
  372. data/spec/models/extra_attrs_spec.rb +1 -1
  373. data/spec/models/filter_style_spec.rb +53 -0
  374. data/spec/models/gc_history_spec.rb +89 -0
  375. data/spec/models/general_info_spec.rb +113 -0
  376. data/spec/models/icon_spec.rb +1 -1
  377. data/spec/models/immutable_rule_spec.rb +83 -0
  378. data/spec/models/immutable_selector_spec.rb +59 -0
  379. data/spec/models/instance_spec.rb +1 -1
  380. data/spec/models/integer_config_item_spec.rb +47 -0
  381. data/spec/models/internal_configurations_response_spec.rb +35 -0
  382. data/spec/models/is_default_spec.rb +41 -0
  383. data/spec/models/label_spec.rb +1 -1
  384. data/spec/models/ldap_conf_spec.rb +89 -0
  385. data/spec/models/ldap_failed_import_user_spec.rb +47 -0
  386. data/spec/models/ldap_import_users_spec.rb +41 -0
  387. data/spec/models/ldap_ping_result_spec.rb +47 -0
  388. data/spec/models/ldap_user_spec.rb +53 -0
  389. data/spec/models/metadata_spec.rb +1 -1
  390. data/spec/models/metrics_spec.rb +1 -1
  391. data/spec/models/native_report_summary_spec.rb +7 -1
  392. data/spec/models/notify_type_spec.rb +35 -0
  393. data/spec/models/oidc_cli_secret_req_spec.rb +41 -0
  394. data/spec/models/oidc_user_info_spec.rb +71 -0
  395. data/spec/models/overall_health_status_spec.rb +47 -0
  396. data/spec/models/password_req_spec.rb +47 -0
  397. data/spec/models/permission_spec.rb +47 -0
  398. data/spec/models/platform_spec.rb +1 -1
  399. data/spec/models/preheat_policy_spec.rb +1 -1
  400. data/spec/models/project_deletable_spec.rb +1 -1
  401. data/spec/models/project_member_entity_spec.rb +77 -0
  402. data/spec/models/project_member_spec.rb +53 -0
  403. data/spec/models/project_metadata_spec.rb +1 -1
  404. data/spec/models/project_req_spec.rb +1 -1
  405. data/spec/models/project_scanner_spec.rb +41 -0
  406. data/spec/models/project_spec.rb +1 -1
  407. data/spec/models/project_summary_quota_spec.rb +1 -1
  408. data/spec/models/project_summary_spec.rb +1 -1
  409. data/spec/models/provider_under_project_spec.rb +1 -1
  410. data/spec/models/quota_ref_object_spec.rb +35 -0
  411. data/spec/models/quota_spec.rb +71 -0
  412. data/spec/models/quota_update_req_spec.rb +41 -0
  413. data/spec/models/reference_spec.rb +1 -1
  414. data/spec/models/registry_credential_spec.rb +1 -1
  415. data/spec/models/registry_endpoint_spec.rb +47 -0
  416. data/spec/models/registry_info_spec.rb +59 -0
  417. data/spec/models/registry_ping_spec.rb +77 -0
  418. data/spec/models/registry_provider_credential_pattern_spec.rb +59 -0
  419. data/spec/models/registry_provider_endpoint_pattern_spec.rb +47 -0
  420. data/spec/models/registry_provider_info_spec.rb +47 -0
  421. data/spec/models/registry_spec.rb +1 -1
  422. data/spec/models/registry_update_spec.rb +77 -0
  423. data/spec/models/replication_execution_spec.rb +107 -0
  424. data/spec/models/replication_filter_spec.rb +47 -0
  425. data/spec/models/replication_policy_spec.rb +125 -0
  426. data/spec/models/replication_task_spec.rb +95 -0
  427. data/spec/models/replication_trigger_settings_spec.rb +41 -0
  428. data/spec/models/replication_trigger_spec.rb +47 -0
  429. data/spec/models/repository_spec.rb +1 -1
  430. data/spec/models/resource_list_spec.rb +1 -1
  431. data/spec/models/retention_execution_spec.rb +77 -0
  432. data/spec/models/retention_execution_task_spec.rb +101 -0
  433. data/spec/models/retention_metadata_spec.rb +53 -0
  434. data/spec/models/retention_policy_scope_spec.rb +47 -0
  435. data/spec/models/retention_policy_spec.rb +65 -0
  436. data/spec/models/retention_rule_metadata_spec.rb +59 -0
  437. data/spec/models/retention_rule_param_metadata_spec.rb +53 -0
  438. data/spec/models/retention_rule_spec.rb +83 -0
  439. data/spec/models/retention_rule_trigger_spec.rb +53 -0
  440. data/spec/models/retention_selector_metadata_spec.rb +53 -0
  441. data/spec/models/retention_selector_spec.rb +59 -0
  442. data/spec/models/robot_create_spec.rb +77 -0
  443. data/spec/models/robot_create_v1_spec.rb +59 -0
  444. data/spec/models/robot_created_spec.rb +65 -0
  445. data/spec/models/robot_permission_spec.rb +53 -0
  446. data/spec/models/robot_sec_spec.rb +41 -0
  447. data/spec/models/robot_spec.rb +107 -0
  448. data/spec/models/role_request_spec.rb +41 -0
  449. data/spec/models/scan_overview_spec.rb +1 -1
  450. data/spec/models/scanner_adapter_metadata_spec.rb +53 -0
  451. data/spec/models/scanner_capability_spec.rb +47 -0
  452. data/spec/models/scanner_registration_req_spec.rb +83 -0
  453. data/spec/models/scanner_registration_settings_spec.rb +59 -0
  454. data/spec/models/scanner_registration_spec.rb +131 -0
  455. data/spec/models/scanner_spec.rb +53 -0
  456. data/spec/models/schedule_obj_spec.rb +51 -0
  457. data/spec/models/schedule_spec.rb +71 -0
  458. data/spec/models/search_repository_spec.rb +71 -0
  459. data/spec/models/search_result_spec.rb +53 -0
  460. data/spec/models/search_spec.rb +53 -0
  461. data/spec/models/start_replication_execution_spec.rb +41 -0
  462. data/spec/models/statistic_spec.rb +77 -0
  463. data/spec/models/stats_spec.rb +69 -0
  464. data/spec/models/storage_spec.rb +47 -0
  465. data/spec/models/string_config_item_spec.rb +47 -0
  466. data/spec/models/supported_webhook_event_types_spec.rb +47 -0
  467. data/spec/models/system_info_spec.rb +41 -0
  468. data/spec/models/tag_spec.rb +1 -1
  469. data/spec/models/task_spec.rb +1 -1
  470. data/spec/models/user_creation_req_spec.rb +65 -0
  471. data/spec/models/user_entity_spec.rb +47 -0
  472. data/spec/models/user_group_spec.rb +59 -0
  473. data/spec/models/user_profile_spec.rb +53 -0
  474. data/spec/models/user_resp_spec.rb +95 -0
  475. data/spec/models/user_search_resp_item_spec.rb +47 -0
  476. data/spec/models/user_search_spec.rb +47 -0
  477. data/spec/models/user_sys_admin_flag_spec.rb +41 -0
  478. data/spec/models/vulnerability_summary_spec.rb +1 -1
  479. data/spec/models/webhook_job_spec.rb +83 -0
  480. data/spec/models/webhook_last_trigger_spec.rb +65 -0
  481. data/spec/models/webhook_policy_spec.rb +95 -0
  482. data/spec/models/webhook_target_object_spec.rb +59 -0
  483. data/spec/spec_helper.rb +1 -1
  484. metadata +512 -7
data/docs/GcApi.md ADDED
@@ -0,0 +1,356 @@
1
+ # Harbor2Client::GcApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_gc_schedule**](GcApi.md#create_gc_schedule) | **POST** /system/gc/schedule | Create a gc schedule.
8
+ [**get_gc**](GcApi.md#get_gc) | **GET** /system/gc/{gc_id} | Get gc status.
9
+ [**get_gc_history**](GcApi.md#get_gc_history) | **GET** /system/gc | Get gc results.
10
+ [**get_gc_log**](GcApi.md#get_gc_log) | **GET** /system/gc/{gc_id}/log | Get gc job log.
11
+ [**get_gc_schedule**](GcApi.md#get_gc_schedule) | **GET** /system/gc/schedule | Get gc's schedule.
12
+ [**update_gc_schedule**](GcApi.md#update_gc_schedule) | **PUT** /system/gc/schedule | Update gc's schedule.
13
+
14
+
15
+ # **create_gc_schedule**
16
+ > create_gc_schedule(schedule, opts)
17
+
18
+ Create a gc schedule.
19
+
20
+ This endpoint is for update gc schedule.
21
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'harbor2_client'
26
+ # setup authorization
27
+ Harbor2Client.configure do |config|
28
+ # Configure HTTP basic authorization: basic
29
+ config.username = 'YOUR USERNAME'
30
+ config.password = 'YOUR PASSWORD'
31
+ end
32
+
33
+ api_instance = Harbor2Client::GcApi.new
34
+
35
+ schedule = Harbor2Client::Schedule.new # Schedule | Updates of gc's schedule.
36
+
37
+ opts = {
38
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
39
+ }
40
+
41
+ begin
42
+ #Create a gc schedule.
43
+ api_instance.create_gc_schedule(schedule, opts)
44
+ rescue Harbor2Client::ApiError => e
45
+ puts "Exception when calling GcApi->create_gc_schedule: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **schedule** | [**Schedule**](Schedule.md)| Updates of gc's schedule. |
54
+ **x_request_id** | **String**| An unique ID for the request | [optional]
55
+
56
+ ### Return type
57
+
58
+ nil (empty response body)
59
+
60
+ ### Authorization
61
+
62
+ [basic](../README.md#basic)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json
67
+ - **Accept**: application/json
68
+
69
+
70
+
71
+ # **get_gc**
72
+ > GCHistory get_gc(gc_id, opts)
73
+
74
+ Get gc status.
75
+
76
+ This endpoint let user get gc status filtered by specific ID.
77
+
78
+ ### Example
79
+ ```ruby
80
+ # load the gem
81
+ require 'harbor2_client'
82
+ # setup authorization
83
+ Harbor2Client.configure do |config|
84
+ # Configure HTTP basic authorization: basic
85
+ config.username = 'YOUR USERNAME'
86
+ config.password = 'YOUR PASSWORD'
87
+ end
88
+
89
+ api_instance = Harbor2Client::GcApi.new
90
+
91
+ gc_id = 789 # Integer | The ID of the gc log
92
+
93
+ opts = {
94
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
95
+ }
96
+
97
+ begin
98
+ #Get gc status.
99
+ result = api_instance.get_gc(gc_id, opts)
100
+ p result
101
+ rescue Harbor2Client::ApiError => e
102
+ puts "Exception when calling GcApi->get_gc: #{e}"
103
+ end
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ Name | Type | Description | Notes
109
+ ------------- | ------------- | ------------- | -------------
110
+ **gc_id** | **Integer**| The ID of the gc log |
111
+ **x_request_id** | **String**| An unique ID for the request | [optional]
112
+
113
+ ### Return type
114
+
115
+ [**GCHistory**](GCHistory.md)
116
+
117
+ ### Authorization
118
+
119
+ [basic](../README.md#basic)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: application/json
124
+ - **Accept**: application/json
125
+
126
+
127
+
128
+ # **get_gc_history**
129
+ > Array<GCHistory> get_gc_history(opts)
130
+
131
+ Get gc results.
132
+
133
+ This endpoint let user get gc execution history.
134
+
135
+ ### Example
136
+ ```ruby
137
+ # load the gem
138
+ require 'harbor2_client'
139
+ # setup authorization
140
+ Harbor2Client.configure do |config|
141
+ # Configure HTTP basic authorization: basic
142
+ config.username = 'YOUR USERNAME'
143
+ config.password = 'YOUR PASSWORD'
144
+ end
145
+
146
+ api_instance = Harbor2Client::GcApi.new
147
+
148
+ opts = {
149
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
150
+ q: 'q_example', # String | Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
151
+ sort: 'sort_example', # String | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
152
+ page: 1, # Integer | The page number
153
+ page_size: 10, # Integer | The size of per page
154
+ }
155
+
156
+ begin
157
+ #Get gc results.
158
+ result = api_instance.get_gc_history(opts)
159
+ p result
160
+ rescue Harbor2Client::ApiError => e
161
+ puts "Exception when calling GcApi->get_gc_history: #{e}"
162
+ end
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ Name | Type | Description | Notes
168
+ ------------- | ------------- | ------------- | -------------
169
+ **x_request_id** | **String**| An unique ID for the request | [optional]
170
+ **q** | **String**| Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max] | [optional]
171
+ **sort** | **String**| Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\" | [optional]
172
+ **page** | **Integer**| The page number | [optional] [default to 1]
173
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
174
+
175
+ ### Return type
176
+
177
+ [**Array<GCHistory>**](GCHistory.md)
178
+
179
+ ### Authorization
180
+
181
+ [basic](../README.md#basic)
182
+
183
+ ### HTTP request headers
184
+
185
+ - **Content-Type**: application/json
186
+ - **Accept**: application/json
187
+
188
+
189
+
190
+ # **get_gc_log**
191
+ > String get_gc_log(gc_id, opts)
192
+
193
+ Get gc job log.
194
+
195
+ This endpoint let user get gc job logs filtered by specific ID.
196
+
197
+ ### Example
198
+ ```ruby
199
+ # load the gem
200
+ require 'harbor2_client'
201
+ # setup authorization
202
+ Harbor2Client.configure do |config|
203
+ # Configure HTTP basic authorization: basic
204
+ config.username = 'YOUR USERNAME'
205
+ config.password = 'YOUR PASSWORD'
206
+ end
207
+
208
+ api_instance = Harbor2Client::GcApi.new
209
+
210
+ gc_id = 789 # Integer | The ID of the gc log
211
+
212
+ opts = {
213
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
214
+ }
215
+
216
+ begin
217
+ #Get gc job log.
218
+ result = api_instance.get_gc_log(gc_id, opts)
219
+ p result
220
+ rescue Harbor2Client::ApiError => e
221
+ puts "Exception when calling GcApi->get_gc_log: #{e}"
222
+ end
223
+ ```
224
+
225
+ ### Parameters
226
+
227
+ Name | Type | Description | Notes
228
+ ------------- | ------------- | ------------- | -------------
229
+ **gc_id** | **Integer**| The ID of the gc log |
230
+ **x_request_id** | **String**| An unique ID for the request | [optional]
231
+
232
+ ### Return type
233
+
234
+ **String**
235
+
236
+ ### Authorization
237
+
238
+ [basic](../README.md#basic)
239
+
240
+ ### HTTP request headers
241
+
242
+ - **Content-Type**: application/json
243
+ - **Accept**: text/plain
244
+
245
+
246
+
247
+ # **get_gc_schedule**
248
+ > GCHistory get_gc_schedule(opts)
249
+
250
+ Get gc's schedule.
251
+
252
+ This endpoint is for get schedule of gc job.
253
+
254
+ ### Example
255
+ ```ruby
256
+ # load the gem
257
+ require 'harbor2_client'
258
+ # setup authorization
259
+ Harbor2Client.configure do |config|
260
+ # Configure HTTP basic authorization: basic
261
+ config.username = 'YOUR USERNAME'
262
+ config.password = 'YOUR PASSWORD'
263
+ end
264
+
265
+ api_instance = Harbor2Client::GcApi.new
266
+
267
+ opts = {
268
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
269
+ }
270
+
271
+ begin
272
+ #Get gc's schedule.
273
+ result = api_instance.get_gc_schedule(opts)
274
+ p result
275
+ rescue Harbor2Client::ApiError => e
276
+ puts "Exception when calling GcApi->get_gc_schedule: #{e}"
277
+ end
278
+ ```
279
+
280
+ ### Parameters
281
+
282
+ Name | Type | Description | Notes
283
+ ------------- | ------------- | ------------- | -------------
284
+ **x_request_id** | **String**| An unique ID for the request | [optional]
285
+
286
+ ### Return type
287
+
288
+ [**GCHistory**](GCHistory.md)
289
+
290
+ ### Authorization
291
+
292
+ [basic](../README.md#basic)
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: application/json
297
+ - **Accept**: application/json
298
+
299
+
300
+
301
+ # **update_gc_schedule**
302
+ > update_gc_schedule(schedule, opts)
303
+
304
+ Update gc's schedule.
305
+
306
+ This endpoint is for update gc schedule.
307
+
308
+ ### Example
309
+ ```ruby
310
+ # load the gem
311
+ require 'harbor2_client'
312
+ # setup authorization
313
+ Harbor2Client.configure do |config|
314
+ # Configure HTTP basic authorization: basic
315
+ config.username = 'YOUR USERNAME'
316
+ config.password = 'YOUR PASSWORD'
317
+ end
318
+
319
+ api_instance = Harbor2Client::GcApi.new
320
+
321
+ schedule = Harbor2Client::Schedule.new # Schedule | Updates of gc's schedule.
322
+
323
+ opts = {
324
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
325
+ }
326
+
327
+ begin
328
+ #Update gc's schedule.
329
+ api_instance.update_gc_schedule(schedule, opts)
330
+ rescue Harbor2Client::ApiError => e
331
+ puts "Exception when calling GcApi->update_gc_schedule: #{e}"
332
+ end
333
+ ```
334
+
335
+ ### Parameters
336
+
337
+ Name | Type | Description | Notes
338
+ ------------- | ------------- | ------------- | -------------
339
+ **schedule** | [**Schedule**](Schedule.md)| Updates of gc's schedule. |
340
+ **x_request_id** | **String**| An unique ID for the request | [optional]
341
+
342
+ ### Return type
343
+
344
+ nil (empty response body)
345
+
346
+ ### Authorization
347
+
348
+ [basic](../README.md#basic)
349
+
350
+ ### HTTP request headers
351
+
352
+ - **Content-Type**: application/json
353
+ - **Accept**: application/json
354
+
355
+
356
+
@@ -0,0 +1,20 @@
1
+ # Harbor2Client::GeneralInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **with_notary** | **BOOLEAN** | If the Harbor instance is deployed with nested notary. | [optional]
7
+ **with_chartmuseum** | **BOOLEAN** | If the Harbor instance is deployed with nested chartmuseum. | [optional]
8
+ **registry_url** | **String** | The url of registry against which the docker command should be issued. | [optional]
9
+ **external_url** | **String** | The external URL of Harbor, with protocol. | [optional]
10
+ **auth_mode** | **String** | The auth mode of current Harbor instance. | [optional]
11
+ **project_creation_restriction** | **String** | Indicate who can create projects, it could be 'adminonly' or 'everyone'. | [optional]
12
+ **self_registration** | **BOOLEAN** | Indicate whether the Harbor instance enable user to register himself. | [optional]
13
+ **has_ca_root** | **BOOLEAN** | Indicate whether there is a ca root cert file ready for download in the file system. | [optional]
14
+ **harbor_version** | **String** | The build version of Harbor. | [optional]
15
+ **registry_storage_provider_name** | **String** | The storage provider's name of Harbor registry | [optional]
16
+ **read_only** | **BOOLEAN** | The flag to indicate whether Harbor is in readonly mode. | [optional]
17
+ **notification_enable** | **BOOLEAN** | The flag to indicate whether notification mechanism is enabled on Harbor instance. | [optional]
18
+ **authproxy_settings** | [**AuthproxySetting**](AuthproxySetting.md) | The setting of auth proxy this is only available when Harbor relies on authproxy for authentication. | [optional]
19
+
20
+
data/docs/HealthApi.md ADDED
@@ -0,0 +1,63 @@
1
+ # Harbor2Client::HealthApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_health**](HealthApi.md#get_health) | **GET** /health | Check the status of Harbor components
8
+
9
+
10
+ # **get_health**
11
+ > OverallHealthStatus get_health(opts)
12
+
13
+ Check the status of Harbor components
14
+
15
+ Check the status of Harbor components
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'harbor2_client'
21
+ # setup authorization
22
+ Harbor2Client.configure do |config|
23
+ # Configure HTTP basic authorization: basic
24
+ config.username = 'YOUR USERNAME'
25
+ config.password = 'YOUR PASSWORD'
26
+ end
27
+
28
+ api_instance = Harbor2Client::HealthApi.new
29
+
30
+ opts = {
31
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
32
+ }
33
+
34
+ begin
35
+ #Check the status of Harbor components
36
+ result = api_instance.get_health(opts)
37
+ p result
38
+ rescue Harbor2Client::ApiError => e
39
+ puts "Exception when calling HealthApi->get_health: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **x_request_id** | **String**| An unique ID for the request | [optional]
48
+
49
+ ### Return type
50
+
51
+ [**OverallHealthStatus**](OverallHealthStatus.md)
52
+
53
+ ### Authorization
54
+
55
+ [basic](../README.md#basic)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: application/json
60
+ - **Accept**: application/json
61
+
62
+
63
+
@@ -0,0 +1,261 @@
1
+ # Harbor2Client::ImmutableApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_immu_rule**](ImmutableApi.md#create_immu_rule) | **POST** /projects/{project_name_or_id}/immutabletagrules | Add an immutable tag rule to current project
8
+ [**delete_immu_rule**](ImmutableApi.md#delete_immu_rule) | **DELETE** /projects/{project_name_or_id}/immutabletagrules/{immutable_rule_id} | Delete the immutable tag rule.
9
+ [**list_immu_rules**](ImmutableApi.md#list_immu_rules) | **GET** /projects/{project_name_or_id}/immutabletagrules | List all immutable tag rules of current project
10
+ [**update_immu_rule**](ImmutableApi.md#update_immu_rule) | **PUT** /projects/{project_name_or_id}/immutabletagrules/{immutable_rule_id} | Update the immutable tag rule or enable or disable the rule
11
+
12
+
13
+ # **create_immu_rule**
14
+ > create_immu_rule(project_name_or_idimmutable_rule, opts)
15
+
16
+ Add an immutable tag rule to current project
17
+
18
+ This endpoint add an immutable tag rule to the project
19
+
20
+ ### Example
21
+ ```ruby
22
+ # load the gem
23
+ require 'harbor2_client'
24
+ # setup authorization
25
+ Harbor2Client.configure do |config|
26
+ # Configure HTTP basic authorization: basic
27
+ config.username = 'YOUR USERNAME'
28
+ config.password = 'YOUR PASSWORD'
29
+ end
30
+
31
+ api_instance = Harbor2Client::ImmutableApi.new
32
+
33
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
34
+
35
+ immutable_rule = Harbor2Client::ImmutableRule.new # ImmutableRule |
36
+
37
+ opts = {
38
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
39
+ x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
40
+ }
41
+
42
+ begin
43
+ #Add an immutable tag rule to current project
44
+ api_instance.create_immu_rule(project_name_or_idimmutable_rule, opts)
45
+ rescue Harbor2Client::ApiError => e
46
+ puts "Exception when calling ImmutableApi->create_immu_rule: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ Name | Type | Description | Notes
53
+ ------------- | ------------- | ------------- | -------------
54
+ **project_name_or_id** | **String**| The name or id of the project |
55
+ **immutable_rule** | [**ImmutableRule**](ImmutableRule.md)| |
56
+ **x_request_id** | **String**| An unique ID for the request | [optional]
57
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
58
+
59
+ ### Return type
60
+
61
+ nil (empty response body)
62
+
63
+ ### Authorization
64
+
65
+ [basic](../README.md#basic)
66
+
67
+ ### HTTP request headers
68
+
69
+ - **Content-Type**: application/json
70
+ - **Accept**: application/json
71
+
72
+
73
+
74
+ # **delete_immu_rule**
75
+ > delete_immu_rule(project_name_or_idimmutable_rule_id, opts)
76
+
77
+ Delete the immutable tag rule.
78
+
79
+ ### Example
80
+ ```ruby
81
+ # load the gem
82
+ require 'harbor2_client'
83
+ # setup authorization
84
+ Harbor2Client.configure do |config|
85
+ # Configure HTTP basic authorization: basic
86
+ config.username = 'YOUR USERNAME'
87
+ config.password = 'YOUR PASSWORD'
88
+ end
89
+
90
+ api_instance = Harbor2Client::ImmutableApi.new
91
+
92
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
93
+
94
+ immutable_rule_id = 789 # Integer | The ID of the immutable rule
95
+
96
+ opts = {
97
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
98
+ x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
99
+ }
100
+
101
+ begin
102
+ #Delete the immutable tag rule.
103
+ api_instance.delete_immu_rule(project_name_or_idimmutable_rule_id, opts)
104
+ rescue Harbor2Client::ApiError => e
105
+ puts "Exception when calling ImmutableApi->delete_immu_rule: #{e}"
106
+ end
107
+ ```
108
+
109
+ ### Parameters
110
+
111
+ Name | Type | Description | Notes
112
+ ------------- | ------------- | ------------- | -------------
113
+ **project_name_or_id** | **String**| The name or id of the project |
114
+ **immutable_rule_id** | **Integer**| The ID of the immutable rule |
115
+ **x_request_id** | **String**| An unique ID for the request | [optional]
116
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
117
+
118
+ ### Return type
119
+
120
+ nil (empty response body)
121
+
122
+ ### Authorization
123
+
124
+ [basic](../README.md#basic)
125
+
126
+ ### HTTP request headers
127
+
128
+ - **Content-Type**: application/json
129
+ - **Accept**: application/json
130
+
131
+
132
+
133
+ # **list_immu_rules**
134
+ > Array<ImmutableRule> list_immu_rules(project_name_or_id, opts)
135
+
136
+ List all immutable tag rules of current project
137
+
138
+ This endpoint returns the immutable tag rules of a project
139
+
140
+ ### Example
141
+ ```ruby
142
+ # load the gem
143
+ require 'harbor2_client'
144
+ # setup authorization
145
+ Harbor2Client.configure do |config|
146
+ # Configure HTTP basic authorization: basic
147
+ config.username = 'YOUR USERNAME'
148
+ config.password = 'YOUR PASSWORD'
149
+ end
150
+
151
+ api_instance = Harbor2Client::ImmutableApi.new
152
+
153
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
154
+
155
+ opts = {
156
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
157
+ x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
158
+ page: 1, # Integer | The page number
159
+ page_size: 10, # Integer | The size of per page
160
+ q: 'q_example', # String | Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
161
+ sort: 'sort_example', # String | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
162
+ }
163
+
164
+ begin
165
+ #List all immutable tag rules of current project
166
+ result = api_instance.list_immu_rules(project_name_or_id, opts)
167
+ p result
168
+ rescue Harbor2Client::ApiError => e
169
+ puts "Exception when calling ImmutableApi->list_immu_rules: #{e}"
170
+ end
171
+ ```
172
+
173
+ ### Parameters
174
+
175
+ Name | Type | Description | Notes
176
+ ------------- | ------------- | ------------- | -------------
177
+ **project_name_or_id** | **String**| The name or id of the project |
178
+ **x_request_id** | **String**| An unique ID for the request | [optional]
179
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
180
+ **page** | **Integer**| The page number | [optional] [default to 1]
181
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
182
+ **q** | **String**| Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max] | [optional]
183
+ **sort** | **String**| Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\" | [optional]
184
+
185
+ ### Return type
186
+
187
+ [**Array<ImmutableRule>**](ImmutableRule.md)
188
+
189
+ ### Authorization
190
+
191
+ [basic](../README.md#basic)
192
+
193
+ ### HTTP request headers
194
+
195
+ - **Content-Type**: application/json
196
+ - **Accept**: application/json
197
+
198
+
199
+
200
+ # **update_immu_rule**
201
+ > update_immu_rule(project_name_or_idimmutable_rule_idimmutable_rule, opts)
202
+
203
+ Update the immutable tag rule or enable or disable the rule
204
+
205
+ ### Example
206
+ ```ruby
207
+ # load the gem
208
+ require 'harbor2_client'
209
+ # setup authorization
210
+ Harbor2Client.configure do |config|
211
+ # Configure HTTP basic authorization: basic
212
+ config.username = 'YOUR USERNAME'
213
+ config.password = 'YOUR PASSWORD'
214
+ end
215
+
216
+ api_instance = Harbor2Client::ImmutableApi.new
217
+
218
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
219
+
220
+ immutable_rule_id = 789 # Integer | The ID of the immutable rule
221
+
222
+ immutable_rule = Harbor2Client::ImmutableRule.new # ImmutableRule |
223
+
224
+ opts = {
225
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
226
+ x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
227
+ }
228
+
229
+ begin
230
+ #Update the immutable tag rule or enable or disable the rule
231
+ api_instance.update_immu_rule(project_name_or_idimmutable_rule_idimmutable_rule, opts)
232
+ rescue Harbor2Client::ApiError => e
233
+ puts "Exception when calling ImmutableApi->update_immu_rule: #{e}"
234
+ end
235
+ ```
236
+
237
+ ### Parameters
238
+
239
+ Name | Type | Description | Notes
240
+ ------------- | ------------- | ------------- | -------------
241
+ **project_name_or_id** | **String**| The name or id of the project |
242
+ **immutable_rule_id** | **Integer**| The ID of the immutable rule |
243
+ **immutable_rule** | [**ImmutableRule**](ImmutableRule.md)| |
244
+ **x_request_id** | **String**| An unique ID for the request | [optional]
245
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
246
+
247
+ ### Return type
248
+
249
+ nil (empty response body)
250
+
251
+ ### Authorization
252
+
253
+ [basic](../README.md#basic)
254
+
255
+ ### HTTP request headers
256
+
257
+ - **Content-Type**: application/json
258
+ - **Accept**: application/json
259
+
260
+
261
+