harbor2_client 0.2.0 → 2.3.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +241 -13
- data/build/generate.sh +8 -0
- data/build/swagger-codegen-cli-ruby-config.json +12 -0
- data/docs/Access.md +10 -0
- data/docs/ArtifactApi.md +76 -2
- data/docs/AuditlogApi.md +3 -1
- data/docs/AuthproxySetting.md +12 -0
- data/docs/Body.md +8 -0
- data/docs/Body1.md +8 -0
- data/docs/BoolConfigItem.md +9 -0
- data/docs/ChartMetadata.md +18 -0
- data/docs/ChartVersion.md +23 -0
- data/docs/ComponentHealthStatus.md +10 -0
- data/docs/Configurations.md +62 -0
- data/docs/ConfigurationsResponse.md +60 -0
- data/docs/ConfigurationsResponseScanAllPolicy.md +9 -0
- data/docs/ConfigurationsResponseScanAllPolicyParameter.md +8 -0
- data/docs/ConfigureApi.md +175 -0
- data/docs/Endpoint.md +9 -0
- data/docs/EventType.md +7 -0
- data/docs/FilterStyle.md +10 -0
- data/docs/GCHistory.md +16 -0
- data/docs/GcApi.md +356 -0
- data/docs/GeneralInfo.md +20 -0
- data/docs/HealthApi.md +63 -0
- data/docs/ImmutableApi.md +261 -0
- data/docs/ImmutableRule.md +15 -0
- data/docs/ImmutableSelector.md +11 -0
- data/docs/IntegerConfigItem.md +9 -0
- data/docs/InternalConfigurationsResponse.md +7 -0
- data/docs/IsDefault.md +8 -0
- data/docs/LabelApi.md +309 -0
- data/docs/LdapApi.md +238 -0
- data/docs/LdapConf.md +16 -0
- data/docs/LdapFailedImportUser.md +9 -0
- data/docs/LdapImportUsers.md +8 -0
- data/docs/LdapPingResult.md +9 -0
- data/docs/LdapUser.md +10 -0
- data/docs/MemberApi.md +322 -0
- data/docs/NativeReportSummary.md +1 -0
- data/docs/NotifyType.md +7 -0
- data/docs/OIDCCliSecretReq.md +8 -0
- data/docs/OIDCUserInfo.md +13 -0
- data/docs/OidcApi.md +65 -0
- data/docs/OverallHealthStatus.md +9 -0
- data/docs/PasswordReq.md +9 -0
- data/docs/Permission.md +9 -0
- data/docs/PingApi.md +63 -0
- data/docs/PreheatApi.md +12 -4
- data/docs/ProjectApi.md +237 -27
- data/docs/ProjectMember.md +10 -0
- data/docs/ProjectMemberEntity.md +14 -0
- data/docs/ProjectMetadataApi.md +318 -0
- data/docs/ProjectScanner.md +8 -0
- data/docs/Quota.md +13 -0
- data/docs/QuotaApi.md +191 -0
- data/docs/QuotaRefObject.md +7 -0
- data/docs/QuotaUpdateReq.md +8 -0
- data/docs/Registry.md +2 -2
- data/docs/RegistryApi.md +530 -0
- data/docs/RegistryEndpoint.md +9 -0
- data/docs/RegistryInfo.md +11 -0
- data/docs/RegistryPing.md +14 -0
- data/docs/RegistryProviderCredentialPattern.md +11 -0
- data/docs/RegistryProviderEndpointPattern.md +9 -0
- data/docs/RegistryProviderInfo.md +9 -0
- data/docs/RegistryUpdate.md +14 -0
- data/docs/ReplicationApi.md +673 -0
- data/docs/ReplicationExecution.md +19 -0
- data/docs/ReplicationFilter.md +9 -0
- data/docs/ReplicationPolicy.md +22 -0
- data/docs/ReplicationTask.md +17 -0
- data/docs/ReplicationTrigger.md +9 -0
- data/docs/ReplicationTriggerSettings.md +8 -0
- data/docs/RepositoryApi.md +66 -1
- data/docs/RetentionApi.md +609 -0
- data/docs/RetentionExecution.md +14 -0
- data/docs/RetentionExecutionTask.md +18 -0
- data/docs/RetentionMetadata.md +10 -0
- data/docs/RetentionPolicy.md +12 -0
- data/docs/RetentionPolicyScope.md +9 -0
- data/docs/RetentionRule.md +15 -0
- data/docs/RetentionRuleMetadata.md +11 -0
- data/docs/RetentionRuleParamMetadata.md +10 -0
- data/docs/RetentionRuleTrigger.md +10 -0
- data/docs/RetentionSelector.md +11 -0
- data/docs/RetentionSelectorMetadata.md +10 -0
- data/docs/Robot.md +19 -0
- data/docs/RobotApi.md +365 -0
- data/docs/RobotCreate.md +14 -0
- data/docs/RobotCreateV1.md +11 -0
- data/docs/RobotCreated.md +12 -0
- data/docs/RobotPermission.md +10 -0
- data/docs/RobotSec.md +8 -0
- data/docs/Robotv1Api.md +329 -0
- data/docs/RoleRequest.md +8 -0
- data/docs/ScanAllApi.md +287 -0
- data/docs/Scanner.md +10 -0
- data/docs/ScannerAdapterMetadata.md +10 -0
- data/docs/ScannerApi.md +479 -0
- data/docs/ScannerCapability.md +9 -0
- data/docs/ScannerRegistration.md +23 -0
- data/docs/ScannerRegistrationReq.md +15 -0
- data/docs/ScannerRegistrationSettings.md +11 -0
- data/docs/Schedule.md +13 -0
- data/docs/ScheduleObj.md +9 -0
- data/docs/Search.md +10 -0
- data/docs/SearchApi.md +66 -0
- data/docs/SearchRepository.md +13 -0
- data/docs/SearchResult.md +10 -0
- data/docs/StartReplicationExecution.md +8 -0
- data/docs/Statistic.md +14 -0
- data/docs/StatisticApi.md +63 -0
- data/docs/Stats.md +12 -0
- data/docs/Storage.md +9 -0
- data/docs/StringConfigItem.md +9 -0
- data/docs/SupportedWebhookEventTypes.md +9 -0
- data/docs/SystemCVEAllowlistApi.md +119 -0
- data/docs/SystemInfo.md +8 -0
- data/docs/SysteminfoApi.md +173 -0
- data/docs/UserApi.md +647 -0
- data/docs/UserCreationReq.md +12 -0
- data/docs/UserEntity.md +9 -0
- data/docs/UserGroup.md +11 -0
- data/docs/UserProfile.md +10 -0
- data/docs/UserResp.md +17 -0
- data/docs/UserSearch.md +9 -0
- data/docs/UserSearchRespItem.md +9 -0
- data/docs/UserSysAdminFlag.md +8 -0
- data/docs/UsergroupApi.md +293 -0
- data/docs/WebhookApi.md +448 -0
- data/docs/WebhookJob.md +15 -0
- data/docs/WebhookLastTrigger.md +12 -0
- data/docs/WebhookPolicy.md +17 -0
- data/docs/WebhookTargetObject.md +11 -0
- data/docs/WebhookjobApi.md +81 -0
- data/git_push.sh +3 -3
- data/harbor2_client.gemspec +7 -7
- data/lib/harbor2_client/api/artifact_api.rb +91 -3
- data/lib/harbor2_client/api/auditlog_api.rb +4 -1
- data/lib/harbor2_client/api/configure_api.rb +193 -0
- data/lib/harbor2_client/api/gc_api.rb +391 -0
- data/lib/harbor2_client/api/health_api.rb +78 -0
- data/lib/harbor2_client/api/icon_api.rb +1 -1
- data/lib/harbor2_client/api/immutable_api.rb +312 -0
- data/lib/harbor2_client/api/label_api.rb +350 -0
- data/lib/harbor2_client/api/ldap_api.rb +259 -0
- data/lib/harbor2_client/api/member_api.rb +373 -0
- data/lib/harbor2_client/api/oidc_api.rb +83 -0
- data/lib/harbor2_client/api/ping_api.rb +78 -0
- data/lib/harbor2_client/api/preheat_api.rb +13 -1
- data/lib/harbor2_client/api/project_api.rb +289 -46
- data/lib/harbor2_client/api/project_metadata_api.rb +362 -0
- data/lib/harbor2_client/api/quota_api.rb +224 -0
- data/lib/harbor2_client/api/registry_api.rb +575 -0
- data/lib/harbor2_client/api/replication_api.rb +749 -0
- data/lib/harbor2_client/api/repository_api.rb +75 -1
- data/lib/harbor2_client/api/retention_api.rb +676 -0
- data/lib/harbor2_client/api/robot_api.rb +409 -0
- data/lib/harbor2_client/api/robotv1_api.rb +387 -0
- data/lib/harbor2_client/api/scan_all_api.rb +308 -0
- data/lib/harbor2_client/api/scan_api.rb +1 -1
- data/lib/harbor2_client/api/scanner_api.rb +529 -0
- data/lib/harbor2_client/api/search_api.rb +85 -0
- data/lib/harbor2_client/api/statistic_api.rb +78 -0
- data/lib/harbor2_client/api/system_cve_allowlist_api.rb +134 -0
- data/lib/harbor2_client/api/systeminfo_api.rb +188 -0
- data/lib/harbor2_client/api/user_api.rb +715 -0
- data/lib/harbor2_client/api/usergroup_api.rb +317 -0
- data/lib/harbor2_client/api/webhook_api.rb +514 -0
- data/lib/harbor2_client/api/webhookjob_api.rb +113 -0
- data/lib/harbor2_client/api_client.rb +2 -2
- data/lib/harbor2_client/api_error.rb +1 -1
- data/lib/harbor2_client/configuration.rb +1 -1
- data/lib/harbor2_client/models/access.rb +205 -0
- data/lib/harbor2_client/models/addition_link.rb +1 -1
- data/lib/harbor2_client/models/addition_links.rb +1 -1
- data/lib/harbor2_client/models/annotations.rb +1 -1
- data/lib/harbor2_client/models/artifact.rb +1 -1
- data/lib/harbor2_client/models/audit_log.rb +1 -1
- data/lib/harbor2_client/models/authproxy_setting.rb +225 -0
- data/lib/harbor2_client/models/body.rb +184 -0
- data/lib/harbor2_client/models/body_1.rb +184 -0
- data/lib/harbor2_client/models/bool_config_item.rb +195 -0
- data/lib/harbor2_client/models/chart_metadata.rb +320 -0
- data/lib/harbor2_client/models/chart_version.rb +374 -0
- data/lib/harbor2_client/models/component_health_status.rb +206 -0
- data/lib/harbor2_client/models/configurations.rb +725 -0
- data/lib/harbor2_client/models/configurations_response.rb +704 -0
- data/lib/harbor2_client/models/configurations_response_scan_all_policy.rb +194 -0
- data/lib/harbor2_client/models/configurations_response_scan_all_policy_parameter.rb +186 -0
- data/lib/harbor2_client/models/cve_allowlist.rb +1 -1
- data/lib/harbor2_client/models/cve_allowlist_item.rb +1 -1
- data/lib/harbor2_client/models/endpoint.rb +195 -0
- data/lib/harbor2_client/models/error.rb +1 -1
- data/lib/harbor2_client/models/errors.rb +1 -1
- data/lib/harbor2_client/models/event_type.rb +176 -0
- data/lib/harbor2_client/models/execution.rb +1 -1
- data/lib/harbor2_client/models/extra_attrs.rb +1 -1
- data/lib/harbor2_client/models/filter_style.rb +208 -0
- data/lib/harbor2_client/models/gc_history.rb +264 -0
- data/lib/harbor2_client/models/general_info.rb +305 -0
- data/lib/harbor2_client/models/icon.rb +1 -1
- data/lib/harbor2_client/models/immutable_rule.rb +253 -0
- data/lib/harbor2_client/models/immutable_selector.rb +211 -0
- data/lib/harbor2_client/models/instance.rb +1 -1
- data/lib/harbor2_client/models/integer_config_item.rb +195 -0
- data/lib/harbor2_client/models/internal_configurations_response.rb +175 -0
- data/lib/harbor2_client/models/is_default.rb +185 -0
- data/lib/harbor2_client/models/label.rb +1 -1
- data/lib/harbor2_client/models/ldap_conf.rb +266 -0
- data/lib/harbor2_client/models/ldap_failed_import_user.rb +195 -0
- data/lib/harbor2_client/models/ldap_import_users.rb +187 -0
- data/lib/harbor2_client/models/ldap_ping_result.rb +196 -0
- data/lib/harbor2_client/models/ldap_user.rb +205 -0
- data/lib/harbor2_client/models/metadata.rb +1 -1
- data/lib/harbor2_client/models/metrics.rb +1 -1
- data/lib/harbor2_client/models/native_report_summary.rb +14 -5
- data/lib/harbor2_client/models/notify_type.rb +176 -0
- data/lib/harbor2_client/models/oidc_cli_secret_req.rb +185 -0
- data/lib/harbor2_client/models/oidc_user_info.rb +235 -0
- data/lib/harbor2_client/models/overall_health_status.rb +197 -0
- data/lib/harbor2_client/models/password_req.rb +195 -0
- data/lib/harbor2_client/models/permission.rb +195 -0
- data/lib/harbor2_client/models/platform.rb +7 -7
- data/lib/harbor2_client/models/preheat_policy.rb +1 -1
- data/lib/harbor2_client/models/project.rb +1 -1
- data/lib/harbor2_client/models/project_deletable.rb +1 -1
- data/lib/harbor2_client/models/project_member.rb +203 -0
- data/lib/harbor2_client/models/project_member_entity.rb +245 -0
- data/lib/harbor2_client/models/project_metadata.rb +1 -1
- data/lib/harbor2_client/models/project_req.rb +16 -1
- data/lib/harbor2_client/models/project_scanner.rb +190 -0
- data/lib/harbor2_client/models/project_summary.rb +1 -1
- data/lib/harbor2_client/models/project_summary_quota.rb +1 -1
- data/lib/harbor2_client/models/provider_under_project.rb +1 -1
- data/lib/harbor2_client/models/quota.rb +236 -0
- data/lib/harbor2_client/models/quota_ref_object.rb +175 -0
- data/lib/harbor2_client/models/quota_update_req.rb +185 -0
- data/lib/harbor2_client/models/reference.rb +1 -1
- data/lib/harbor2_client/models/registry.rb +3 -3
- data/lib/harbor2_client/models/registry_credential.rb +1 -1
- data/lib/harbor2_client/models/registry_endpoint.rb +196 -0
- data/lib/harbor2_client/models/registry_info.rb +220 -0
- data/lib/harbor2_client/models/registry_ping.rb +245 -0
- data/lib/harbor2_client/models/registry_provider_credential_pattern.rb +216 -0
- data/lib/harbor2_client/models/registry_provider_endpoint_pattern.rb +198 -0
- data/lib/harbor2_client/models/registry_provider_info.rb +196 -0
- data/lib/harbor2_client/models/registry_update.rb +245 -0
- data/lib/harbor2_client/models/replication_execution.rb +296 -0
- data/lib/harbor2_client/models/replication_filter.rb +195 -0
- data/lib/harbor2_client/models/replication_policy.rb +326 -0
- data/lib/harbor2_client/models/replication_task.rb +276 -0
- data/lib/harbor2_client/models/replication_trigger.rb +194 -0
- data/lib/harbor2_client/models/replication_trigger_settings.rb +185 -0
- data/lib/harbor2_client/models/repository.rb +1 -1
- data/lib/harbor2_client/models/resource_list.rb +1 -1
- data/lib/harbor2_client/models/retention_execution.rb +238 -0
- data/lib/harbor2_client/models/retention_execution_task.rb +274 -0
- data/lib/harbor2_client/models/retention_metadata.rb +212 -0
- data/lib/harbor2_client/models/retention_policy.rb +223 -0
- data/lib/harbor2_client/models/retention_policy_scope.rb +193 -0
- data/lib/harbor2_client/models/retention_rule.rb +253 -0
- data/lib/harbor2_client/models/retention_rule_metadata.rb +218 -0
- data/lib/harbor2_client/models/retention_rule_param_metadata.rb +203 -0
- data/lib/harbor2_client/models/retention_rule_trigger.rb +202 -0
- data/lib/harbor2_client/models/retention_selector.rb +211 -0
- data/lib/harbor2_client/models/retention_selector_metadata.rb +205 -0
- data/lib/harbor2_client/models/robot.rb +296 -0
- data/lib/harbor2_client/models/robot_create.rb +247 -0
- data/lib/harbor2_client/models/robot_create_v1.rb +217 -0
- data/lib/harbor2_client/models/robot_created.rb +226 -0
- data/lib/harbor2_client/models/robot_permission.rb +206 -0
- data/lib/harbor2_client/models/robot_sec.rb +186 -0
- data/lib/harbor2_client/models/role_request.rb +185 -0
- data/lib/harbor2_client/models/scan_overview.rb +1 -1
- data/lib/harbor2_client/models/scanner.rb +205 -0
- data/lib/harbor2_client/models/scanner_adapter_metadata.rb +207 -0
- data/lib/harbor2_client/models/scanner_capability.rb +197 -0
- data/lib/harbor2_client/models/scanner_registration.rb +348 -0
- data/lib/harbor2_client/models/scanner_registration_req.rb +271 -0
- data/lib/harbor2_client/models/scanner_registration_settings.rb +227 -0
- data/lib/harbor2_client/models/schedule.rb +236 -0
- data/lib/harbor2_client/models/schedule_obj.rb +229 -0
- data/lib/harbor2_client/models/search.rb +211 -0
- data/lib/harbor2_client/models/search_repository.rb +235 -0
- data/lib/harbor2_client/models/search_result.rb +205 -0
- data/lib/harbor2_client/models/start_replication_execution.rb +185 -0
- data/lib/harbor2_client/models/statistic.rb +245 -0
- data/lib/harbor2_client/models/stats.rb +262 -0
- data/lib/harbor2_client/models/storage.rb +195 -0
- data/lib/harbor2_client/models/string_config_item.rb +195 -0
- data/lib/harbor2_client/models/supported_webhook_event_types.rb +198 -0
- data/lib/harbor2_client/models/system_info.rb +187 -0
- data/lib/harbor2_client/models/tag.rb +1 -1
- data/lib/harbor2_client/models/task.rb +1 -1
- data/lib/harbor2_client/models/user_creation_req.rb +250 -0
- data/lib/harbor2_client/models/user_entity.rb +195 -0
- data/lib/harbor2_client/models/user_group.rb +215 -0
- data/lib/harbor2_client/models/user_profile.rb +202 -0
- data/lib/harbor2_client/models/user_resp.rb +268 -0
- data/lib/harbor2_client/models/user_search.rb +194 -0
- data/lib/harbor2_client/models/user_search_resp_item.rb +194 -0
- data/lib/harbor2_client/models/user_sys_admin_flag.rb +185 -0
- data/lib/harbor2_client/models/vulnerability_summary.rb +1 -1
- data/lib/harbor2_client/models/webhook_job.rb +256 -0
- data/lib/harbor2_client/models/webhook_last_trigger.rb +226 -0
- data/lib/harbor2_client/models/webhook_policy.rb +278 -0
- data/lib/harbor2_client/models/webhook_target_object.rb +216 -0
- data/lib/harbor2_client/version.rb +2 -2
- data/lib/harbor2_client.rb +127 -1
- data/spec/api/artifact_api_spec.rb +21 -1
- data/spec/api/auditlog_api_spec.rb +2 -1
- data/spec/api/configure_api_spec.rb +72 -0
- data/spec/api/gc_api_spec.rb +115 -0
- data/spec/api/health_api_spec.rb +47 -0
- data/spec/api/icon_api_spec.rb +1 -1
- data/spec/api/immutable_api_spec.rb +97 -0
- data/spec/api/label_api_spec.rb +107 -0
- data/spec/api/ldap_api_spec.rb +88 -0
- data/spec/api/member_api_spec.rb +112 -0
- data/spec/api/oidc_api_spec.rb +48 -0
- data/spec/api/ping_api_spec.rb +47 -0
- data/spec/api/preheat_api_spec.rb +5 -1
- data/spec/api/project_api_spec.rb +63 -6
- data/spec/api/project_metadata_api_spec.rb +110 -0
- data/spec/api/quota_api_spec.rb +79 -0
- data/spec/api/registry_api_spec.rb +155 -0
- data/spec/api/replication_api_spec.rb +194 -0
- data/spec/api/repository_api_spec.rb +18 -1
- data/spec/api/retention_api_spec.rb +175 -0
- data/spec/api/robot_api_spec.rb +118 -0
- data/spec/api/robotv1_api_spec.rb +114 -0
- data/spec/api/scan_all_api_spec.rb +97 -0
- data/spec/api/scan_api_spec.rb +1 -1
- data/spec/api/scanner_api_spec.rb +144 -0
- data/spec/api/search_api_spec.rb +48 -0
- data/spec/api/statistic_api_spec.rb +47 -0
- data/spec/api/system_cve_allowlist_api_spec.rb +60 -0
- data/spec/api/systeminfo_api_spec.rb +71 -0
- data/spec/api/user_api_spec.rb +181 -0
- data/spec/api/usergroup_api_spec.rb +100 -0
- data/spec/api/webhook_api_spec.rb +142 -0
- data/spec/api/webhookjob_api_spec.rb +55 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/access_spec.rb +53 -0
- data/spec/models/addition_link_spec.rb +1 -1
- data/spec/models/addition_links_spec.rb +1 -1
- data/spec/models/annotations_spec.rb +1 -1
- data/spec/models/artifact_spec.rb +1 -1
- data/spec/models/audit_log_spec.rb +1 -1
- data/spec/models/authproxy_setting_spec.rb +65 -0
- data/spec/models/body_1_spec.rb +41 -0
- data/spec/models/body_spec.rb +41 -0
- data/spec/models/bool_config_item_spec.rb +47 -0
- data/spec/models/chart_metadata_spec.rb +101 -0
- data/spec/models/chart_version_spec.rb +131 -0
- data/spec/models/component_health_status_spec.rb +53 -0
- data/spec/models/configurations_response_scan_all_policy_parameter_spec.rb +41 -0
- data/spec/models/configurations_response_scan_all_policy_spec.rb +47 -0
- data/spec/models/configurations_response_spec.rb +353 -0
- data/spec/models/configurations_spec.rb +365 -0
- data/spec/models/cve_allowlist_item_spec.rb +1 -1
- data/spec/models/cve_allowlist_spec.rb +1 -1
- data/spec/models/endpoint_spec.rb +47 -0
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/errors_spec.rb +1 -1
- data/spec/models/event_type_spec.rb +35 -0
- data/spec/models/execution_spec.rb +1 -1
- data/spec/models/extra_attrs_spec.rb +1 -1
- data/spec/models/filter_style_spec.rb +53 -0
- data/spec/models/gc_history_spec.rb +89 -0
- data/spec/models/general_info_spec.rb +113 -0
- data/spec/models/icon_spec.rb +1 -1
- data/spec/models/immutable_rule_spec.rb +83 -0
- data/spec/models/immutable_selector_spec.rb +59 -0
- data/spec/models/instance_spec.rb +1 -1
- data/spec/models/integer_config_item_spec.rb +47 -0
- data/spec/models/internal_configurations_response_spec.rb +35 -0
- data/spec/models/is_default_spec.rb +41 -0
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/ldap_conf_spec.rb +89 -0
- data/spec/models/ldap_failed_import_user_spec.rb +47 -0
- data/spec/models/ldap_import_users_spec.rb +41 -0
- data/spec/models/ldap_ping_result_spec.rb +47 -0
- data/spec/models/ldap_user_spec.rb +53 -0
- data/spec/models/metadata_spec.rb +1 -1
- data/spec/models/metrics_spec.rb +1 -1
- data/spec/models/native_report_summary_spec.rb +7 -1
- data/spec/models/notify_type_spec.rb +35 -0
- data/spec/models/oidc_cli_secret_req_spec.rb +41 -0
- data/spec/models/oidc_user_info_spec.rb +71 -0
- data/spec/models/overall_health_status_spec.rb +47 -0
- data/spec/models/password_req_spec.rb +47 -0
- data/spec/models/permission_spec.rb +47 -0
- data/spec/models/platform_spec.rb +1 -1
- data/spec/models/preheat_policy_spec.rb +1 -1
- data/spec/models/project_deletable_spec.rb +1 -1
- data/spec/models/project_member_entity_spec.rb +77 -0
- data/spec/models/project_member_spec.rb +53 -0
- data/spec/models/project_metadata_spec.rb +1 -1
- data/spec/models/project_req_spec.rb +1 -1
- data/spec/models/project_scanner_spec.rb +41 -0
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/project_summary_quota_spec.rb +1 -1
- data/spec/models/project_summary_spec.rb +1 -1
- data/spec/models/provider_under_project_spec.rb +1 -1
- data/spec/models/quota_ref_object_spec.rb +35 -0
- data/spec/models/quota_spec.rb +71 -0
- data/spec/models/quota_update_req_spec.rb +41 -0
- data/spec/models/reference_spec.rb +1 -1
- data/spec/models/registry_credential_spec.rb +1 -1
- data/spec/models/registry_endpoint_spec.rb +47 -0
- data/spec/models/registry_info_spec.rb +59 -0
- data/spec/models/registry_ping_spec.rb +77 -0
- data/spec/models/registry_provider_credential_pattern_spec.rb +59 -0
- data/spec/models/registry_provider_endpoint_pattern_spec.rb +47 -0
- data/spec/models/registry_provider_info_spec.rb +47 -0
- data/spec/models/registry_spec.rb +1 -1
- data/spec/models/registry_update_spec.rb +77 -0
- data/spec/models/replication_execution_spec.rb +107 -0
- data/spec/models/replication_filter_spec.rb +47 -0
- data/spec/models/replication_policy_spec.rb +125 -0
- data/spec/models/replication_task_spec.rb +95 -0
- data/spec/models/replication_trigger_settings_spec.rb +41 -0
- data/spec/models/replication_trigger_spec.rb +47 -0
- data/spec/models/repository_spec.rb +1 -1
- data/spec/models/resource_list_spec.rb +1 -1
- data/spec/models/retention_execution_spec.rb +77 -0
- data/spec/models/retention_execution_task_spec.rb +101 -0
- data/spec/models/retention_metadata_spec.rb +53 -0
- data/spec/models/retention_policy_scope_spec.rb +47 -0
- data/spec/models/retention_policy_spec.rb +65 -0
- data/spec/models/retention_rule_metadata_spec.rb +59 -0
- data/spec/models/retention_rule_param_metadata_spec.rb +53 -0
- data/spec/models/retention_rule_spec.rb +83 -0
- data/spec/models/retention_rule_trigger_spec.rb +53 -0
- data/spec/models/retention_selector_metadata_spec.rb +53 -0
- data/spec/models/retention_selector_spec.rb +59 -0
- data/spec/models/robot_create_spec.rb +77 -0
- data/spec/models/robot_create_v1_spec.rb +59 -0
- data/spec/models/robot_created_spec.rb +65 -0
- data/spec/models/robot_permission_spec.rb +53 -0
- data/spec/models/robot_sec_spec.rb +41 -0
- data/spec/models/robot_spec.rb +107 -0
- data/spec/models/role_request_spec.rb +41 -0
- data/spec/models/scan_overview_spec.rb +1 -1
- data/spec/models/scanner_adapter_metadata_spec.rb +53 -0
- data/spec/models/scanner_capability_spec.rb +47 -0
- data/spec/models/scanner_registration_req_spec.rb +83 -0
- data/spec/models/scanner_registration_settings_spec.rb +59 -0
- data/spec/models/scanner_registration_spec.rb +131 -0
- data/spec/models/scanner_spec.rb +53 -0
- data/spec/models/schedule_obj_spec.rb +51 -0
- data/spec/models/schedule_spec.rb +71 -0
- data/spec/models/search_repository_spec.rb +71 -0
- data/spec/models/search_result_spec.rb +53 -0
- data/spec/models/search_spec.rb +53 -0
- data/spec/models/start_replication_execution_spec.rb +41 -0
- data/spec/models/statistic_spec.rb +77 -0
- data/spec/models/stats_spec.rb +69 -0
- data/spec/models/storage_spec.rb +47 -0
- data/spec/models/string_config_item_spec.rb +47 -0
- data/spec/models/supported_webhook_event_types_spec.rb +47 -0
- data/spec/models/system_info_spec.rb +41 -0
- data/spec/models/tag_spec.rb +1 -1
- data/spec/models/task_spec.rb +1 -1
- data/spec/models/user_creation_req_spec.rb +65 -0
- data/spec/models/user_entity_spec.rb +47 -0
- data/spec/models/user_group_spec.rb +59 -0
- data/spec/models/user_profile_spec.rb +53 -0
- data/spec/models/user_resp_spec.rb +95 -0
- data/spec/models/user_search_resp_item_spec.rb +47 -0
- data/spec/models/user_search_spec.rb +47 -0
- data/spec/models/user_sys_admin_flag_spec.rb +41 -0
- data/spec/models/vulnerability_summary_spec.rb +1 -1
- data/spec/models/webhook_job_spec.rb +83 -0
- data/spec/models/webhook_last_trigger_spec.rb +65 -0
- data/spec/models/webhook_policy_spec.rb +95 -0
- data/spec/models/webhook_target_object_spec.rb +59 -0
- data/spec/spec_helper.rb +1 -1
- metadata +512 -8
- data/harbor2_client-0.1.0.gem +0 -0
data/docs/Body1.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# Harbor2Client::BoolConfigItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**value** | **BOOLEAN** | The boolean value of current config item | [optional]
|
7
|
+
**editable** | **BOOLEAN** | The configure item can be updated or not | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Harbor2Client::ChartMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | The name of the chart |
|
7
|
+
**home** | **String** | The URL to the relevant project page | [optional]
|
8
|
+
**sources** | **Array<String>** | The URL to the source code of chart | [optional]
|
9
|
+
**version** | **String** | A SemVer 2 version of chart |
|
10
|
+
**description** | **String** | A one-sentence description of chart | [optional]
|
11
|
+
**keywords** | **Array<String>** | A list of string keywords | [optional]
|
12
|
+
**engine** | **String** | The name of template engine |
|
13
|
+
**icon** | **String** | The URL to an icon file |
|
14
|
+
**api_version** | **String** | The API version of this chart |
|
15
|
+
**app_version** | **String** | The version of the application enclosed in the chart |
|
16
|
+
**deprecated** | **BOOLEAN** | Whether or not this chart is deprecated | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Harbor2Client::ChartVersion
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | The name of the chart |
|
7
|
+
**home** | **String** | The URL to the relevant project page | [optional]
|
8
|
+
**sources** | **Array<String>** | The URL to the source code of chart | [optional]
|
9
|
+
**version** | **String** | A SemVer 2 version of chart |
|
10
|
+
**description** | **String** | A one-sentence description of chart | [optional]
|
11
|
+
**keywords** | **Array<String>** | A list of string keywords | [optional]
|
12
|
+
**engine** | **String** | The name of template engine |
|
13
|
+
**icon** | **String** | The URL to an icon file |
|
14
|
+
**api_version** | **String** | The API version of this chart |
|
15
|
+
**app_version** | **String** | The version of the application enclosed in the chart |
|
16
|
+
**deprecated** | **BOOLEAN** | Whether or not this chart is deprecated | [optional]
|
17
|
+
**labels** | [**Array<Label>**](Label.md) | A list of label | [optional]
|
18
|
+
**created** | **String** | The created time of the chart entry | [optional]
|
19
|
+
**removed** | **BOOLEAN** | A flag to indicate if the chart entry is removed | [optional]
|
20
|
+
**digest** | **String** | The digest value of the chart entry | [optional]
|
21
|
+
**urls** | **Array<String>** | The urls of the chart entry | [optional]
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Harbor2Client::ComponentHealthStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | The component name | [optional]
|
7
|
+
**status** | **String** | The health status of component | [optional]
|
8
|
+
**error** | **String** | (optional) The error message when the status is \"unhealthy\" | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# Harbor2Client::Configurations
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**auth_mode** | **String** | The auth mode of current system, such as \"db_auth\", \"ldap_auth\", \"oidc_auth\" | [optional]
|
7
|
+
**email_from** | **String** | The sender name for Email notification. | [optional]
|
8
|
+
**email_host** | **String** | The hostname of SMTP server that sends Email notification. | [optional]
|
9
|
+
**email_identity** | **String** | By default it's empty so the email_username is picked | [optional]
|
10
|
+
**email_insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the email server. | [optional]
|
11
|
+
**email_password** | **String** | Email password | [optional]
|
12
|
+
**email_port** | **Integer** | The port of SMTP server | [optional]
|
13
|
+
**email_ssl** | **BOOLEAN** | When it''s set to true the system will access Email server via TLS by default. If it''s set to false, it still will handle \"STARTTLS\" from server side. | [optional]
|
14
|
+
**email_username** | **String** | The username for authenticate against SMTP server | [optional]
|
15
|
+
**ldap_base_dn** | **String** | The Base DN for LDAP binding. | [optional]
|
16
|
+
**ldap_filter** | **String** | The filter for LDAP search | [optional]
|
17
|
+
**ldap_group_base_dn** | **String** | The base DN to search LDAP group. | [optional]
|
18
|
+
**ldap_group_admin_dn** | **String** | Specify the ldap group which have the same privilege with Harbor admin | [optional]
|
19
|
+
**ldap_group_attribute_name** | **String** | The attribute which is used as identity of the LDAP group, default is cn.' | [optional]
|
20
|
+
**ldap_group_search_filter** | **String** | The filter to search the ldap group | [optional]
|
21
|
+
**ldap_group_search_scope** | **Integer** | The scope to search ldap group. ''0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE'' | [optional]
|
22
|
+
**ldap_scope** | **Integer** | The scope to search ldap users,'0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE' | [optional]
|
23
|
+
**ldap_search_dn** | **String** | The DN of the user to do the search. | [optional]
|
24
|
+
**ldap_search_password** | **String** | The password of the ldap search dn | [optional]
|
25
|
+
**ldap_timeout** | **Integer** | Timeout in seconds for connection to LDAP server | [optional]
|
26
|
+
**ldap_uid** | **String** | The attribute which is used as identity for the LDAP binding, such as \"CN\" or \"SAMAccountname\" | [optional]
|
27
|
+
**ldap_url** | **String** | The URL of LDAP server | [optional]
|
28
|
+
**ldap_verify_cert** | **BOOLEAN** | Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate. | [optional]
|
29
|
+
**ldap_group_membership_attribute** | **String** | The user attribute to identify the group membership | [optional]
|
30
|
+
**project_creation_restriction** | **String** | Indicate who can create projects, it could be ''adminonly'' or ''everyone''. | [optional]
|
31
|
+
**read_only** | **BOOLEAN** | The flag to indicate whether Harbor is in readonly mode. | [optional]
|
32
|
+
**self_registration** | **BOOLEAN** | Whether the Harbor instance supports self-registration. If it''s set to false, admin need to add user to the instance. | [optional]
|
33
|
+
**token_expiration** | **Integer** | The expiration time of the token for internal Registry, in minutes. | [optional]
|
34
|
+
**uaa_client_id** | **String** | The client id of UAA | [optional]
|
35
|
+
**uaa_client_secret** | **String** | The client secret of the UAA | [optional]
|
36
|
+
**uaa_endpoint** | **String** | The endpoint of the UAA | [optional]
|
37
|
+
**uaa_verify_cert** | **BOOLEAN** | Verify the certificate in UAA server | [optional]
|
38
|
+
**http_authproxy_endpoint** | **String** | The endpoint of the HTTP auth | [optional]
|
39
|
+
**http_authproxy_tokenreview_endpoint** | **String** | The token review endpoint | [optional]
|
40
|
+
**http_authproxy_admin_groups** | **String** | The group which has the harbor admin privileges | [optional]
|
41
|
+
**http_authproxy_admin_usernames** | **String** | The username which has the harbor admin privileges | [optional]
|
42
|
+
**http_authproxy_verify_cert** | **BOOLEAN** | Verify the HTTP auth provider's certificate | [optional]
|
43
|
+
**http_authproxy_skip_search** | **BOOLEAN** | Search user before onboard | [optional]
|
44
|
+
**http_authproxy_server_certificate** | **String** | The certificate of the HTTP auth provider | [optional]
|
45
|
+
**oidc_name** | **String** | The OIDC provider name | [optional]
|
46
|
+
**oidc_endpoint** | **String** | The endpoint of the OIDC provider | [optional]
|
47
|
+
**oidc_client_id** | **String** | The client ID of the OIDC provider | [optional]
|
48
|
+
**oidc_client_secret** | **String** | The OIDC provider secret | [optional]
|
49
|
+
**oidc_groups_claim** | **String** | The attribute claims the group name | [optional]
|
50
|
+
**oidc_admin_group** | **String** | The OIDC group which has the harbor admin privileges | [optional]
|
51
|
+
**oidc_scope** | **String** | The scope of the OIDC provider | [optional]
|
52
|
+
**oidc_user_claim** | **String** | The attribute claims the username | [optional]
|
53
|
+
**oidc_verify_cert** | **BOOLEAN** | Verify the OIDC provider's certificate' | [optional]
|
54
|
+
**oidc_auto_onboard** | **BOOLEAN** | Auto onboard the OIDC user | [optional]
|
55
|
+
**oidc_extra_redirect_parms** | **String** | Extra parameters to add when redirect request to OIDC provider | [optional]
|
56
|
+
**robot_token_duration** | **Integer** | The robot account token duration in days | [optional]
|
57
|
+
**robot_name_prefix** | **String** | The rebot account name prefix | [optional]
|
58
|
+
**notification_enable** | **BOOLEAN** | Enable notification | [optional]
|
59
|
+
**quota_per_project_enable** | **BOOLEAN** | Enable quota per project | [optional]
|
60
|
+
**storage_per_project** | **Integer** | The storage quota per project | [optional]
|
61
|
+
|
62
|
+
|
@@ -0,0 +1,60 @@
|
|
1
|
+
# Harbor2Client::ConfigurationsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**auth_mode** | [**StringConfigItem**](StringConfigItem.md) | The auth mode of current system, such as \"db_auth\", \"ldap_auth\", \"oidc_auth\" | [optional]
|
7
|
+
**email_from** | [**StringConfigItem**](StringConfigItem.md) | The sender name for Email notification. | [optional]
|
8
|
+
**email_host** | [**StringConfigItem**](StringConfigItem.md) | The hostname of SMTP server that sends Email notification. | [optional]
|
9
|
+
**email_identity** | [**StringConfigItem**](StringConfigItem.md) | By default it's empty so the email_username is picked | [optional]
|
10
|
+
**email_insecure** | [**BoolConfigItem**](BoolConfigItem.md) | Whether or not the certificate will be verified when Harbor tries to access the email server. | [optional]
|
11
|
+
**email_port** | [**IntegerConfigItem**](IntegerConfigItem.md) | The port of SMTP server | [optional]
|
12
|
+
**email_ssl** | [**BoolConfigItem**](BoolConfigItem.md) | When it''s set to true the system will access Email server via TLS by default. If it''s set to false, it still will handle \"STARTTLS\" from server side. | [optional]
|
13
|
+
**email_username** | [**StringConfigItem**](StringConfigItem.md) | The username for authenticate against SMTP server | [optional]
|
14
|
+
**ldap_base_dn** | [**StringConfigItem**](StringConfigItem.md) | The Base DN for LDAP binding. | [optional]
|
15
|
+
**ldap_filter** | [**StringConfigItem**](StringConfigItem.md) | The filter for LDAP search | [optional]
|
16
|
+
**ldap_group_base_dn** | [**StringConfigItem**](StringConfigItem.md) | The base DN to search LDAP group. | [optional]
|
17
|
+
**ldap_group_admin_dn** | [**StringConfigItem**](StringConfigItem.md) | Specify the ldap group which have the same privilege with Harbor admin | [optional]
|
18
|
+
**ldap_group_attribute_name** | [**StringConfigItem**](StringConfigItem.md) | The attribute which is used as identity of the LDAP group, default is cn.' | [optional]
|
19
|
+
**ldap_group_search_filter** | [**StringConfigItem**](StringConfigItem.md) | The filter to search the ldap group | [optional]
|
20
|
+
**ldap_group_search_scope** | [**IntegerConfigItem**](IntegerConfigItem.md) | The scope to search ldap group. ''0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE'' | [optional]
|
21
|
+
**ldap_scope** | [**IntegerConfigItem**](IntegerConfigItem.md) | The scope to search ldap users,'0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE' | [optional]
|
22
|
+
**ldap_search_dn** | [**StringConfigItem**](StringConfigItem.md) | The DN of the user to do the search. | [optional]
|
23
|
+
**ldap_timeout** | [**IntegerConfigItem**](IntegerConfigItem.md) | Timeout in seconds for connection to LDAP server | [optional]
|
24
|
+
**ldap_uid** | [**StringConfigItem**](StringConfigItem.md) | The attribute which is used as identity for the LDAP binding, such as \"CN\" or \"SAMAccountname\" | [optional]
|
25
|
+
**ldap_url** | [**StringConfigItem**](StringConfigItem.md) | The URL of LDAP server | [optional]
|
26
|
+
**ldap_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate. | [optional]
|
27
|
+
**ldap_group_membership_attribute** | [**StringConfigItem**](StringConfigItem.md) | The user attribute to identify the group membership | [optional]
|
28
|
+
**project_creation_restriction** | [**StringConfigItem**](StringConfigItem.md) | Indicate who can create projects, it could be ''adminonly'' or ''everyone''. | [optional]
|
29
|
+
**read_only** | [**BoolConfigItem**](BoolConfigItem.md) | The flag to indicate whether Harbor is in readonly mode. | [optional]
|
30
|
+
**self_registration** | [**BoolConfigItem**](BoolConfigItem.md) | Whether the Harbor instance supports self-registration. If it''s set to false, admin need to add user to the instance. | [optional]
|
31
|
+
**token_expiration** | [**IntegerConfigItem**](IntegerConfigItem.md) | The expiration time of the token for internal Registry, in minutes. | [optional]
|
32
|
+
**uaa_client_id** | [**StringConfigItem**](StringConfigItem.md) | The client id of UAA | [optional]
|
33
|
+
**uaa_client_secret** | [**StringConfigItem**](StringConfigItem.md) | The client secret of the UAA | [optional]
|
34
|
+
**uaa_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The endpoint of the UAA | [optional]
|
35
|
+
**uaa_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Verify the certificate in UAA server | [optional]
|
36
|
+
**http_authproxy_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The endpoint of the HTTP auth | [optional]
|
37
|
+
**http_authproxy_tokenreview_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The token review endpoint | [optional]
|
38
|
+
**http_authproxy_admin_groups** | [**StringConfigItem**](StringConfigItem.md) | The group which has the harbor admin privileges | [optional]
|
39
|
+
**http_authproxy_admin_usernames** | [**StringConfigItem**](StringConfigItem.md) | The usernames which has the harbor admin privileges | [optional]
|
40
|
+
**http_authproxy_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Verify the HTTP auth provider's certificate | [optional]
|
41
|
+
**http_authproxy_skip_search** | [**BoolConfigItem**](BoolConfigItem.md) | Search user before onboard | [optional]
|
42
|
+
**http_authproxy_server_certificate** | [**StringConfigItem**](StringConfigItem.md) | The certificate of the HTTP auth provider | [optional]
|
43
|
+
**oidc_name** | [**StringConfigItem**](StringConfigItem.md) | The OIDC provider name | [optional]
|
44
|
+
**oidc_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The endpoint of the OIDC provider | [optional]
|
45
|
+
**oidc_client_id** | [**StringConfigItem**](StringConfigItem.md) | The client ID of the OIDC provider | [optional]
|
46
|
+
**oidc_groups_claim** | [**StringConfigItem**](StringConfigItem.md) | The attribute claims the group name | [optional]
|
47
|
+
**oidc_admin_group** | [**StringConfigItem**](StringConfigItem.md) | The OIDC group which has the harbor admin privileges | [optional]
|
48
|
+
**oidc_scope** | [**StringConfigItem**](StringConfigItem.md) | The scope of the OIDC provider | [optional]
|
49
|
+
**oidc_user_claim** | [**StringConfigItem**](StringConfigItem.md) | The attribute claims the username | [optional]
|
50
|
+
**oidc_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Verify the OIDC provider's certificate' | [optional]
|
51
|
+
**oidc_auto_onboard** | [**BoolConfigItem**](BoolConfigItem.md) | Auto onboard the OIDC user | [optional]
|
52
|
+
**oidc_extra_redirect_parms** | [**StringConfigItem**](StringConfigItem.md) | Extra parameters to add when redirect request to OIDC provider | [optional]
|
53
|
+
**robot_token_duration** | [**IntegerConfigItem**](IntegerConfigItem.md) | The robot account token duration in days | [optional]
|
54
|
+
**robot_name_prefix** | [**StringConfigItem**](StringConfigItem.md) | The rebot account name prefix | [optional]
|
55
|
+
**notification_enable** | [**BoolConfigItem**](BoolConfigItem.md) | Enable notification | [optional]
|
56
|
+
**quota_per_project_enable** | [**BoolConfigItem**](BoolConfigItem.md) | Enable quota per project | [optional]
|
57
|
+
**storage_per_project** | [**IntegerConfigItem**](IntegerConfigItem.md) | The storage quota per project | [optional]
|
58
|
+
**scan_all_policy** | [**ConfigurationsResponseScanAllPolicy**](ConfigurationsResponseScanAllPolicy.md) | | [optional]
|
59
|
+
|
60
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Harbor2Client::ConfigurationsResponseScanAllPolicy
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | The type of scan all policy, currently the valid values are \"none\" and \"daily\" | [optional]
|
7
|
+
**parameter** | [**ConfigurationsResponseScanAllPolicyParameter**](ConfigurationsResponseScanAllPolicyParameter.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Harbor2Client::ConfigurationsResponseScanAllPolicyParameter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**daily_time** | **Integer** | The offset in seconds of UTC 0 o'clock, only valid when the policy type is \"daily\" | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,175 @@
|
|
1
|
+
# Harbor2Client::ConfigureApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost/api/v2.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_configurations**](ConfigureApi.md#get_configurations) | **GET** /configurations | Get system configurations.
|
8
|
+
[**get_internalconfig**](ConfigureApi.md#get_internalconfig) | **GET** /internalconfig | Get internal configurations.
|
9
|
+
[**update_configurations**](ConfigureApi.md#update_configurations) | **PUT** /configurations | Modify system configurations.
|
10
|
+
|
11
|
+
|
12
|
+
# **get_configurations**
|
13
|
+
> ConfigurationsResponse get_configurations(opts)
|
14
|
+
|
15
|
+
Get system configurations.
|
16
|
+
|
17
|
+
This endpoint is for retrieving system configurations that only provides for admin user.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'harbor2_client'
|
23
|
+
# setup authorization
|
24
|
+
Harbor2Client.configure do |config|
|
25
|
+
# Configure HTTP basic authorization: basic
|
26
|
+
config.username = 'YOUR USERNAME'
|
27
|
+
config.password = 'YOUR PASSWORD'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = Harbor2Client::ConfigureApi.new
|
31
|
+
|
32
|
+
opts = {
|
33
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Get system configurations.
|
38
|
+
result = api_instance.get_configurations(opts)
|
39
|
+
p result
|
40
|
+
rescue Harbor2Client::ApiError => e
|
41
|
+
puts "Exception when calling ConfigureApi->get_configurations: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
[**ConfigurationsResponse**](ConfigurationsResponse.md)
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[basic](../README.md#basic)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: application/json
|
62
|
+
- **Accept**: application/json
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **get_internalconfig**
|
67
|
+
> InternalConfigurationsResponse get_internalconfig(opts)
|
68
|
+
|
69
|
+
Get internal configurations.
|
70
|
+
|
71
|
+
This endpoint is for retrieving system configurations that only provides for internal api call.
|
72
|
+
|
73
|
+
### Example
|
74
|
+
```ruby
|
75
|
+
# load the gem
|
76
|
+
require 'harbor2_client'
|
77
|
+
# setup authorization
|
78
|
+
Harbor2Client.configure do |config|
|
79
|
+
# Configure HTTP basic authorization: basic
|
80
|
+
config.username = 'YOUR USERNAME'
|
81
|
+
config.password = 'YOUR PASSWORD'
|
82
|
+
end
|
83
|
+
|
84
|
+
api_instance = Harbor2Client::ConfigureApi.new
|
85
|
+
|
86
|
+
opts = {
|
87
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
88
|
+
}
|
89
|
+
|
90
|
+
begin
|
91
|
+
#Get internal configurations.
|
92
|
+
result = api_instance.get_internalconfig(opts)
|
93
|
+
p result
|
94
|
+
rescue Harbor2Client::ApiError => e
|
95
|
+
puts "Exception when calling ConfigureApi->get_internalconfig: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
### Parameters
|
100
|
+
|
101
|
+
Name | Type | Description | Notes
|
102
|
+
------------- | ------------- | ------------- | -------------
|
103
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
104
|
+
|
105
|
+
### Return type
|
106
|
+
|
107
|
+
[**InternalConfigurationsResponse**](InternalConfigurationsResponse.md)
|
108
|
+
|
109
|
+
### Authorization
|
110
|
+
|
111
|
+
[basic](../README.md#basic)
|
112
|
+
|
113
|
+
### HTTP request headers
|
114
|
+
|
115
|
+
- **Content-Type**: application/json
|
116
|
+
- **Accept**: application/json
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
# **update_configurations**
|
121
|
+
> update_configurations(configurations, opts)
|
122
|
+
|
123
|
+
Modify system configurations.
|
124
|
+
|
125
|
+
This endpoint is for modifying system configurations that only provides for admin user.
|
126
|
+
|
127
|
+
### Example
|
128
|
+
```ruby
|
129
|
+
# load the gem
|
130
|
+
require 'harbor2_client'
|
131
|
+
# setup authorization
|
132
|
+
Harbor2Client.configure do |config|
|
133
|
+
# Configure HTTP basic authorization: basic
|
134
|
+
config.username = 'YOUR USERNAME'
|
135
|
+
config.password = 'YOUR PASSWORD'
|
136
|
+
end
|
137
|
+
|
138
|
+
api_instance = Harbor2Client::ConfigureApi.new
|
139
|
+
|
140
|
+
configurations = Harbor2Client::Configurations.new # Configurations | The configuration map can contain a subset of the attributes of the schema, which are to be updated.
|
141
|
+
|
142
|
+
opts = {
|
143
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
144
|
+
}
|
145
|
+
|
146
|
+
begin
|
147
|
+
#Modify system configurations.
|
148
|
+
api_instance.update_configurations(configurations, opts)
|
149
|
+
rescue Harbor2Client::ApiError => e
|
150
|
+
puts "Exception when calling ConfigureApi->update_configurations: #{e}"
|
151
|
+
end
|
152
|
+
```
|
153
|
+
|
154
|
+
### Parameters
|
155
|
+
|
156
|
+
Name | Type | Description | Notes
|
157
|
+
------------- | ------------- | ------------- | -------------
|
158
|
+
**configurations** | [**Configurations**](Configurations.md)| The configuration map can contain a subset of the attributes of the schema, which are to be updated. |
|
159
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
160
|
+
|
161
|
+
### Return type
|
162
|
+
|
163
|
+
nil (empty response body)
|
164
|
+
|
165
|
+
### Authorization
|
166
|
+
|
167
|
+
[basic](../README.md#basic)
|
168
|
+
|
169
|
+
### HTTP request headers
|
170
|
+
|
171
|
+
- **Content-Type**: application/json
|
172
|
+
- **Accept**: application/json
|
173
|
+
|
174
|
+
|
175
|
+
|
data/docs/Endpoint.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# Harbor2Client::Endpoint
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | The URL of OIDC endpoint to be tested. | [optional]
|
7
|
+
**verify_cert** | **BOOLEAN** | Whether the certificate should be verified | [optional]
|
8
|
+
|
9
|
+
|
data/docs/EventType.md
ADDED
data/docs/FilterStyle.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Harbor2Client::FilterStyle
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | The filter type | [optional]
|
7
|
+
**style** | **String** | The filter style | [optional]
|
8
|
+
**values** | **Array<String>** | The filter values | [optional]
|
9
|
+
|
10
|
+
|
data/docs/GCHistory.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# Harbor2Client::GCHistory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | the id of gc job. | [optional]
|
7
|
+
**job_name** | **String** | the job name of gc job. | [optional]
|
8
|
+
**job_kind** | **String** | the job kind of gc job. | [optional]
|
9
|
+
**job_parameters** | **String** | the job parameters of gc job. | [optional]
|
10
|
+
**schedule** | [**ScheduleObj**](ScheduleObj.md) | | [optional]
|
11
|
+
**job_status** | **String** | the status of gc job. | [optional]
|
12
|
+
**deleted** | **BOOLEAN** | if gc job was deleted. | [optional]
|
13
|
+
**creation_time** | **DateTime** | the creation time of gc job. | [optional]
|
14
|
+
**update_time** | **DateTime** | the update time of gc job. | [optional]
|
15
|
+
|
16
|
+
|