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/ProjectApi.md CHANGED
@@ -5,14 +5,17 @@ All URIs are relative to *http://localhost/api/v2.0*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**create_project**](ProjectApi.md#create_project) | **POST** /projects | Create a new project.
8
- [**delete_project**](ProjectApi.md#delete_project) | **DELETE** /projects/{project_id} | Delete project by projectID
8
+ [**delete_project**](ProjectApi.md#delete_project) | **DELETE** /projects/{project_name_or_id} | Delete project by projectID
9
9
  [**get_logs**](ProjectApi.md#get_logs) | **GET** /projects/{project_name}/logs | Get recent logs of the projects
10
- [**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_id} | Return specific project detail information
11
- [**get_project_deletable**](ProjectApi.md#get_project_deletable) | **GET** /projects/{project_id}/_deletable | Get the deletable status of the project
12
- [**get_project_summary**](ProjectApi.md#get_project_summary) | **GET** /projects/{project_id}/summary | Get summary of the project.
10
+ [**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_name_or_id} | Return specific project detail information
11
+ [**get_project_deletable**](ProjectApi.md#get_project_deletable) | **GET** /projects/{project_name_or_id}/_deletable | Get the deletable status of the project
12
+ [**get_project_summary**](ProjectApi.md#get_project_summary) | **GET** /projects/{project_name_or_id}/summary | Get summary of the project.
13
+ [**get_scanner_of_project**](ProjectApi.md#get_scanner_of_project) | **GET** /projects/{project_name_or_id}/scanner | Get project level scanner
13
14
  [**head_project**](ProjectApi.md#head_project) | **HEAD** /projects | Check if the project name user provided already exists.
14
15
  [**list_projects**](ProjectApi.md#list_projects) | **GET** /projects | List projects
15
- [**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{project_id} | Update properties for a selected project.
16
+ [**list_scanner_candidates_of_project**](ProjectApi.md#list_scanner_candidates_of_project) | **GET** /projects/{project_name_or_id}/scanner/candidates | Get scanner registration candidates for configurating project level scanner
17
+ [**set_scanner_of_project**](ProjectApi.md#set_scanner_of_project) | **PUT** /projects/{project_name_or_id}/scanner | Configure scanner for the specified project
18
+ [**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{project_name_or_id} | Update properties for a selected project.
16
19
 
17
20
 
18
21
  # **create_project**
@@ -39,6 +42,7 @@ project = Harbor2Client::ProjectReq.new # ProjectReq | New created project.
39
42
 
40
43
  opts = {
41
44
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
45
+ x_resource_name_in_location: false # BOOLEAN | The flag to indicate whether to return the name of the resource in Location. When X-Resource-Name-In-Location is true, the Location will return the name of the resource.
42
46
  }
43
47
 
44
48
  begin
@@ -55,6 +59,7 @@ Name | Type | Description | Notes
55
59
  ------------- | ------------- | ------------- | -------------
56
60
  **project** | [**ProjectReq**](ProjectReq.md)| New created project. |
57
61
  **x_request_id** | **String**| An unique ID for the request | [optional]
62
+ **x_resource_name_in_location** | **BOOLEAN**| The flag to indicate whether to return the name of the resource in Location. When X-Resource-Name-In-Location is true, the Location will return the name of the resource. | [optional] [default to false]
58
63
 
59
64
  ### Return type
60
65
 
@@ -72,7 +77,7 @@ nil (empty response body)
72
77
 
73
78
 
74
79
  # **delete_project**
75
- > delete_project(project_id, opts)
80
+ > delete_project(project_name_or_id, opts)
76
81
 
77
82
  Delete project by projectID
78
83
 
@@ -91,15 +96,16 @@ end
91
96
 
92
97
  api_instance = Harbor2Client::ProjectApi.new
93
98
 
94
- project_id = 789 # Integer | The ID of the project
99
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
95
100
 
96
101
  opts = {
97
102
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
103
+ 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.
98
104
  }
99
105
 
100
106
  begin
101
107
  #Delete project by projectID
102
- api_instance.delete_project(project_id, opts)
108
+ api_instance.delete_project(project_name_or_id, opts)
103
109
  rescue Harbor2Client::ApiError => e
104
110
  puts "Exception when calling ProjectApi->delete_project: #{e}"
105
111
  end
@@ -109,8 +115,9 @@ end
109
115
 
110
116
  Name | Type | Description | Notes
111
117
  ------------- | ------------- | ------------- | -------------
112
- **project_id** | **Integer**| The ID of the project |
118
+ **project_name_or_id** | **String**| The name or id of the project |
113
119
  **x_request_id** | **String**| An unique ID for the request | [optional]
120
+ **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]
114
121
 
115
122
  ### Return type
116
123
 
@@ -151,7 +158,8 @@ project_name = 'project_name_example' # String | The name of the project
151
158
 
152
159
  opts = {
153
160
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
154
- 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
+ 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]
162
+ 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\"
155
163
  page: 1, # Integer | The page number
156
164
  page_size: 10, # Integer | The size of per page
157
165
  }
@@ -172,6 +180,7 @@ Name | Type | Description | Notes
172
180
  **project_name** | **String**| The name of the project |
173
181
  **x_request_id** | **String**| An unique ID for the request | [optional]
174
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]
175
184
  **page** | **Integer**| The page number | [optional] [default to 1]
176
185
  **page_size** | **Integer**| The size of per page | [optional] [default to 10]
177
186
 
@@ -191,7 +200,7 @@ Name | Type | Description | Notes
191
200
 
192
201
 
193
202
  # **get_project**
194
- > Project get_project(project_id, opts)
203
+ > Project get_project(project_name_or_id, opts)
195
204
 
196
205
  Return specific project detail information
197
206
 
@@ -210,15 +219,16 @@ end
210
219
 
211
220
  api_instance = Harbor2Client::ProjectApi.new
212
221
 
213
- project_id = 789 # Integer | The ID of the project
222
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
214
223
 
215
224
  opts = {
216
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.
217
227
  }
218
228
 
219
229
  begin
220
230
  #Return specific project detail information
221
- result = api_instance.get_project(project_id, opts)
231
+ result = api_instance.get_project(project_name_or_id, opts)
222
232
  p result
223
233
  rescue Harbor2Client::ApiError => e
224
234
  puts "Exception when calling ProjectApi->get_project: #{e}"
@@ -229,8 +239,9 @@ end
229
239
 
230
240
  Name | Type | Description | Notes
231
241
  ------------- | ------------- | ------------- | -------------
232
- **project_id** | **Integer**| The ID of the project |
242
+ **project_name_or_id** | **String**| The name or id of the project |
233
243
  **x_request_id** | **String**| An unique ID for the request | [optional]
244
+ **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]
234
245
 
235
246
  ### Return type
236
247
 
@@ -248,7 +259,7 @@ Name | Type | Description | Notes
248
259
 
249
260
 
250
261
  # **get_project_deletable**
251
- > ProjectDeletable get_project_deletable(project_id, opts)
262
+ > ProjectDeletable get_project_deletable(project_name_or_id, opts)
252
263
 
253
264
  Get the deletable status of the project
254
265
 
@@ -267,15 +278,16 @@ end
267
278
 
268
279
  api_instance = Harbor2Client::ProjectApi.new
269
280
 
270
- project_id = 789 # Integer | The ID of the project
281
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
271
282
 
272
283
  opts = {
273
284
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
285
+ 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.
274
286
  }
275
287
 
276
288
  begin
277
289
  #Get the deletable status of the project
278
- result = api_instance.get_project_deletable(project_id, opts)
290
+ result = api_instance.get_project_deletable(project_name_or_id, opts)
279
291
  p result
280
292
  rescue Harbor2Client::ApiError => e
281
293
  puts "Exception when calling ProjectApi->get_project_deletable: #{e}"
@@ -286,8 +298,9 @@ end
286
298
 
287
299
  Name | Type | Description | Notes
288
300
  ------------- | ------------- | ------------- | -------------
289
- **project_id** | **Integer**| The ID of the project |
301
+ **project_name_or_id** | **String**| The name or id of the project |
290
302
  **x_request_id** | **String**| An unique ID for the request | [optional]
303
+ **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]
291
304
 
292
305
  ### Return type
293
306
 
@@ -305,7 +318,7 @@ Name | Type | Description | Notes
305
318
 
306
319
 
307
320
  # **get_project_summary**
308
- > ProjectSummary get_project_summary(project_id, opts)
321
+ > ProjectSummary get_project_summary(project_name_or_id, opts)
309
322
 
310
323
  Get summary of the project.
311
324
 
@@ -324,15 +337,16 @@ end
324
337
 
325
338
  api_instance = Harbor2Client::ProjectApi.new
326
339
 
327
- project_id = 789 # Integer | The ID of the project
340
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
328
341
 
329
342
  opts = {
330
343
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
344
+ 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.
331
345
  }
332
346
 
333
347
  begin
334
348
  #Get summary of the project.
335
- result = api_instance.get_project_summary(project_id, opts)
349
+ result = api_instance.get_project_summary(project_name_or_id, opts)
336
350
  p result
337
351
  rescue Harbor2Client::ApiError => e
338
352
  puts "Exception when calling ProjectApi->get_project_summary: #{e}"
@@ -343,8 +357,9 @@ end
343
357
 
344
358
  Name | Type | Description | Notes
345
359
  ------------- | ------------- | ------------- | -------------
346
- **project_id** | **Integer**| The ID of the project |
360
+ **project_name_or_id** | **String**| The name or id of the project |
347
361
  **x_request_id** | **String**| An unique ID for the request | [optional]
362
+ **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]
348
363
 
349
364
  ### Return type
350
365
 
@@ -361,6 +376,65 @@ Name | Type | Description | Notes
361
376
 
362
377
 
363
378
 
379
+ # **get_scanner_of_project**
380
+ > ScannerRegistration get_scanner_of_project(project_name_or_id, opts)
381
+
382
+ Get project level scanner
383
+
384
+ Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.
385
+
386
+ ### Example
387
+ ```ruby
388
+ # load the gem
389
+ require 'harbor2_client'
390
+ # setup authorization
391
+ Harbor2Client.configure do |config|
392
+ # Configure HTTP basic authorization: basic
393
+ config.username = 'YOUR USERNAME'
394
+ config.password = 'YOUR PASSWORD'
395
+ end
396
+
397
+ api_instance = Harbor2Client::ProjectApi.new
398
+
399
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
400
+
401
+ opts = {
402
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
403
+ 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.
404
+ }
405
+
406
+ begin
407
+ #Get project level scanner
408
+ result = api_instance.get_scanner_of_project(project_name_or_id, opts)
409
+ p result
410
+ rescue Harbor2Client::ApiError => e
411
+ puts "Exception when calling ProjectApi->get_scanner_of_project: #{e}"
412
+ end
413
+ ```
414
+
415
+ ### Parameters
416
+
417
+ Name | Type | Description | Notes
418
+ ------------- | ------------- | ------------- | -------------
419
+ **project_name_or_id** | **String**| The name or id of the project |
420
+ **x_request_id** | **String**| An unique ID for the request | [optional]
421
+ **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]
422
+
423
+ ### Return type
424
+
425
+ [**ScannerRegistration**](ScannerRegistration.md)
426
+
427
+ ### Authorization
428
+
429
+ [basic](../README.md#basic)
430
+
431
+ ### HTTP request headers
432
+
433
+ - **Content-Type**: application/json
434
+ - **Accept**: application/json
435
+
436
+
437
+
364
438
  # **head_project**
365
439
  > head_project(project_name, opts)
366
440
 
@@ -439,11 +513,14 @@ api_instance = Harbor2Client::ProjectApi.new
439
513
 
440
514
  opts = {
441
515
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
516
+ 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]
442
517
  page: 1, # Integer | The page number
443
518
  page_size: 10, # Integer | The size of per page
519
+ 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\"
444
520
  name: 'name_example', # String | The name of project.
445
521
  public: true, # BOOLEAN | The project is public or private.
446
- owner: 'owner_example' # String | The name of project owner.
522
+ owner: 'owner_example', # String | The name of project owner.
523
+ with_detail: true # BOOLEAN | Bool value indicating whether return detailed information of the project
447
524
  }
448
525
 
449
526
  begin
@@ -460,11 +537,14 @@ end
460
537
  Name | Type | Description | Notes
461
538
  ------------- | ------------- | ------------- | -------------
462
539
  **x_request_id** | **String**| An unique ID for the request | [optional]
540
+ **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]
463
541
  **page** | **Integer**| The page number | [optional] [default to 1]
464
542
  **page_size** | **Integer**| The size of per page | [optional] [default to 10]
543
+ **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]
465
544
  **name** | **String**| The name of project. | [optional]
466
545
  **public** | **BOOLEAN**| The project is public or private. | [optional]
467
546
  **owner** | **String**| The name of project owner. | [optional]
547
+ **with_detail** | **BOOLEAN**| Bool value indicating whether return detailed information of the project | [optional] [default to true]
468
548
 
469
549
  ### Return type
470
550
 
@@ -481,8 +561,136 @@ Name | Type | Description | Notes
481
561
 
482
562
 
483
563
 
564
+ # **list_scanner_candidates_of_project**
565
+ > Array<ScannerRegistration> list_scanner_candidates_of_project(project_name_or_id, opts)
566
+
567
+ Get scanner registration candidates for configurating project level scanner
568
+
569
+ Retrieve the system configured scanner registrations as candidates of setting project level scanner.
570
+
571
+ ### Example
572
+ ```ruby
573
+ # load the gem
574
+ require 'harbor2_client'
575
+ # setup authorization
576
+ Harbor2Client.configure do |config|
577
+ # Configure HTTP basic authorization: basic
578
+ config.username = 'YOUR USERNAME'
579
+ config.password = 'YOUR PASSWORD'
580
+ end
581
+
582
+ api_instance = Harbor2Client::ProjectApi.new
583
+
584
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
585
+
586
+ opts = {
587
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
588
+ 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.
589
+ 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]
590
+ 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\"
591
+ page: 1, # Integer | The page number
592
+ page_size: 10, # Integer | The size of per page
593
+ }
594
+
595
+ begin
596
+ #Get scanner registration candidates for configurating project level scanner
597
+ result = api_instance.list_scanner_candidates_of_project(project_name_or_id, opts)
598
+ p result
599
+ rescue Harbor2Client::ApiError => e
600
+ puts "Exception when calling ProjectApi->list_scanner_candidates_of_project: #{e}"
601
+ end
602
+ ```
603
+
604
+ ### Parameters
605
+
606
+ Name | Type | Description | Notes
607
+ ------------- | ------------- | ------------- | -------------
608
+ **project_name_or_id** | **String**| The name or id of the project |
609
+ **x_request_id** | **String**| An unique ID for the request | [optional]
610
+ **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]
611
+ **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]
612
+ **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]
613
+ **page** | **Integer**| The page number | [optional] [default to 1]
614
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
615
+
616
+ ### Return type
617
+
618
+ [**Array<ScannerRegistration>**](ScannerRegistration.md)
619
+
620
+ ### Authorization
621
+
622
+ [basic](../README.md#basic)
623
+
624
+ ### HTTP request headers
625
+
626
+ - **Content-Type**: application/json
627
+ - **Accept**: application/json
628
+
629
+
630
+
631
+ # **set_scanner_of_project**
632
+ > set_scanner_of_project(project_name_or_idpayload, opts)
633
+
634
+ Configure scanner for the specified project
635
+
636
+ Set one of the system configured scanner registration as the indepndent scanner of the specified project.
637
+
638
+ ### Example
639
+ ```ruby
640
+ # load the gem
641
+ require 'harbor2_client'
642
+ # setup authorization
643
+ Harbor2Client.configure do |config|
644
+ # Configure HTTP basic authorization: basic
645
+ config.username = 'YOUR USERNAME'
646
+ config.password = 'YOUR PASSWORD'
647
+ end
648
+
649
+ api_instance = Harbor2Client::ProjectApi.new
650
+
651
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
652
+
653
+ payload = Harbor2Client::ProjectScanner.new # ProjectScanner |
654
+
655
+ opts = {
656
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
657
+ 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.
658
+ }
659
+
660
+ begin
661
+ #Configure scanner for the specified project
662
+ api_instance.set_scanner_of_project(project_name_or_idpayload, opts)
663
+ rescue Harbor2Client::ApiError => e
664
+ puts "Exception when calling ProjectApi->set_scanner_of_project: #{e}"
665
+ end
666
+ ```
667
+
668
+ ### Parameters
669
+
670
+ Name | Type | Description | Notes
671
+ ------------- | ------------- | ------------- | -------------
672
+ **project_name_or_id** | **String**| The name or id of the project |
673
+ **payload** | [**ProjectScanner**](ProjectScanner.md)| |
674
+ **x_request_id** | **String**| An unique ID for the request | [optional]
675
+ **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]
676
+
677
+ ### Return type
678
+
679
+ nil (empty response body)
680
+
681
+ ### Authorization
682
+
683
+ [basic](../README.md#basic)
684
+
685
+ ### HTTP request headers
686
+
687
+ - **Content-Type**: application/json
688
+ - **Accept**: application/json
689
+
690
+
691
+
484
692
  # **update_project**
485
- > update_project(project_idproject, opts)
693
+ > update_project(project_name_or_idproject, opts)
486
694
 
487
695
  Update properties for a selected project.
488
696
 
@@ -501,17 +709,18 @@ end
501
709
 
502
710
  api_instance = Harbor2Client::ProjectApi.new
503
711
 
504
- project_id = 789 # Integer | The ID of the project
712
+ project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
505
713
 
506
714
  project = Harbor2Client::ProjectReq.new # ProjectReq | Updates of project.
507
715
 
508
716
  opts = {
509
717
  x_request_id: 'x_request_id_example' # String | An unique ID for the request
718
+ 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.
510
719
  }
511
720
 
512
721
  begin
513
722
  #Update properties for a selected project.
514
- api_instance.update_project(project_idproject, opts)
723
+ api_instance.update_project(project_name_or_idproject, opts)
515
724
  rescue Harbor2Client::ApiError => e
516
725
  puts "Exception when calling ProjectApi->update_project: #{e}"
517
726
  end
@@ -521,9 +730,10 @@ end
521
730
 
522
731
  Name | Type | Description | Notes
523
732
  ------------- | ------------- | ------------- | -------------
524
- **project_id** | **Integer**| The ID of the project |
733
+ **project_name_or_id** | **String**| The name or id of the project |
525
734
  **project** | [**ProjectReq**](ProjectReq.md)| Updates of project. |
526
735
  **x_request_id** | **String**| An unique ID for the request | [optional]
736
+ **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]
527
737
 
528
738
  ### Return type
529
739
 
@@ -0,0 +1,10 @@
1
+ # Harbor2Client::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 maintainer | [optional]
7
+ **member_user** | [**UserEntity**](UserEntity.md) | | [optional]
8
+ **member_group** | [**UserGroup**](UserGroup.md) | | [optional]
9
+
10
+
@@ -0,0 +1,14 @@
1
+ # Harbor2Client::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
+