harbor_swagger_client 1.0.4 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +1 -1
- data/README.md +119 -271
- data/docs/Access.md +10 -0
- data/docs/AdditionLink.md +9 -0
- data/docs/{QuotaRefObject.md → AdditionLinks.md} +1 -1
- data/docs/{EventType.md → Annotations.md} +1 -1
- data/docs/Artifact.md +25 -0
- data/docs/ArtifactApi.md +694 -0
- data/docs/AuditLog.md +13 -0
- data/docs/AuditlogApi.md +69 -0
- data/docs/AuthproxySetting.md +12 -0
- data/docs/CVEAllowlist.md +13 -0
- data/docs/{CVEWhitelistItem.md → CVEAllowlistItem.md} +1 -1
- data/docs/Error.md +9 -0
- data/docs/{Action.md → Errors.md} +2 -2
- data/docs/Execution.md +17 -0
- data/docs/{NotifyType.md → ExtraAttrs.md} +1 -1
- data/docs/GeneralInfo.md +4 -0
- data/docs/Icon.md +9 -0
- data/docs/IconApi.md +66 -0
- data/docs/Instance.md +19 -0
- data/docs/Label.md +8 -9
- data/docs/Metadata.md +13 -0
- data/docs/Metrics.md +14 -0
- data/docs/NativeReportSummary.md +15 -0
- data/docs/Permission.md +3 -2
- data/docs/PingApi.md +56 -0
- data/docs/Platform.md +12 -0
- data/docs/PreheatApi.md +1176 -0
- data/docs/PreheatPolicy.md +18 -0
- data/docs/Project.md +4 -3
- data/docs/ProjectApi.md +544 -0
- data/docs/ProjectDeletable.md +9 -0
- data/docs/ProjectMetadata.md +2 -1
- data/docs/ProjectReq.md +3 -2
- data/docs/ProjectSummary.md +3 -1
- data/docs/{ImmutableTagRule.md → ProviderUnderProject.md} +3 -3
- data/docs/Reference.md +13 -0
- data/docs/ReplicationApi.md +352 -0
- data/docs/ReplicationExecution.md +11 -11
- data/docs/ReplicationTask.md +10 -9
- data/docs/Repository.md +15 -0
- data/docs/RepositoryApi.md +256 -0
- data/docs/Robot.md +19 -0
- data/docs/RobotApi.md +363 -0
- data/docs/RobotCreate.md +14 -0
- data/docs/{RobotAccountCreate.md → RobotCreateV1.md} +2 -2
- data/docs/RobotCreated.md +12 -0
- data/docs/{Action1.md → RobotSec.md} +2 -2
- data/docs/Robotv1Api.md +317 -0
- data/docs/ScanApi.md +61 -27
- data/docs/{Labels.md → ScanOverview.md} +1 -1
- data/docs/StartReplicationExecution.md +8 -0
- data/docs/SysteminfoApi.md +152 -0
- data/docs/Tag.md +15 -0
- data/docs/Task.md +17 -0
- data/docs/VulnerabilitySummary.md +10 -0
- data/harbor_swagger_client-1.0.3.gem +0 -0
- data/harbor_swagger_client.gemspec +2 -1
- data/lib/harbor_swagger_client.rb +46 -106
- data/lib/harbor_swagger_client/api/artifact_api.rb +848 -0
- data/lib/harbor_swagger_client/api/auditlog_api.rb +91 -0
- data/lib/harbor_swagger_client/api/icon_api.rb +84 -0
- data/lib/harbor_swagger_client/api/ping_api.rb +71 -0
- data/lib/harbor_swagger_client/api/preheat_api.rb +1327 -0
- data/lib/harbor_swagger_client/api/project_api.rb +604 -0
- data/lib/harbor_swagger_client/api/replication_api.rb +380 -0
- data/lib/harbor_swagger_client/api/repository_api.rb +302 -0
- data/lib/harbor_swagger_client/api/robot_api.rb +406 -0
- data/lib/harbor_swagger_client/api/robotv1_api.rb +369 -0
- data/lib/harbor_swagger_client/api/scan_api.rb +89 -34
- data/lib/harbor_swagger_client/api/systeminfo_api.rb +167 -0
- data/lib/harbor_swagger_client/api_client.rb +6 -4
- data/lib/harbor_swagger_client/api_error.rb +1 -1
- data/lib/harbor_swagger_client/configuration.rb +4 -4
- data/lib/harbor_swagger_client/models/{robot_account_access.rb → access.rb} +20 -9
- data/lib/harbor_swagger_client/models/{namespace.rb → addition_link.rb} +19 -19
- data/lib/harbor_swagger_client/models/{quota_ref_object.rb → addition_links.rb} +4 -3
- data/lib/harbor_swagger_client/models/{labels.rb → annotations.rb} +4 -4
- data/lib/harbor_swagger_client/models/{chart_version.rb → artifact.rb} +133 -139
- data/lib/harbor_swagger_client/models/audit_log.rb +235 -0
- data/lib/harbor_swagger_client/models/{email_server_setting.rb → authproxy_setting.rb} +40 -49
- data/lib/harbor_swagger_client/models/{cve_whitelist.rb → cve_allowlist.rb} +32 -11
- data/lib/harbor_swagger_client/models/{cve_whitelist_item.rb → cve_allowlist_item.rb} +5 -4
- data/lib/harbor_swagger_client/models/{ldap_failed_import_users.rb → error.rb} +20 -18
- data/lib/harbor_swagger_client/models/{action_1.rb → errors.rb} +14 -10
- data/lib/harbor_swagger_client/models/{retention_execution.rb → execution.rb} +67 -31
- data/lib/harbor_swagger_client/models/{event_type.rb → extra_attrs.rb} +4 -4
- data/lib/harbor_swagger_client/models/general_info.rb +47 -6
- data/lib/harbor_swagger_client/models/{endpoint.rb → icon.rb} +19 -18
- data/lib/harbor_swagger_client/models/instance.rb +297 -0
- data/lib/harbor_swagger_client/models/label.rb +16 -25
- data/lib/harbor_swagger_client/models/{scanner.rb → metadata.rb} +49 -16
- data/lib/harbor_swagger_client/models/{webhook_job.rb → metrics.rb} +54 -64
- data/lib/harbor_swagger_client/models/{component_overview_entry.rb → native_report_summary.rb} +74 -13
- data/lib/harbor_swagger_client/models/permission.rb +29 -18
- data/lib/harbor_swagger_client/models/{retention_policy.rb → platform.rb} +42 -37
- data/lib/harbor_swagger_client/models/{webhook_policy.rb → preheat_policy.rb} +56 -48
- data/lib/harbor_swagger_client/models/project.rb +23 -12
- data/lib/harbor_swagger_client/models/{configurations_scan_all_policy.rb → project_deletable.rb} +19 -17
- data/lib/harbor_swagger_client/models/project_metadata.rb +21 -10
- data/lib/harbor_swagger_client/models/project_req.rb +34 -23
- data/lib/harbor_swagger_client/models/project_summary.rb +33 -13
- data/lib/harbor_swagger_client/models/project_summary_quota.rb +3 -2
- data/lib/harbor_swagger_client/models/{immutable_tag_rule.rb → provider_under_project.rb} +23 -22
- data/lib/harbor_swagger_client/models/{stats.rb → reference.rb} +52 -34
- data/lib/harbor_swagger_client/models/registry.rb +3 -2
- data/lib/harbor_swagger_client/models/registry_credential.rb +3 -2
- data/lib/harbor_swagger_client/models/replication_execution.rb +45 -44
- data/lib/harbor_swagger_client/models/replication_task.rb +43 -32
- data/lib/harbor_swagger_client/models/{robot_account.rb → repository.rb} +36 -36
- data/lib/harbor_swagger_client/models/resource_list.rb +3 -2
- data/lib/harbor_swagger_client/models/{replication_policy.rb → robot.rb} +62 -71
- data/lib/harbor_swagger_client/models/{put_registry.rb → robot_create.rb} +44 -41
- data/lib/harbor_swagger_client/models/{robot_account_create.rb → robot_create_v1.rb} +5 -4
- data/lib/harbor_swagger_client/models/{quota.rb → robot_created.rb} +30 -39
- data/lib/harbor_swagger_client/models/{input_secret.rb → robot_sec.rb} +6 -4
- data/lib/harbor_swagger_client/models/{notify_type.rb → scan_overview.rb} +5 -4
- data/lib/harbor_swagger_client/models/{action.rb → start_replication_execution.rb} +12 -10
- data/lib/harbor_swagger_client/models/storage.rb +3 -2
- data/lib/harbor_swagger_client/models/system_info.rb +3 -2
- data/lib/harbor_swagger_client/models/{retention_rule.rb → tag.rb} +55 -52
- data/lib/harbor_swagger_client/models/{retention_execution_task.rb → task.rb} +53 -52
- data/lib/harbor_swagger_client/models/{scanner_adapter_metadata.rb → vulnerability_summary.rb} +28 -26
- data/lib/harbor_swagger_client/version.rb +2 -2
- data/spec/api/artifact_api_spec.rb +209 -0
- data/spec/api/auditlog_api_spec.rb +50 -0
- data/spec/api/icon_api_spec.rb +48 -0
- data/spec/api/ping_api_spec.rb +46 -0
- data/spec/api/preheat_api_spec.rb +311 -0
- data/spec/api/project_api_spec.rb +161 -0
- data/spec/api/replication_api_spec.rb +116 -0
- data/spec/api/repository_api_spec.rb +94 -0
- data/spec/api/robot_api_spec.rb +117 -0
- data/spec/api/robotv1_api_spec.rb +108 -0
- data/spec/api/scan_api_spec.rb +20 -11
- data/spec/api/systeminfo_api_spec.rb +68 -0
- data/spec/api_client_spec.rb +18 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/{search_spec.rb → access_spec.rb} +10 -10
- data/spec/models/{password_spec.rb → addition_link_spec.rb} +9 -9
- data/spec/models/{quota_ref_object_spec.rb → addition_links_spec.rb} +7 -7
- data/spec/models/{labels_spec.rb → annotations_spec.rb} +7 -7
- data/spec/models/{chart_version_spec.rb → artifact_spec.rb} +39 -21
- data/spec/models/{search_repository_spec.rb → audit_log_spec.rb} +13 -13
- data/spec/models/authproxy_setting_spec.rb +65 -0
- data/spec/models/{cve_whitelist_item_spec.rb → cve_allowlist_item_spec.rb} +7 -7
- data/spec/models/{quota_spec.rb → cve_allowlist_spec.rb} +10 -10
- data/spec/models/{endpoint_spec.rb → error_spec.rb} +9 -9
- data/spec/models/{action_spec.rb → errors_spec.rb} +8 -8
- data/spec/models/{gc_result_spec.rb → execution_spec.rb} +21 -15
- data/spec/models/{event_type_spec.rb → extra_attrs_spec.rb} +7 -7
- data/spec/models/general_info_spec.rb +25 -1
- data/spec/models/{namespace_spec.rb → icon_spec.rb} +9 -9
- data/spec/models/{chart_metadata_spec.rb → instance_spec.rb} +23 -17
- data/spec/models/label_spec.rb +1 -7
- data/spec/models/{email_server_setting_spec.rb → metadata_spec.rb} +13 -13
- data/spec/models/{ping_registry_spec.rb → metrics_spec.rb} +14 -14
- data/spec/models/{ldap_conf_spec.rb → native_report_summary_spec.rb} +15 -15
- data/spec/models/permission_spec.rb +9 -3
- data/spec/models/{registry_info_spec.rb → platform_spec.rb} +17 -11
- data/spec/models/{webhook_policy_spec.rb → preheat_policy_spec.rb} +19 -13
- data/spec/models/{bool_config_item_spec.rb → project_deletable_spec.rb} +9 -9
- data/spec/models/project_metadata_spec.rb +8 -2
- data/spec/models/project_req_spec.rb +10 -4
- data/spec/models/project_spec.rb +8 -2
- data/spec/models/project_summary_quota_spec.rb +1 -1
- data/spec/models/project_summary_spec.rb +14 -2
- data/spec/models/{immutable_tag_rule_spec.rb → provider_under_project_spec.rb} +10 -10
- data/spec/models/{statistic_map_spec.rb → reference_spec.rb} +13 -13
- data/spec/models/registry_credential_spec.rb +1 -1
- data/spec/models/registry_spec.rb +1 -1
- data/spec/models/replication_execution_spec.rb +10 -10
- data/spec/models/replication_task_spec.rb +12 -6
- data/spec/models/{robot_account_spec.rb → repository_spec.rb} +12 -12
- data/spec/models/resource_list_spec.rb +1 -1
- data/spec/models/{put_registry_spec.rb → robot_create_spec.rb} +12 -12
- data/spec/models/{robot_account_create_spec.rb → robot_create_v1_spec.rb} +7 -7
- data/spec/models/{retention_policy_spec.rb → robot_created_spec.rb} +11 -11
- data/spec/models/{input_secret_spec.rb → robot_sec_spec.rb} +7 -7
- data/spec/models/{replication_policy_spec.rb → robot_spec.rb} +14 -20
- data/spec/models/{notify_type_spec.rb → scan_overview_spec.rb} +7 -7
- data/spec/models/{unauthorized_chart_api_error_spec.rb → start_replication_execution_spec.rb} +8 -8
- data/spec/models/storage_spec.rb +1 -1
- data/spec/models/system_info_spec.rb +1 -1
- data/spec/models/{webhook_job_spec.rb → tag_spec.rb} +14 -14
- data/spec/models/{retention_execution_task_spec.rb → task_spec.rb} +15 -21
- data/spec/models/{project_member_spec.rb → vulnerability_summary_spec.rb} +10 -10
- data/spec/spec_helper.rb +1 -1
- metadata +204 -423
- data/docs/AdminJobSchedule.md +0 -9
- data/docs/AdminJobScheduleObj.md +0 -9
- data/docs/BadRequestFormatedError.md +0 -8
- data/docs/BoolConfigItem.md +0 -9
- data/docs/CVEWhitelist.md +0 -11
- data/docs/ChartAPIError.md +0 -8
- data/docs/ChartMetadata.md +0 -18
- data/docs/ChartRepositoryApi.md +0 -191
- data/docs/ChartVersion.md +0 -22
- data/docs/ComponentHealthStatus.md +0 -10
- data/docs/ComponentOverviewEntry.md +0 -9
- data/docs/Configurations.md +0 -42
- data/docs/ConfigurationsResponse.md +0 -41
- data/docs/ConfigurationsScanAllPolicy.md +0 -9
- data/docs/ConfigurationsScanAllPolicyParameter.md +0 -8
- data/docs/ConflictFormatedError.md +0 -8
- data/docs/EmailServerSetting.md +0 -13
- data/docs/Endpoint.md +0 -9
- data/docs/FilterStyle.md +0 -10
- data/docs/ForbiddenChartAPIError.md +0 -8
- data/docs/GCResult.md +0 -16
- data/docs/InputSecret.md +0 -8
- data/docs/InsufficientStorageChartAPIError.md +0 -8
- data/docs/IntegerConfigItem.md +0 -9
- data/docs/InternalChartAPIError.md +0 -8
- data/docs/IsDefault.md +0 -8
- data/docs/LabelApi.md +0 -191
- data/docs/LdapConf.md +0 -15
- data/docs/LdapFailedImportUsers.md +0 -9
- data/docs/LdapImportUsers.md +0 -8
- data/docs/LdapUsers.md +0 -10
- data/docs/Namespace.md +0 -9
- data/docs/NotFoundChartAPIError.md +0 -8
- data/docs/OverallHealthStatus.md +0 -9
- data/docs/Password.md +0 -9
- data/docs/PingRegistry.md +0 -14
- data/docs/ProductsApi.md +0 -6768
- data/docs/ProjectMember.md +0 -10
- data/docs/ProjectMemberEntity.md +0 -14
- data/docs/ProjectScanner.md +0 -8
- data/docs/PutRegistry.md +0 -14
- data/docs/Quota.md +0 -13
- data/docs/QuotaApi.md +0 -118
- data/docs/QuotaSwitcher.md +0 -8
- data/docs/QuotaUpdateReq.md +0 -8
- data/docs/RegistryInfo.md +0 -11
- data/docs/ReplicationFilter.md +0 -9
- data/docs/ReplicationPolicy.md +0 -20
- data/docs/ReplicationTrigger.md +0 -9
- data/docs/RetentionApi.md +0 -449
- data/docs/RetentionExecution.md +0 -14
- data/docs/RetentionExecutionTask.md +0 -18
- data/docs/RetentionMetadata.md +0 -10
- data/docs/RetentionPolicy.md +0 -12
- data/docs/RetentionPolicyScope.md +0 -9
- data/docs/RetentionRule.md +0 -15
- data/docs/RetentionRuleMetadata.md +0 -11
- data/docs/RetentionRuleParamMetadata.md +0 -10
- data/docs/RetentionRuleTrigger.md +0 -10
- data/docs/RetentionSelector.md +0 -11
- data/docs/RetentionSelectorMetadata.md +0 -10
- data/docs/RobotAccount.md +0 -15
- data/docs/RobotAccountAccess.md +0 -9
- data/docs/RobotAccountApi.md +0 -291
- data/docs/RobotAccountPostRep.md +0 -9
- data/docs/RobotAccountUpdate.md +0 -8
- data/docs/Role.md +0 -11
- data/docs/RoleParam.md +0 -9
- data/docs/RoleRequest.md +0 -8
- data/docs/Scanner.md +0 -10
- data/docs/ScannerAdapterMetadata.md +0 -10
- data/docs/ScannerCapability.md +0 -9
- data/docs/ScannerRegistration.md +0 -21
- data/docs/ScannerRegistrationReq.md +0 -15
- data/docs/ScannerRegistrationSettings.md +0 -11
- data/docs/ScannersApi.md +0 -600
- data/docs/Search.md +0 -10
- data/docs/SearchRepository.md +0 -13
- data/docs/SearchResult.md +0 -10
- data/docs/StatisticMap.md +0 -13
- data/docs/Stats.md +0 -11
- data/docs/StringConfigItem.md +0 -9
- data/docs/SupportedWebhookEventTypes.md +0 -9
- data/docs/SysAdminFlag.md +0 -8
- data/docs/SystemApi.md +0 -163
- data/docs/TriggerSettings.md +0 -8
- data/docs/UnauthorizedChartAPIError.md +0 -8
- data/docs/User.md +0 -22
- data/docs/UserEntity.md +0 -9
- data/docs/UserGroup.md +0 -11
- data/docs/UserProfile.md +0 -10
- data/docs/UserSearch.md +0 -9
- data/docs/WebhookJob.md +0 -15
- data/docs/WebhookLastTrigger.md +0 -11
- data/docs/WebhookPolicy.md +0 -17
- data/docs/WebhookTargetObject.md +0 -11
- data/lib/harbor_swagger_client/api/chart_repository_api.rb +0 -230
- data/lib/harbor_swagger_client/api/label_api.rb +0 -230
- data/lib/harbor_swagger_client/api/products_api.rb +0 -6879
- data/lib/harbor_swagger_client/api/quota_api.rb +0 -136
- data/lib/harbor_swagger_client/api/retention_api.rb +0 -482
- data/lib/harbor_swagger_client/api/robot_account_api.rb +0 -321
- data/lib/harbor_swagger_client/api/scanners_api.rb +0 -624
- data/lib/harbor_swagger_client/api/system_api.rb +0 -173
- data/lib/harbor_swagger_client/models/admin_job_schedule.rb +0 -195
- data/lib/harbor_swagger_client/models/admin_job_schedule_obj.rb +0 -194
- data/lib/harbor_swagger_client/models/bad_request_formated_error.rb +0 -190
- data/lib/harbor_swagger_client/models/bool_config_item.rb +0 -194
- data/lib/harbor_swagger_client/models/chart_api_error.rb +0 -190
- data/lib/harbor_swagger_client/models/chart_metadata.rb +0 -319
- data/lib/harbor_swagger_client/models/component_health_status.rb +0 -205
- data/lib/harbor_swagger_client/models/configurations.rb +0 -523
- data/lib/harbor_swagger_client/models/configurations_response.rb +0 -513
- data/lib/harbor_swagger_client/models/configurations_scan_all_policy_parameter.rb +0 -185
- data/lib/harbor_swagger_client/models/conflict_formated_error.rb +0 -190
- data/lib/harbor_swagger_client/models/filter_style.rb +0 -207
- data/lib/harbor_swagger_client/models/forbidden_chart_api_error.rb +0 -190
- data/lib/harbor_swagger_client/models/gc_result.rb +0 -263
- data/lib/harbor_swagger_client/models/insufficient_storage_chart_api_error.rb +0 -190
- data/lib/harbor_swagger_client/models/integer_config_item.rb +0 -194
- data/lib/harbor_swagger_client/models/internal_chart_api_error.rb +0 -190
- data/lib/harbor_swagger_client/models/is_default.rb +0 -184
- data/lib/harbor_swagger_client/models/ldap_conf.rb +0 -254
- data/lib/harbor_swagger_client/models/ldap_import_users.rb +0 -186
- data/lib/harbor_swagger_client/models/ldap_users.rb +0 -204
- data/lib/harbor_swagger_client/models/not_found_chart_api_error.rb +0 -190
- data/lib/harbor_swagger_client/models/overall_health_status.rb +0 -196
- data/lib/harbor_swagger_client/models/password.rb +0 -194
- data/lib/harbor_swagger_client/models/ping_registry.rb +0 -244
- data/lib/harbor_swagger_client/models/project_member.rb +0 -202
- data/lib/harbor_swagger_client/models/project_member_entity.rb +0 -244
- data/lib/harbor_swagger_client/models/project_scanner.rb +0 -184
- data/lib/harbor_swagger_client/models/quota_switcher.rb +0 -184
- data/lib/harbor_swagger_client/models/quota_update_req.rb +0 -184
- data/lib/harbor_swagger_client/models/registry_info.rb +0 -219
- data/lib/harbor_swagger_client/models/replication_filter.rb +0 -194
- data/lib/harbor_swagger_client/models/replication_trigger.rb +0 -193
- data/lib/harbor_swagger_client/models/retention_metadata.rb +0 -211
- data/lib/harbor_swagger_client/models/retention_policy_scope.rb +0 -192
- data/lib/harbor_swagger_client/models/retention_rule_metadata.rb +0 -217
- data/lib/harbor_swagger_client/models/retention_rule_param_metadata.rb +0 -202
- data/lib/harbor_swagger_client/models/retention_rule_trigger.rb +0 -201
- data/lib/harbor_swagger_client/models/retention_selector.rb +0 -210
- data/lib/harbor_swagger_client/models/retention_selector_metadata.rb +0 -204
- data/lib/harbor_swagger_client/models/robot_account_post_rep.rb +0 -194
- data/lib/harbor_swagger_client/models/robot_account_update.rb +0 -184
- data/lib/harbor_swagger_client/models/role.rb +0 -213
- data/lib/harbor_swagger_client/models/role_param.rb +0 -196
- data/lib/harbor_swagger_client/models/role_request.rb +0 -184
- data/lib/harbor_swagger_client/models/scanner_capability.rb +0 -196
- data/lib/harbor_swagger_client/models/scanner_registration.rb +0 -327
- data/lib/harbor_swagger_client/models/scanner_registration_req.rb +0 -262
- data/lib/harbor_swagger_client/models/scanner_registration_settings.rb +0 -216
- data/lib/harbor_swagger_client/models/search.rb +0 -210
- data/lib/harbor_swagger_client/models/search_repository.rb +0 -234
- data/lib/harbor_swagger_client/models/search_result.rb +0 -204
- data/lib/harbor_swagger_client/models/statistic_map.rb +0 -234
- data/lib/harbor_swagger_client/models/string_config_item.rb +0 -194
- data/lib/harbor_swagger_client/models/supported_webhook_event_types.rb +0 -197
- data/lib/harbor_swagger_client/models/sys_admin_flag.rb +0 -184
- data/lib/harbor_swagger_client/models/trigger_settings.rb +0 -184
- data/lib/harbor_swagger_client/models/unauthorized_chart_api_error.rb +0 -190
- data/lib/harbor_swagger_client/models/user.rb +0 -311
- data/lib/harbor_swagger_client/models/user_entity.rb +0 -194
- data/lib/harbor_swagger_client/models/user_group.rb +0 -214
- data/lib/harbor_swagger_client/models/user_profile.rb +0 -204
- data/lib/harbor_swagger_client/models/user_search.rb +0 -193
- data/lib/harbor_swagger_client/models/webhook_last_trigger.rb +0 -215
- data/lib/harbor_swagger_client/models/webhook_target_object.rb +0 -215
- data/spec/api/chart_repository_api_spec.rb +0 -79
- data/spec/api/label_api_spec.rb +0 -79
- data/spec/api/products_api_spec.rb +0 -1581
- data/spec/api/quota_api_spec.rb +0 -60
- data/spec/api/retention_api_spec.rb +0 -136
- data/spec/api/robot_account_api_spec.rb +0 -100
- data/spec/api/scanners_api_spec.rb +0 -169
- data/spec/api/system_api_spec.rb +0 -70
- data/spec/models/action_1_spec.rb +0 -41
- data/spec/models/admin_job_schedule_obj_spec.rb +0 -47
- data/spec/models/admin_job_schedule_spec.rb +0 -47
- data/spec/models/bad_request_formated_error_spec.rb +0 -41
- data/spec/models/chart_api_error_spec.rb +0 -41
- data/spec/models/component_health_status_spec.rb +0 -53
- data/spec/models/component_overview_entry_spec.rb +0 -47
- data/spec/models/configurations_response_spec.rb +0 -239
- data/spec/models/configurations_scan_all_policy_parameter_spec.rb +0 -41
- data/spec/models/configurations_scan_all_policy_spec.rb +0 -47
- data/spec/models/configurations_spec.rb +0 -245
- data/spec/models/conflict_formated_error_spec.rb +0 -41
- data/spec/models/cve_whitelist_spec.rb +0 -59
- data/spec/models/filter_style_spec.rb +0 -53
- data/spec/models/forbidden_chart_api_error_spec.rb +0 -41
- data/spec/models/insufficient_storage_chart_api_error_spec.rb +0 -41
- data/spec/models/integer_config_item_spec.rb +0 -47
- data/spec/models/internal_chart_api_error_spec.rb +0 -41
- data/spec/models/is_default_spec.rb +0 -41
- data/spec/models/ldap_failed_import_users_spec.rb +0 -47
- data/spec/models/ldap_import_users_spec.rb +0 -41
- data/spec/models/ldap_users_spec.rb +0 -53
- data/spec/models/not_found_chart_api_error_spec.rb +0 -41
- data/spec/models/overall_health_status_spec.rb +0 -47
- data/spec/models/project_member_entity_spec.rb +0 -77
- data/spec/models/project_scanner_spec.rb +0 -41
- data/spec/models/quota_switcher_spec.rb +0 -41
- data/spec/models/quota_update_req_spec.rb +0 -41
- data/spec/models/replication_filter_spec.rb +0 -47
- data/spec/models/replication_trigger_spec.rb +0 -47
- data/spec/models/retention_execution_spec.rb +0 -77
- data/spec/models/retention_metadata_spec.rb +0 -53
- data/spec/models/retention_policy_scope_spec.rb +0 -47
- data/spec/models/retention_rule_metadata_spec.rb +0 -59
- data/spec/models/retention_rule_param_metadata_spec.rb +0 -53
- data/spec/models/retention_rule_spec.rb +0 -83
- data/spec/models/retention_rule_trigger_spec.rb +0 -53
- data/spec/models/retention_selector_metadata_spec.rb +0 -53
- data/spec/models/retention_selector_spec.rb +0 -59
- data/spec/models/robot_account_access_spec.rb +0 -47
- data/spec/models/robot_account_post_rep_spec.rb +0 -47
- data/spec/models/robot_account_update_spec.rb +0 -41
- data/spec/models/role_param_spec.rb +0 -47
- data/spec/models/role_request_spec.rb +0 -41
- data/spec/models/role_spec.rb +0 -59
- data/spec/models/scanner_adapter_metadata_spec.rb +0 -53
- data/spec/models/scanner_capability_spec.rb +0 -47
- data/spec/models/scanner_registration_req_spec.rb +0 -83
- data/spec/models/scanner_registration_settings_spec.rb +0 -59
- data/spec/models/scanner_registration_spec.rb +0 -119
- data/spec/models/scanner_spec.rb +0 -53
- data/spec/models/search_result_spec.rb +0 -53
- data/spec/models/stats_spec.rb +0 -59
- data/spec/models/string_config_item_spec.rb +0 -47
- data/spec/models/supported_webhook_event_types_spec.rb +0 -47
- data/spec/models/sys_admin_flag_spec.rb +0 -41
- data/spec/models/trigger_settings_spec.rb +0 -41
- data/spec/models/user_entity_spec.rb +0 -47
- data/spec/models/user_group_spec.rb +0 -59
- data/spec/models/user_profile_spec.rb +0 -53
- data/spec/models/user_search_spec.rb +0 -47
- data/spec/models/user_spec.rb +0 -125
- data/spec/models/webhook_last_trigger_spec.rb +0 -59
- data/spec/models/webhook_target_object_spec.rb +0 -59
@@ -0,0 +1,18 @@
|
|
1
|
+
# SwaggerClient::PreheatPolicy
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | The ID of preheat policy | [optional]
|
7
|
+
**name** | **String** | The Name of preheat policy | [optional]
|
8
|
+
**description** | **String** | The Description of preheat policy | [optional]
|
9
|
+
**project_id** | **Integer** | The ID of preheat policy project | [optional]
|
10
|
+
**provider_id** | **Integer** | The ID of preheat policy provider | [optional]
|
11
|
+
**provider_name** | **String** | The Name of preheat policy provider | [optional]
|
12
|
+
**filters** | **String** | The Filters of preheat policy | [optional]
|
13
|
+
**trigger** | **String** | The Trigger of preheat policy | [optional]
|
14
|
+
**enabled** | **BOOLEAN** | Whether the preheat policy enabled | [optional]
|
15
|
+
**creation_time** | **DateTime** | The Create Time of preheat policy | [optional]
|
16
|
+
**update_time** | **DateTime** | The Update Time of preheat policy | [optional]
|
17
|
+
|
18
|
+
|
data/docs/Project.md
CHANGED
@@ -6,8 +6,9 @@ Name | Type | Description | Notes
|
|
6
6
|
**project_id** | **Integer** | Project ID | [optional]
|
7
7
|
**owner_id** | **Integer** | The owner ID of the project always means the creator of the project. | [optional]
|
8
8
|
**name** | **String** | The name of the project. | [optional]
|
9
|
-
**
|
10
|
-
**
|
9
|
+
**registry_id** | **Integer** | The ID of referenced registry when the project is a proxy cache project. | [optional]
|
10
|
+
**creation_time** | **DateTime** | The creation time of the project. | [optional]
|
11
|
+
**update_time** | **DateTime** | The update time of the project. | [optional]
|
11
12
|
**deleted** | **BOOLEAN** | A deletion mark of the project. | [optional]
|
12
13
|
**owner_name** | **String** | The owner name of the project. | [optional]
|
13
14
|
**togglable** | **BOOLEAN** | Correspond to the UI about whether the project's publicity is updatable (for UI) | [optional]
|
@@ -16,6 +17,6 @@ Name | Type | Description | Notes
|
|
16
17
|
**repo_count** | **Integer** | The number of the repositories under this project. | [optional]
|
17
18
|
**chart_count** | **Integer** | The total number of charts under this project. | [optional]
|
18
19
|
**metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional]
|
19
|
-
**
|
20
|
+
**cve_allowlist** | [**CVEAllowlist**](CVEAllowlist.md) | The CVE allowlist of this project. | [optional]
|
20
21
|
|
21
22
|
|
data/docs/ProjectApi.md
ADDED
@@ -0,0 +1,544 @@
|
|
1
|
+
# SwaggerClient::ProjectApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost/api/v2.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
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
|
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.
|
13
|
+
[**head_project**](ProjectApi.md#head_project) | **HEAD** /projects | Check if the project name user provided already exists.
|
14
|
+
[**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
|
+
|
17
|
+
|
18
|
+
# **create_project**
|
19
|
+
> create_project(project, opts)
|
20
|
+
|
21
|
+
Create a new project.
|
22
|
+
|
23
|
+
This endpoint is for user to create a new project.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'harbor_swagger_client'
|
29
|
+
# setup authorization
|
30
|
+
SwaggerClient.configure do |config|
|
31
|
+
# Configure HTTP basic authorization: basic
|
32
|
+
config.username = 'YOUR USERNAME'
|
33
|
+
config.password = 'YOUR PASSWORD'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = SwaggerClient::ProjectApi.new
|
37
|
+
|
38
|
+
project = SwaggerClient::ProjectReq.new # ProjectReq | New created project.
|
39
|
+
|
40
|
+
opts = {
|
41
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
#Create a new project.
|
46
|
+
api_instance.create_project(project, opts)
|
47
|
+
rescue SwaggerClient::ApiError => e
|
48
|
+
puts "Exception when calling ProjectApi->create_project: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**project** | [**ProjectReq**](ProjectReq.md)| New created project. |
|
57
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
58
|
+
|
59
|
+
### Return type
|
60
|
+
|
61
|
+
nil (empty response body)
|
62
|
+
|
63
|
+
### Authorization
|
64
|
+
|
65
|
+
[basic](../README.md#basic)
|
66
|
+
|
67
|
+
### HTTP request headers
|
68
|
+
|
69
|
+
- **Content-Type**: application/json
|
70
|
+
- **Accept**: application/json
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
# **delete_project**
|
75
|
+
> delete_project(project_id, opts)
|
76
|
+
|
77
|
+
Delete project by projectID
|
78
|
+
|
79
|
+
This endpoint is aimed to delete project by project ID.
|
80
|
+
|
81
|
+
### Example
|
82
|
+
```ruby
|
83
|
+
# load the gem
|
84
|
+
require 'harbor_swagger_client'
|
85
|
+
# setup authorization
|
86
|
+
SwaggerClient.configure do |config|
|
87
|
+
# Configure HTTP basic authorization: basic
|
88
|
+
config.username = 'YOUR USERNAME'
|
89
|
+
config.password = 'YOUR PASSWORD'
|
90
|
+
end
|
91
|
+
|
92
|
+
api_instance = SwaggerClient::ProjectApi.new
|
93
|
+
|
94
|
+
project_id = 789 # Integer | The ID of the project
|
95
|
+
|
96
|
+
opts = {
|
97
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
98
|
+
}
|
99
|
+
|
100
|
+
begin
|
101
|
+
#Delete project by projectID
|
102
|
+
api_instance.delete_project(project_id, opts)
|
103
|
+
rescue SwaggerClient::ApiError => e
|
104
|
+
puts "Exception when calling ProjectApi->delete_project: #{e}"
|
105
|
+
end
|
106
|
+
```
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**project_id** | **Integer**| The ID of the project |
|
113
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
114
|
+
|
115
|
+
### Return type
|
116
|
+
|
117
|
+
nil (empty response body)
|
118
|
+
|
119
|
+
### Authorization
|
120
|
+
|
121
|
+
[basic](../README.md#basic)
|
122
|
+
|
123
|
+
### HTTP request headers
|
124
|
+
|
125
|
+
- **Content-Type**: application/json
|
126
|
+
- **Accept**: application/json
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
# **get_logs**
|
131
|
+
> Array<AuditLog> get_logs(project_name, opts)
|
132
|
+
|
133
|
+
Get recent logs of the projects
|
134
|
+
|
135
|
+
Get recent logs of the projects
|
136
|
+
|
137
|
+
### Example
|
138
|
+
```ruby
|
139
|
+
# load the gem
|
140
|
+
require 'harbor_swagger_client'
|
141
|
+
# setup authorization
|
142
|
+
SwaggerClient.configure do |config|
|
143
|
+
# Configure HTTP basic authorization: basic
|
144
|
+
config.username = 'YOUR USERNAME'
|
145
|
+
config.password = 'YOUR PASSWORD'
|
146
|
+
end
|
147
|
+
|
148
|
+
api_instance = SwaggerClient::ProjectApi.new
|
149
|
+
|
150
|
+
project_name = 'project_name_example' # String | The name of the project
|
151
|
+
|
152
|
+
opts = {
|
153
|
+
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]
|
155
|
+
page: 1, # Integer | The page number
|
156
|
+
page_size: 10, # Integer | The size of per page
|
157
|
+
}
|
158
|
+
|
159
|
+
begin
|
160
|
+
#Get recent logs of the projects
|
161
|
+
result = api_instance.get_logs(project_name, opts)
|
162
|
+
p result
|
163
|
+
rescue SwaggerClient::ApiError => e
|
164
|
+
puts "Exception when calling ProjectApi->get_logs: #{e}"
|
165
|
+
end
|
166
|
+
```
|
167
|
+
|
168
|
+
### Parameters
|
169
|
+
|
170
|
+
Name | Type | Description | Notes
|
171
|
+
------------- | ------------- | ------------- | -------------
|
172
|
+
**project_name** | **String**| The name of the project |
|
173
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
174
|
+
**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]
|
175
|
+
**page** | **Integer**| The page number | [optional] [default to 1]
|
176
|
+
**page_size** | **Integer**| The size of per page | [optional] [default to 10]
|
177
|
+
|
178
|
+
### Return type
|
179
|
+
|
180
|
+
[**Array<AuditLog>**](AuditLog.md)
|
181
|
+
|
182
|
+
### Authorization
|
183
|
+
|
184
|
+
[basic](../README.md#basic)
|
185
|
+
|
186
|
+
### HTTP request headers
|
187
|
+
|
188
|
+
- **Content-Type**: application/json
|
189
|
+
- **Accept**: application/json
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
# **get_project**
|
194
|
+
> Project get_project(project_id, opts)
|
195
|
+
|
196
|
+
Return specific project detail information
|
197
|
+
|
198
|
+
This endpoint returns specific project information by project ID.
|
199
|
+
|
200
|
+
### Example
|
201
|
+
```ruby
|
202
|
+
# load the gem
|
203
|
+
require 'harbor_swagger_client'
|
204
|
+
# setup authorization
|
205
|
+
SwaggerClient.configure do |config|
|
206
|
+
# Configure HTTP basic authorization: basic
|
207
|
+
config.username = 'YOUR USERNAME'
|
208
|
+
config.password = 'YOUR PASSWORD'
|
209
|
+
end
|
210
|
+
|
211
|
+
api_instance = SwaggerClient::ProjectApi.new
|
212
|
+
|
213
|
+
project_id = 789 # Integer | The ID of the project
|
214
|
+
|
215
|
+
opts = {
|
216
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
217
|
+
}
|
218
|
+
|
219
|
+
begin
|
220
|
+
#Return specific project detail information
|
221
|
+
result = api_instance.get_project(project_id, opts)
|
222
|
+
p result
|
223
|
+
rescue SwaggerClient::ApiError => e
|
224
|
+
puts "Exception when calling ProjectApi->get_project: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
Name | Type | Description | Notes
|
231
|
+
------------- | ------------- | ------------- | -------------
|
232
|
+
**project_id** | **Integer**| The ID of the project |
|
233
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
234
|
+
|
235
|
+
### Return type
|
236
|
+
|
237
|
+
[**Project**](Project.md)
|
238
|
+
|
239
|
+
### Authorization
|
240
|
+
|
241
|
+
[basic](../README.md#basic)
|
242
|
+
|
243
|
+
### HTTP request headers
|
244
|
+
|
245
|
+
- **Content-Type**: application/json
|
246
|
+
- **Accept**: application/json
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
# **get_project_deletable**
|
251
|
+
> ProjectDeletable get_project_deletable(project_id, opts)
|
252
|
+
|
253
|
+
Get the deletable status of the project
|
254
|
+
|
255
|
+
Get the deletable status of the project
|
256
|
+
|
257
|
+
### Example
|
258
|
+
```ruby
|
259
|
+
# load the gem
|
260
|
+
require 'harbor_swagger_client'
|
261
|
+
# setup authorization
|
262
|
+
SwaggerClient.configure do |config|
|
263
|
+
# Configure HTTP basic authorization: basic
|
264
|
+
config.username = 'YOUR USERNAME'
|
265
|
+
config.password = 'YOUR PASSWORD'
|
266
|
+
end
|
267
|
+
|
268
|
+
api_instance = SwaggerClient::ProjectApi.new
|
269
|
+
|
270
|
+
project_id = 789 # Integer | The ID of the project
|
271
|
+
|
272
|
+
opts = {
|
273
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
274
|
+
}
|
275
|
+
|
276
|
+
begin
|
277
|
+
#Get the deletable status of the project
|
278
|
+
result = api_instance.get_project_deletable(project_id, opts)
|
279
|
+
p result
|
280
|
+
rescue SwaggerClient::ApiError => e
|
281
|
+
puts "Exception when calling ProjectApi->get_project_deletable: #{e}"
|
282
|
+
end
|
283
|
+
```
|
284
|
+
|
285
|
+
### Parameters
|
286
|
+
|
287
|
+
Name | Type | Description | Notes
|
288
|
+
------------- | ------------- | ------------- | -------------
|
289
|
+
**project_id** | **Integer**| The ID of the project |
|
290
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
291
|
+
|
292
|
+
### Return type
|
293
|
+
|
294
|
+
[**ProjectDeletable**](ProjectDeletable.md)
|
295
|
+
|
296
|
+
### Authorization
|
297
|
+
|
298
|
+
[basic](../README.md#basic)
|
299
|
+
|
300
|
+
### HTTP request headers
|
301
|
+
|
302
|
+
- **Content-Type**: application/json
|
303
|
+
- **Accept**: application/json
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
# **get_project_summary**
|
308
|
+
> ProjectSummary get_project_summary(project_id, opts)
|
309
|
+
|
310
|
+
Get summary of the project.
|
311
|
+
|
312
|
+
Get summary of the project.
|
313
|
+
|
314
|
+
### Example
|
315
|
+
```ruby
|
316
|
+
# load the gem
|
317
|
+
require 'harbor_swagger_client'
|
318
|
+
# setup authorization
|
319
|
+
SwaggerClient.configure do |config|
|
320
|
+
# Configure HTTP basic authorization: basic
|
321
|
+
config.username = 'YOUR USERNAME'
|
322
|
+
config.password = 'YOUR PASSWORD'
|
323
|
+
end
|
324
|
+
|
325
|
+
api_instance = SwaggerClient::ProjectApi.new
|
326
|
+
|
327
|
+
project_id = 789 # Integer | The ID of the project
|
328
|
+
|
329
|
+
opts = {
|
330
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
331
|
+
}
|
332
|
+
|
333
|
+
begin
|
334
|
+
#Get summary of the project.
|
335
|
+
result = api_instance.get_project_summary(project_id, opts)
|
336
|
+
p result
|
337
|
+
rescue SwaggerClient::ApiError => e
|
338
|
+
puts "Exception when calling ProjectApi->get_project_summary: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
### Parameters
|
343
|
+
|
344
|
+
Name | Type | Description | Notes
|
345
|
+
------------- | ------------- | ------------- | -------------
|
346
|
+
**project_id** | **Integer**| The ID of the project |
|
347
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
348
|
+
|
349
|
+
### Return type
|
350
|
+
|
351
|
+
[**ProjectSummary**](ProjectSummary.md)
|
352
|
+
|
353
|
+
### Authorization
|
354
|
+
|
355
|
+
[basic](../README.md#basic)
|
356
|
+
|
357
|
+
### HTTP request headers
|
358
|
+
|
359
|
+
- **Content-Type**: application/json
|
360
|
+
- **Accept**: application/json
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
# **head_project**
|
365
|
+
> head_project(project_name, opts)
|
366
|
+
|
367
|
+
Check if the project name user provided already exists.
|
368
|
+
|
369
|
+
This endpoint is used to check if the project name provided already exist.
|
370
|
+
|
371
|
+
### Example
|
372
|
+
```ruby
|
373
|
+
# load the gem
|
374
|
+
require 'harbor_swagger_client'
|
375
|
+
# setup authorization
|
376
|
+
SwaggerClient.configure do |config|
|
377
|
+
# Configure HTTP basic authorization: basic
|
378
|
+
config.username = 'YOUR USERNAME'
|
379
|
+
config.password = 'YOUR PASSWORD'
|
380
|
+
end
|
381
|
+
|
382
|
+
api_instance = SwaggerClient::ProjectApi.new
|
383
|
+
|
384
|
+
project_name = 'project_name_example' # String | Project name for checking exists.
|
385
|
+
|
386
|
+
opts = {
|
387
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
388
|
+
}
|
389
|
+
|
390
|
+
begin
|
391
|
+
#Check if the project name user provided already exists.
|
392
|
+
api_instance.head_project(project_name, opts)
|
393
|
+
rescue SwaggerClient::ApiError => e
|
394
|
+
puts "Exception when calling ProjectApi->head_project: #{e}"
|
395
|
+
end
|
396
|
+
```
|
397
|
+
|
398
|
+
### Parameters
|
399
|
+
|
400
|
+
Name | Type | Description | Notes
|
401
|
+
------------- | ------------- | ------------- | -------------
|
402
|
+
**project_name** | **String**| Project name for checking exists. |
|
403
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
404
|
+
|
405
|
+
### Return type
|
406
|
+
|
407
|
+
nil (empty response body)
|
408
|
+
|
409
|
+
### Authorization
|
410
|
+
|
411
|
+
[basic](../README.md#basic)
|
412
|
+
|
413
|
+
### HTTP request headers
|
414
|
+
|
415
|
+
- **Content-Type**: application/json
|
416
|
+
- **Accept**: application/json
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
# **list_projects**
|
421
|
+
> Array<Project> list_projects(opts)
|
422
|
+
|
423
|
+
List projects
|
424
|
+
|
425
|
+
This endpoint returns projects created by Harbor.
|
426
|
+
|
427
|
+
### Example
|
428
|
+
```ruby
|
429
|
+
# load the gem
|
430
|
+
require 'harbor_swagger_client'
|
431
|
+
# setup authorization
|
432
|
+
SwaggerClient.configure do |config|
|
433
|
+
# Configure HTTP basic authorization: basic
|
434
|
+
config.username = 'YOUR USERNAME'
|
435
|
+
config.password = 'YOUR PASSWORD'
|
436
|
+
end
|
437
|
+
|
438
|
+
api_instance = SwaggerClient::ProjectApi.new
|
439
|
+
|
440
|
+
opts = {
|
441
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
442
|
+
page: 1, # Integer | The page number
|
443
|
+
page_size: 10, # Integer | The size of per page
|
444
|
+
name: 'name_example', # String | The name of project.
|
445
|
+
public: true, # BOOLEAN | The project is public or private.
|
446
|
+
owner: 'owner_example', # String | The name of project owner.
|
447
|
+
with_detail: true # BOOLEAN | Bool value indicating whether return detailed information of the project
|
448
|
+
}
|
449
|
+
|
450
|
+
begin
|
451
|
+
#List projects
|
452
|
+
result = api_instance.list_projects(opts)
|
453
|
+
p result
|
454
|
+
rescue SwaggerClient::ApiError => e
|
455
|
+
puts "Exception when calling ProjectApi->list_projects: #{e}"
|
456
|
+
end
|
457
|
+
```
|
458
|
+
|
459
|
+
### Parameters
|
460
|
+
|
461
|
+
Name | Type | Description | Notes
|
462
|
+
------------- | ------------- | ------------- | -------------
|
463
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
464
|
+
**page** | **Integer**| The page number | [optional] [default to 1]
|
465
|
+
**page_size** | **Integer**| The size of per page | [optional] [default to 10]
|
466
|
+
**name** | **String**| The name of project. | [optional]
|
467
|
+
**public** | **BOOLEAN**| The project is public or private. | [optional]
|
468
|
+
**owner** | **String**| The name of project owner. | [optional]
|
469
|
+
**with_detail** | **BOOLEAN**| Bool value indicating whether return detailed information of the project | [optional] [default to true]
|
470
|
+
|
471
|
+
### Return type
|
472
|
+
|
473
|
+
[**Array<Project>**](Project.md)
|
474
|
+
|
475
|
+
### Authorization
|
476
|
+
|
477
|
+
[basic](../README.md#basic)
|
478
|
+
|
479
|
+
### HTTP request headers
|
480
|
+
|
481
|
+
- **Content-Type**: application/json
|
482
|
+
- **Accept**: application/json
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
# **update_project**
|
487
|
+
> update_project(project_idproject, opts)
|
488
|
+
|
489
|
+
Update properties for a selected project.
|
490
|
+
|
491
|
+
This endpoint is aimed to update the properties of a project.
|
492
|
+
|
493
|
+
### Example
|
494
|
+
```ruby
|
495
|
+
# load the gem
|
496
|
+
require 'harbor_swagger_client'
|
497
|
+
# setup authorization
|
498
|
+
SwaggerClient.configure do |config|
|
499
|
+
# Configure HTTP basic authorization: basic
|
500
|
+
config.username = 'YOUR USERNAME'
|
501
|
+
config.password = 'YOUR PASSWORD'
|
502
|
+
end
|
503
|
+
|
504
|
+
api_instance = SwaggerClient::ProjectApi.new
|
505
|
+
|
506
|
+
project_id = 789 # Integer | The ID of the project
|
507
|
+
|
508
|
+
project = SwaggerClient::ProjectReq.new # ProjectReq | Updates of project.
|
509
|
+
|
510
|
+
opts = {
|
511
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
512
|
+
}
|
513
|
+
|
514
|
+
begin
|
515
|
+
#Update properties for a selected project.
|
516
|
+
api_instance.update_project(project_idproject, opts)
|
517
|
+
rescue SwaggerClient::ApiError => e
|
518
|
+
puts "Exception when calling ProjectApi->update_project: #{e}"
|
519
|
+
end
|
520
|
+
```
|
521
|
+
|
522
|
+
### Parameters
|
523
|
+
|
524
|
+
Name | Type | Description | Notes
|
525
|
+
------------- | ------------- | ------------- | -------------
|
526
|
+
**project_id** | **Integer**| The ID of the project |
|
527
|
+
**project** | [**ProjectReq**](ProjectReq.md)| Updates of project. |
|
528
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
529
|
+
|
530
|
+
### Return type
|
531
|
+
|
532
|
+
nil (empty response body)
|
533
|
+
|
534
|
+
### Authorization
|
535
|
+
|
536
|
+
[basic](../README.md#basic)
|
537
|
+
|
538
|
+
### HTTP request headers
|
539
|
+
|
540
|
+
- **Content-Type**: application/json
|
541
|
+
- **Accept**: application/json
|
542
|
+
|
543
|
+
|
544
|
+
|