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
data/docs/Access.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggerClient::Access
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**resource** | **String** | The resource of the access | [optional]
|
7
|
+
**action** | **String** | The action of the access | [optional]
|
8
|
+
**effect** | **String** | The effect of the access | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::AdditionLink
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**href** | **String** | The link of the addition | [optional]
|
7
|
+
**absolute** | **BOOLEAN** | Determine whether the link is an absolute URL or not | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Artifact.md
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# SwaggerClient::Artifact
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | The ID of the artifact | [optional]
|
7
|
+
**type** | **String** | The type of the artifact, e.g. image, chart, etc | [optional]
|
8
|
+
**media_type** | **String** | The media type of the artifact | [optional]
|
9
|
+
**manifest_media_type** | **String** | The manifest media type of the artifact | [optional]
|
10
|
+
**project_id** | **Integer** | The ID of the project that the artifact belongs to | [optional]
|
11
|
+
**repository_id** | **Integer** | The ID of the repository that the artifact belongs to | [optional]
|
12
|
+
**digest** | **String** | The digest of the artifact | [optional]
|
13
|
+
**size** | **Integer** | The size of the artifact | [optional]
|
14
|
+
**icon** | **String** | The digest of the icon | [optional]
|
15
|
+
**push_time** | **DateTime** | The push time of the artifact | [optional]
|
16
|
+
**pull_time** | **DateTime** | The latest pull time of the artifact | [optional]
|
17
|
+
**extra_attrs** | [**ExtraAttrs**](ExtraAttrs.md) | | [optional]
|
18
|
+
**annotations** | [**Annotations**](Annotations.md) | | [optional]
|
19
|
+
**references** | [**Array<Reference>**](Reference.md) | | [optional]
|
20
|
+
**tags** | [**Array<Tag>**](Tag.md) | | [optional]
|
21
|
+
**addition_links** | [**AdditionLinks**](AdditionLinks.md) | | [optional]
|
22
|
+
**labels** | [**Array<Label>**](Label.md) | | [optional]
|
23
|
+
**scan_overview** | [**ScanOverview**](ScanOverview.md) | The overview of the scan result. | [optional]
|
24
|
+
|
25
|
+
|
data/docs/ArtifactApi.md
ADDED
@@ -0,0 +1,694 @@
|
|
1
|
+
# SwaggerClient::ArtifactApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost/api/v2.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_label**](ArtifactApi.md#add_label) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels | Add label to artifact
|
8
|
+
[**copy_artifact**](ArtifactApi.md#copy_artifact) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts | Copy artifact
|
9
|
+
[**create_tag**](ArtifactApi.md#create_tag) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags | Create tag
|
10
|
+
[**delete_artifact**](ArtifactApi.md#delete_artifact) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference} | Delete the specific artifact
|
11
|
+
[**delete_tag**](ArtifactApi.md#delete_tag) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags/{tag_name} | Delete tag
|
12
|
+
[**get_addition**](ArtifactApi.md#get_addition) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/{addition} | Get the addition of the specific artifact
|
13
|
+
[**get_artifact**](ArtifactApi.md#get_artifact) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference} | Get the specific artifact
|
14
|
+
[**list_artifacts**](ArtifactApi.md#list_artifacts) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts | List artifacts
|
15
|
+
[**list_tags**](ArtifactApi.md#list_tags) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags | List tags
|
16
|
+
[**remove_label**](ArtifactApi.md#remove_label) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels/{label_id} | Remove label from artifact
|
17
|
+
|
18
|
+
|
19
|
+
# **add_label**
|
20
|
+
> add_label(project_namerepository_name, reference, label, opts)
|
21
|
+
|
22
|
+
Add label to artifact
|
23
|
+
|
24
|
+
Add label to the specified artiact.
|
25
|
+
|
26
|
+
### Example
|
27
|
+
```ruby
|
28
|
+
# load the gem
|
29
|
+
require 'harbor_swagger_client'
|
30
|
+
# setup authorization
|
31
|
+
SwaggerClient.configure do |config|
|
32
|
+
# Configure HTTP basic authorization: basic
|
33
|
+
config.username = 'YOUR USERNAME'
|
34
|
+
config.password = 'YOUR PASSWORD'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
38
|
+
|
39
|
+
project_name = 'project_name_example' # String | The name of the project
|
40
|
+
|
41
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
42
|
+
|
43
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
44
|
+
|
45
|
+
label = SwaggerClient::Label.new # Label | The label that added to the artifact. Only the ID property is needed.
|
46
|
+
|
47
|
+
opts = {
|
48
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
49
|
+
}
|
50
|
+
|
51
|
+
begin
|
52
|
+
#Add label to artifact
|
53
|
+
api_instance.add_label(project_namerepository_name, reference, label, opts)
|
54
|
+
rescue SwaggerClient::ApiError => e
|
55
|
+
puts "Exception when calling ArtifactApi->add_label: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
Name | Type | Description | Notes
|
62
|
+
------------- | ------------- | ------------- | -------------
|
63
|
+
**project_name** | **String**| The name of the project |
|
64
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
65
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
66
|
+
**label** | [**Label**](Label.md)| The label that added to the artifact. Only the ID property is needed. |
|
67
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
nil (empty response body)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[basic](../README.md#basic)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: application/json
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
# **copy_artifact**
|
85
|
+
> copy_artifact(project_namerepository_name, from, opts)
|
86
|
+
|
87
|
+
Copy artifact
|
88
|
+
|
89
|
+
Copy the artifact specified in the \"from\" parameter to the repository.
|
90
|
+
|
91
|
+
### Example
|
92
|
+
```ruby
|
93
|
+
# load the gem
|
94
|
+
require 'harbor_swagger_client'
|
95
|
+
# setup authorization
|
96
|
+
SwaggerClient.configure do |config|
|
97
|
+
# Configure HTTP basic authorization: basic
|
98
|
+
config.username = 'YOUR USERNAME'
|
99
|
+
config.password = 'YOUR PASSWORD'
|
100
|
+
end
|
101
|
+
|
102
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
103
|
+
|
104
|
+
project_name = 'project_name_example' # String | The name of the project
|
105
|
+
|
106
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
107
|
+
|
108
|
+
from = 'from_example' # String | The artifact from which the new artifact is copied from, the format should be \"project/repository:tag\" or \"project/repository@digest\".
|
109
|
+
|
110
|
+
opts = {
|
111
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
112
|
+
}
|
113
|
+
|
114
|
+
begin
|
115
|
+
#Copy artifact
|
116
|
+
api_instance.copy_artifact(project_namerepository_name, from, opts)
|
117
|
+
rescue SwaggerClient::ApiError => e
|
118
|
+
puts "Exception when calling ArtifactApi->copy_artifact: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
### Parameters
|
123
|
+
|
124
|
+
Name | Type | Description | Notes
|
125
|
+
------------- | ------------- | ------------- | -------------
|
126
|
+
**project_name** | **String**| The name of the project |
|
127
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
128
|
+
**from** | **String**| The artifact from which the new artifact is copied from, the format should be \"project/repository:tag\" or \"project/repository@digest\". |
|
129
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
130
|
+
|
131
|
+
### Return type
|
132
|
+
|
133
|
+
nil (empty response body)
|
134
|
+
|
135
|
+
### Authorization
|
136
|
+
|
137
|
+
[basic](../README.md#basic)
|
138
|
+
|
139
|
+
### HTTP request headers
|
140
|
+
|
141
|
+
- **Content-Type**: application/json
|
142
|
+
- **Accept**: application/json
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
# **create_tag**
|
147
|
+
> create_tag(project_namerepository_name, reference, tag, opts)
|
148
|
+
|
149
|
+
Create tag
|
150
|
+
|
151
|
+
Create a tag for the specified artifact
|
152
|
+
|
153
|
+
### Example
|
154
|
+
```ruby
|
155
|
+
# load the gem
|
156
|
+
require 'harbor_swagger_client'
|
157
|
+
# setup authorization
|
158
|
+
SwaggerClient.configure do |config|
|
159
|
+
# Configure HTTP basic authorization: basic
|
160
|
+
config.username = 'YOUR USERNAME'
|
161
|
+
config.password = 'YOUR PASSWORD'
|
162
|
+
end
|
163
|
+
|
164
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
165
|
+
|
166
|
+
project_name = 'project_name_example' # String | The name of the project
|
167
|
+
|
168
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
169
|
+
|
170
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
171
|
+
|
172
|
+
tag = SwaggerClient::Tag.new # Tag | The JSON object of tag.
|
173
|
+
|
174
|
+
opts = {
|
175
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
176
|
+
}
|
177
|
+
|
178
|
+
begin
|
179
|
+
#Create tag
|
180
|
+
api_instance.create_tag(project_namerepository_name, reference, tag, opts)
|
181
|
+
rescue SwaggerClient::ApiError => e
|
182
|
+
puts "Exception when calling ArtifactApi->create_tag: #{e}"
|
183
|
+
end
|
184
|
+
```
|
185
|
+
|
186
|
+
### Parameters
|
187
|
+
|
188
|
+
Name | Type | Description | Notes
|
189
|
+
------------- | ------------- | ------------- | -------------
|
190
|
+
**project_name** | **String**| The name of the project |
|
191
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
192
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
193
|
+
**tag** | [**Tag**](Tag.md)| The JSON object of tag. |
|
194
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
195
|
+
|
196
|
+
### Return type
|
197
|
+
|
198
|
+
nil (empty response body)
|
199
|
+
|
200
|
+
### Authorization
|
201
|
+
|
202
|
+
[basic](../README.md#basic)
|
203
|
+
|
204
|
+
### HTTP request headers
|
205
|
+
|
206
|
+
- **Content-Type**: application/json
|
207
|
+
- **Accept**: application/json
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
# **delete_artifact**
|
212
|
+
> delete_artifact(project_namerepository_name, reference, , opts)
|
213
|
+
|
214
|
+
Delete the specific artifact
|
215
|
+
|
216
|
+
Delete the artifact specified by the reference under the project and repository. The reference can be digest or tag
|
217
|
+
|
218
|
+
### Example
|
219
|
+
```ruby
|
220
|
+
# load the gem
|
221
|
+
require 'harbor_swagger_client'
|
222
|
+
# setup authorization
|
223
|
+
SwaggerClient.configure do |config|
|
224
|
+
# Configure HTTP basic authorization: basic
|
225
|
+
config.username = 'YOUR USERNAME'
|
226
|
+
config.password = 'YOUR PASSWORD'
|
227
|
+
end
|
228
|
+
|
229
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
230
|
+
|
231
|
+
project_name = 'project_name_example' # String | The name of the project
|
232
|
+
|
233
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
234
|
+
|
235
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
236
|
+
|
237
|
+
opts = {
|
238
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
239
|
+
}
|
240
|
+
|
241
|
+
begin
|
242
|
+
#Delete the specific artifact
|
243
|
+
api_instance.delete_artifact(project_namerepository_name, reference, , opts)
|
244
|
+
rescue SwaggerClient::ApiError => e
|
245
|
+
puts "Exception when calling ArtifactApi->delete_artifact: #{e}"
|
246
|
+
end
|
247
|
+
```
|
248
|
+
|
249
|
+
### Parameters
|
250
|
+
|
251
|
+
Name | Type | Description | Notes
|
252
|
+
------------- | ------------- | ------------- | -------------
|
253
|
+
**project_name** | **String**| The name of the project |
|
254
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
255
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
256
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
257
|
+
|
258
|
+
### Return type
|
259
|
+
|
260
|
+
nil (empty response body)
|
261
|
+
|
262
|
+
### Authorization
|
263
|
+
|
264
|
+
[basic](../README.md#basic)
|
265
|
+
|
266
|
+
### HTTP request headers
|
267
|
+
|
268
|
+
- **Content-Type**: application/json
|
269
|
+
- **Accept**: application/json
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
# **delete_tag**
|
274
|
+
> delete_tag(project_namerepository_name, reference, tag_name, opts)
|
275
|
+
|
276
|
+
Delete tag
|
277
|
+
|
278
|
+
Delete the tag of the specified artifact
|
279
|
+
|
280
|
+
### Example
|
281
|
+
```ruby
|
282
|
+
# load the gem
|
283
|
+
require 'harbor_swagger_client'
|
284
|
+
# setup authorization
|
285
|
+
SwaggerClient.configure do |config|
|
286
|
+
# Configure HTTP basic authorization: basic
|
287
|
+
config.username = 'YOUR USERNAME'
|
288
|
+
config.password = 'YOUR PASSWORD'
|
289
|
+
end
|
290
|
+
|
291
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
292
|
+
|
293
|
+
project_name = 'project_name_example' # String | The name of the project
|
294
|
+
|
295
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
296
|
+
|
297
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
298
|
+
|
299
|
+
tag_name = 'tag_name_example' # String | The name of the tag
|
300
|
+
|
301
|
+
opts = {
|
302
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
303
|
+
}
|
304
|
+
|
305
|
+
begin
|
306
|
+
#Delete tag
|
307
|
+
api_instance.delete_tag(project_namerepository_name, reference, tag_name, opts)
|
308
|
+
rescue SwaggerClient::ApiError => e
|
309
|
+
puts "Exception when calling ArtifactApi->delete_tag: #{e}"
|
310
|
+
end
|
311
|
+
```
|
312
|
+
|
313
|
+
### Parameters
|
314
|
+
|
315
|
+
Name | Type | Description | Notes
|
316
|
+
------------- | ------------- | ------------- | -------------
|
317
|
+
**project_name** | **String**| The name of the project |
|
318
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
319
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
320
|
+
**tag_name** | **String**| The name of the tag |
|
321
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
322
|
+
|
323
|
+
### Return type
|
324
|
+
|
325
|
+
nil (empty response body)
|
326
|
+
|
327
|
+
### Authorization
|
328
|
+
|
329
|
+
[basic](../README.md#basic)
|
330
|
+
|
331
|
+
### HTTP request headers
|
332
|
+
|
333
|
+
- **Content-Type**: application/json
|
334
|
+
- **Accept**: application/json
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
# **get_addition**
|
339
|
+
> String get_addition(project_namerepository_name, reference, addition, opts)
|
340
|
+
|
341
|
+
Get the addition of the specific artifact
|
342
|
+
|
343
|
+
Get the addition of the artifact specified by the reference under the project and repository.
|
344
|
+
|
345
|
+
### Example
|
346
|
+
```ruby
|
347
|
+
# load the gem
|
348
|
+
require 'harbor_swagger_client'
|
349
|
+
# setup authorization
|
350
|
+
SwaggerClient.configure do |config|
|
351
|
+
# Configure HTTP basic authorization: basic
|
352
|
+
config.username = 'YOUR USERNAME'
|
353
|
+
config.password = 'YOUR PASSWORD'
|
354
|
+
end
|
355
|
+
|
356
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
357
|
+
|
358
|
+
project_name = 'project_name_example' # String | The name of the project
|
359
|
+
|
360
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
361
|
+
|
362
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
363
|
+
|
364
|
+
addition = 'addition_example' # String | The type of addition.
|
365
|
+
|
366
|
+
opts = {
|
367
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
368
|
+
}
|
369
|
+
|
370
|
+
begin
|
371
|
+
#Get the addition of the specific artifact
|
372
|
+
result = api_instance.get_addition(project_namerepository_name, reference, addition, opts)
|
373
|
+
p result
|
374
|
+
rescue SwaggerClient::ApiError => e
|
375
|
+
puts "Exception when calling ArtifactApi->get_addition: #{e}"
|
376
|
+
end
|
377
|
+
```
|
378
|
+
|
379
|
+
### Parameters
|
380
|
+
|
381
|
+
Name | Type | Description | Notes
|
382
|
+
------------- | ------------- | ------------- | -------------
|
383
|
+
**project_name** | **String**| The name of the project |
|
384
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
385
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
386
|
+
**addition** | **String**| The type of addition. |
|
387
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
388
|
+
|
389
|
+
### Return type
|
390
|
+
|
391
|
+
**String**
|
392
|
+
|
393
|
+
### Authorization
|
394
|
+
|
395
|
+
[basic](../README.md#basic)
|
396
|
+
|
397
|
+
### HTTP request headers
|
398
|
+
|
399
|
+
- **Content-Type**: application/json
|
400
|
+
- **Accept**: application/json
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
# **get_artifact**
|
405
|
+
> Artifact get_artifact(project_namerepository_name, reference, , opts)
|
406
|
+
|
407
|
+
Get the specific artifact
|
408
|
+
|
409
|
+
Get the artifact specified by the reference under the project and repository. The reference can be digest or tag.
|
410
|
+
|
411
|
+
### Example
|
412
|
+
```ruby
|
413
|
+
# load the gem
|
414
|
+
require 'harbor_swagger_client'
|
415
|
+
# setup authorization
|
416
|
+
SwaggerClient.configure do |config|
|
417
|
+
# Configure HTTP basic authorization: basic
|
418
|
+
config.username = 'YOUR USERNAME'
|
419
|
+
config.password = 'YOUR PASSWORD'
|
420
|
+
end
|
421
|
+
|
422
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
423
|
+
|
424
|
+
project_name = 'project_name_example' # String | The name of the project
|
425
|
+
|
426
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
427
|
+
|
428
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
429
|
+
|
430
|
+
opts = {
|
431
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
432
|
+
page: 1, # Integer | The page number
|
433
|
+
page_size: 10, # Integer | The size of per page
|
434
|
+
with_tag: true, # BOOLEAN | Specify whether the tags are inclued inside the returning artifacts
|
435
|
+
with_label: false, # BOOLEAN | Specify whether the labels are inclued inside the returning artifacts
|
436
|
+
with_scan_overview: false, # BOOLEAN | Specify whether the scan overview is inclued inside the returning artifacts
|
437
|
+
with_signature: false, # BOOLEAN | Specify whether the signature is inclued inside the returning artifacts
|
438
|
+
with_immutable_status: false # BOOLEAN | Specify whether the immutable status is inclued inside the tags of the returning artifacts. Only works when setting \"with_tag=true\"
|
439
|
+
}
|
440
|
+
|
441
|
+
begin
|
442
|
+
#Get the specific artifact
|
443
|
+
result = api_instance.get_artifact(project_namerepository_name, reference, , opts)
|
444
|
+
p result
|
445
|
+
rescue SwaggerClient::ApiError => e
|
446
|
+
puts "Exception when calling ArtifactApi->get_artifact: #{e}"
|
447
|
+
end
|
448
|
+
```
|
449
|
+
|
450
|
+
### Parameters
|
451
|
+
|
452
|
+
Name | Type | Description | Notes
|
453
|
+
------------- | ------------- | ------------- | -------------
|
454
|
+
**project_name** | **String**| The name of the project |
|
455
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
456
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
457
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
458
|
+
**page** | **Integer**| The page number | [optional] [default to 1]
|
459
|
+
**page_size** | **Integer**| The size of per page | [optional] [default to 10]
|
460
|
+
**with_tag** | **BOOLEAN**| Specify whether the tags are inclued inside the returning artifacts | [optional] [default to true]
|
461
|
+
**with_label** | **BOOLEAN**| Specify whether the labels are inclued inside the returning artifacts | [optional] [default to false]
|
462
|
+
**with_scan_overview** | **BOOLEAN**| Specify whether the scan overview is inclued inside the returning artifacts | [optional] [default to false]
|
463
|
+
**with_signature** | **BOOLEAN**| Specify whether the signature is inclued inside the returning artifacts | [optional] [default to false]
|
464
|
+
**with_immutable_status** | **BOOLEAN**| Specify whether the immutable status is inclued inside the tags of the returning artifacts. Only works when setting \"with_tag=true\" | [optional] [default to false]
|
465
|
+
|
466
|
+
### Return type
|
467
|
+
|
468
|
+
[**Artifact**](Artifact.md)
|
469
|
+
|
470
|
+
### Authorization
|
471
|
+
|
472
|
+
[basic](../README.md#basic)
|
473
|
+
|
474
|
+
### HTTP request headers
|
475
|
+
|
476
|
+
- **Content-Type**: application/json
|
477
|
+
- **Accept**: application/json
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
# **list_artifacts**
|
482
|
+
> Array<Artifact> list_artifacts(project_namerepository_name, , opts)
|
483
|
+
|
484
|
+
List artifacts
|
485
|
+
|
486
|
+
List artifacts under the specific project and repository. Except the basic properties, the other supported queries in \"q\" includes \"tags=*\" to list only tagged artifacts, \"tags=nil\" to list only untagged artifacts, \"tags=~v\" to list artifacts whose tag fuzzy matches \"v\", \"tags=v\" to list artifact whose tag exactly matches \"v\", \"labels=(id1, id2)\" to list artifacts that both labels with id1 and id2 are added to
|
487
|
+
|
488
|
+
### Example
|
489
|
+
```ruby
|
490
|
+
# load the gem
|
491
|
+
require 'harbor_swagger_client'
|
492
|
+
# setup authorization
|
493
|
+
SwaggerClient.configure do |config|
|
494
|
+
# Configure HTTP basic authorization: basic
|
495
|
+
config.username = 'YOUR USERNAME'
|
496
|
+
config.password = 'YOUR PASSWORD'
|
497
|
+
end
|
498
|
+
|
499
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
500
|
+
|
501
|
+
project_name = 'project_name_example' # String | The name of the project
|
502
|
+
|
503
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
504
|
+
|
505
|
+
opts = {
|
506
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
507
|
+
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]
|
508
|
+
page: 1, # Integer | The page number
|
509
|
+
page_size: 10, # Integer | The size of per page
|
510
|
+
with_tag: true, # BOOLEAN | Specify whether the tags are included inside the returning artifacts
|
511
|
+
with_label: false, # BOOLEAN | Specify whether the labels are included inside the returning artifacts
|
512
|
+
with_scan_overview: false, # BOOLEAN | Specify whether the scan overview is included inside the returning artifacts
|
513
|
+
with_signature: false, # BOOLEAN | Specify whether the signature is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\"
|
514
|
+
with_immutable_status: false # BOOLEAN | Specify whether the immutable status is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\"
|
515
|
+
}
|
516
|
+
|
517
|
+
begin
|
518
|
+
#List artifacts
|
519
|
+
result = api_instance.list_artifacts(project_namerepository_name, , opts)
|
520
|
+
p result
|
521
|
+
rescue SwaggerClient::ApiError => e
|
522
|
+
puts "Exception when calling ArtifactApi->list_artifacts: #{e}"
|
523
|
+
end
|
524
|
+
```
|
525
|
+
|
526
|
+
### Parameters
|
527
|
+
|
528
|
+
Name | Type | Description | Notes
|
529
|
+
------------- | ------------- | ------------- | -------------
|
530
|
+
**project_name** | **String**| The name of the project |
|
531
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
532
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
533
|
+
**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]
|
534
|
+
**page** | **Integer**| The page number | [optional] [default to 1]
|
535
|
+
**page_size** | **Integer**| The size of per page | [optional] [default to 10]
|
536
|
+
**with_tag** | **BOOLEAN**| Specify whether the tags are included inside the returning artifacts | [optional] [default to true]
|
537
|
+
**with_label** | **BOOLEAN**| Specify whether the labels are included inside the returning artifacts | [optional] [default to false]
|
538
|
+
**with_scan_overview** | **BOOLEAN**| Specify whether the scan overview is included inside the returning artifacts | [optional] [default to false]
|
539
|
+
**with_signature** | **BOOLEAN**| Specify whether the signature is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\" | [optional] [default to false]
|
540
|
+
**with_immutable_status** | **BOOLEAN**| Specify whether the immutable status is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\" | [optional] [default to false]
|
541
|
+
|
542
|
+
### Return type
|
543
|
+
|
544
|
+
[**Array<Artifact>**](Artifact.md)
|
545
|
+
|
546
|
+
### Authorization
|
547
|
+
|
548
|
+
[basic](../README.md#basic)
|
549
|
+
|
550
|
+
### HTTP request headers
|
551
|
+
|
552
|
+
- **Content-Type**: application/json
|
553
|
+
- **Accept**: application/json
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
# **list_tags**
|
558
|
+
> Array<Tag> list_tags(project_namerepository_name, reference, , opts)
|
559
|
+
|
560
|
+
List tags
|
561
|
+
|
562
|
+
List tags of the specific artifact
|
563
|
+
|
564
|
+
### Example
|
565
|
+
```ruby
|
566
|
+
# load the gem
|
567
|
+
require 'harbor_swagger_client'
|
568
|
+
# setup authorization
|
569
|
+
SwaggerClient.configure do |config|
|
570
|
+
# Configure HTTP basic authorization: basic
|
571
|
+
config.username = 'YOUR USERNAME'
|
572
|
+
config.password = 'YOUR PASSWORD'
|
573
|
+
end
|
574
|
+
|
575
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
576
|
+
|
577
|
+
project_name = 'project_name_example' # String | The name of the project
|
578
|
+
|
579
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
580
|
+
|
581
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
582
|
+
|
583
|
+
opts = {
|
584
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
585
|
+
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]
|
586
|
+
page: 1, # Integer | The page number
|
587
|
+
page_size: 10, # Integer | The size of per page
|
588
|
+
with_signature: false, # BOOLEAN | Specify whether the signature is included inside the returning tags
|
589
|
+
with_immutable_status: false # BOOLEAN | Specify whether the immutable status is included inside the returning tags
|
590
|
+
}
|
591
|
+
|
592
|
+
begin
|
593
|
+
#List tags
|
594
|
+
result = api_instance.list_tags(project_namerepository_name, reference, , opts)
|
595
|
+
p result
|
596
|
+
rescue SwaggerClient::ApiError => e
|
597
|
+
puts "Exception when calling ArtifactApi->list_tags: #{e}"
|
598
|
+
end
|
599
|
+
```
|
600
|
+
|
601
|
+
### Parameters
|
602
|
+
|
603
|
+
Name | Type | Description | Notes
|
604
|
+
------------- | ------------- | ------------- | -------------
|
605
|
+
**project_name** | **String**| The name of the project |
|
606
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
607
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
608
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
609
|
+
**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]
|
610
|
+
**page** | **Integer**| The page number | [optional] [default to 1]
|
611
|
+
**page_size** | **Integer**| The size of per page | [optional] [default to 10]
|
612
|
+
**with_signature** | **BOOLEAN**| Specify whether the signature is included inside the returning tags | [optional] [default to false]
|
613
|
+
**with_immutable_status** | **BOOLEAN**| Specify whether the immutable status is included inside the returning tags | [optional] [default to false]
|
614
|
+
|
615
|
+
### Return type
|
616
|
+
|
617
|
+
[**Array<Tag>**](Tag.md)
|
618
|
+
|
619
|
+
### Authorization
|
620
|
+
|
621
|
+
[basic](../README.md#basic)
|
622
|
+
|
623
|
+
### HTTP request headers
|
624
|
+
|
625
|
+
- **Content-Type**: application/json
|
626
|
+
- **Accept**: application/json
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
# **remove_label**
|
631
|
+
> remove_label(project_namerepository_name, reference, label_id, opts)
|
632
|
+
|
633
|
+
Remove label from artifact
|
634
|
+
|
635
|
+
Remove the label from the specified artiact.
|
636
|
+
|
637
|
+
### Example
|
638
|
+
```ruby
|
639
|
+
# load the gem
|
640
|
+
require 'harbor_swagger_client'
|
641
|
+
# setup authorization
|
642
|
+
SwaggerClient.configure do |config|
|
643
|
+
# Configure HTTP basic authorization: basic
|
644
|
+
config.username = 'YOUR USERNAME'
|
645
|
+
config.password = 'YOUR PASSWORD'
|
646
|
+
end
|
647
|
+
|
648
|
+
api_instance = SwaggerClient::ArtifactApi.new
|
649
|
+
|
650
|
+
project_name = 'project_name_example' # String | The name of the project
|
651
|
+
|
652
|
+
repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
|
653
|
+
|
654
|
+
reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
|
655
|
+
|
656
|
+
label_id = 789 # Integer | The ID of the label that removed from the artifact.
|
657
|
+
|
658
|
+
opts = {
|
659
|
+
x_request_id: 'x_request_id_example' # String | An unique ID for the request
|
660
|
+
}
|
661
|
+
|
662
|
+
begin
|
663
|
+
#Remove label from artifact
|
664
|
+
api_instance.remove_label(project_namerepository_name, reference, label_id, opts)
|
665
|
+
rescue SwaggerClient::ApiError => e
|
666
|
+
puts "Exception when calling ArtifactApi->remove_label: #{e}"
|
667
|
+
end
|
668
|
+
```
|
669
|
+
|
670
|
+
### Parameters
|
671
|
+
|
672
|
+
Name | Type | Description | Notes
|
673
|
+
------------- | ------------- | ------------- | -------------
|
674
|
+
**project_name** | **String**| The name of the project |
|
675
|
+
**repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb |
|
676
|
+
**reference** | **String**| The reference of the artifact, can be digest or tag |
|
677
|
+
**label_id** | **Integer**| The ID of the label that removed from the artifact. |
|
678
|
+
**x_request_id** | **String**| An unique ID for the request | [optional]
|
679
|
+
|
680
|
+
### Return type
|
681
|
+
|
682
|
+
nil (empty response body)
|
683
|
+
|
684
|
+
### Authorization
|
685
|
+
|
686
|
+
[basic](../README.md#basic)
|
687
|
+
|
688
|
+
### HTTP request headers
|
689
|
+
|
690
|
+
- **Content-Type**: application/json
|
691
|
+
- **Accept**: application/json
|
692
|
+
|
693
|
+
|
694
|
+
|