harbor2_legacy_client 0.1.0

data/docs/Project.md

@@ -0,0 +1,22 @@
+# Harbor2LegacyClient::Project
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_id** | **Integer** | Project ID | [optional] 
+**owner_id** | **Integer** | The owner ID of the project always means the creator of the project. | [optional] 
+**name** | **String** | The name of the project. | [optional] 
+**registry_id** | **Integer** | The ID of referenced registry when the project is a proxy cache project. | [optional] 
+**creation_time** | **String** | The creation time of the project. | [optional] 
+**update_time** | **String** | The update time of the project. | [optional] 
+**deleted** | **BOOLEAN** | A deletion mark of the project. | [optional] 
+**owner_name** | **String** | The owner name of the project. | [optional] 
+**togglable** | **BOOLEAN** | Correspond to the UI about whether the project's publicity is  updatable (for UI) | [optional] 
+**current_user_role_id** | **Integer** | The role ID with highest permission of the current user who triggered the API (for UI).  This attribute is deprecated and will be removed in future versions. | [optional] 
+**current_user_role_ids** | **Array<Integer>** | The list of role ID of the current user who triggered the API (for UI) | [optional] 
+**repo_count** | **Integer** | The number of the repositories under this project. | [optional] 
+**chart_count** | **Integer** | The total number of charts under this project. | [optional] 
+**metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 
+**cve_allowlist** | [**CVEAllowlist**](CVEAllowlist.md) | The CVE allowlist of this project. | [optional] 
+
+

data/docs/ProjectMember.md

@@ -0,0 +1,10 @@
+# Harbor2LegacyClient::ProjectMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role_id** | **Integer** | The role id 1 for projectAdmin, 2 for developer, 3 for guest, 4 for maintainer | [optional] 
+**member_user** | [**UserEntity**](UserEntity.md) |  | [optional] 
+**member_group** | [**UserGroup**](UserGroup.md) |  | [optional] 
+
+

data/docs/ProjectMemberEntity.md

@@ -0,0 +1,14 @@
+# Harbor2LegacyClient::ProjectMemberEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | the project member id | [optional] 
+**project_id** | **Integer** | the project id | [optional] 
+**entity_name** | **String** | the name of the group member. | [optional] 
+**role_name** | **String** | the name of the role | [optional] 
+**role_id** | **Integer** | the role id | [optional] 
+**entity_id** | **Integer** | the id of entity, if the member is a user, it is user_id in user table. if the member is a user group, it is the user group's ID in user_group table. | [optional] 
+**entity_type** | **String** | the entity's type, u for user entity, g for group entity. | [optional] 
+
+

data/docs/ProjectMetadata.md

@@ -0,0 +1,13 @@
+# Harbor2LegacyClient::ProjectMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public** | **String** | The public status of the project. The valid values are \"true\", \"false\". | [optional] 
+**enable_content_trust** | **String** | Whether content trust is enabled or not. If it is enabled, user can't pull unsigned images from this project. The valid values are \"true\", \"false\". | [optional] 
+**prevent_vul** | **String** | Whether prevent the vulnerable images from running. The valid values are \"true\", \"false\". | [optional] 
+**severity** | **String** | If the vulnerability is high than severity defined here, the images can't be pulled. The valid values are \"none\", \"low\", \"medium\", \"high\", \"critical\". | [optional] 
+**auto_scan** | **String** | Whether scan images automatically when pushing. The valid values are \"true\", \"false\". | [optional] 
+**reuse_sys_cve_allowlist** | **String** | Whether this project reuse the system level CVE allowlist as the allowlist of its own.  The valid values are \"true\", \"false\". If it is set to \"true\" the actual allowlist associate with this project, if any, will be ignored. | [optional] 
+
+

data/docs/ProjectReq.md

@@ -0,0 +1,13 @@
+# Harbor2LegacyClient::ProjectReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_name** | **String** | The name of the project. | [optional] 
+**metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 
+**cve_allowlist** | [**CVEAllowlist**](CVEAllowlist.md) | The CVE allowlist of the project. | [optional] 
+**count_limit** | **Integer** | The count quota of the project. | [optional] 
+**storage_limit** | **Integer** | The storage quota of the project. | [optional] 
+**registry_id** | **Integer** | The ID of referenced registry when creating the proxy cache project | [optional] 
+
+

data/docs/ProjectScanner.md

@@ -0,0 +1,8 @@
+# Harbor2LegacyClient::ProjectScanner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | The identifier of the scanner registration | [optional] 
+
+

data/docs/ProjectSummary.md

@@ -0,0 +1,15 @@
+# Harbor2LegacyClient::ProjectSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repo_count** | **Integer** | The number of the repositories under this project. | [optional] 
+**chart_count** | **Integer** | The total number of charts under this project. | [optional] 
+**project_admin_count** | **Integer** | The total number of project admin members. | [optional] 
+**maintainer_count** | **Integer** | The total number of maintainer members. | [optional] 
+**developer_count** | **Integer** | The total number of developer members. | [optional] 
+**guest_count** | **Integer** | The total number of guest members. | [optional] 
+**quota** | [**ProjectSummaryQuota**](ProjectSummaryQuota.md) |  | [optional] 
+**registry** | [**Registry**](Registry.md) |  | [optional] 
+
+

data/docs/ProjectSummaryQuota.md

@@ -0,0 +1,9 @@
+# Harbor2LegacyClient::ProjectSummaryQuota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional] 
+**used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional] 
+
+

data/docs/PutRegistry.md

@@ -0,0 +1,14 @@
+# Harbor2LegacyClient::PutRegistry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The registry name. | [optional] 
+**description** | **String** | Description of the registry. | [optional] 
+**url** | **String** | The registry address URL string. | [optional] 
+**credential_type** | **String** | Credential type of the registry, e.g. 'basic'. | [optional] 
+**access_key** | **String** | The registry access key. | [optional] 
+**access_secret** | **String** | The registry access secret. | [optional] 
+**insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the server. | [optional] 
+
+

data/docs/Quota.md

@@ -0,0 +1,13 @@
+# Harbor2LegacyClient::Quota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the quota | [optional] 
+**ref** | [**QuotaRefObject**](QuotaRefObject.md) | The reference object of the quota | [optional] 
+**hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional] 
+**used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional] 
+**creation_time** | **String** | the creation time of the quota | [optional] 
+**update_time** | **String** | the update time of the quota | [optional] 
+
+

data/docs/QuotaApi.md

@@ -0,0 +1,118 @@
+# Harbor2LegacyClient::QuotaApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**quotas_id_get**](QuotaApi.md#quotas_id_get) | **GET** /quotas/{id} | Get the specified quota
+[**quotas_id_put**](QuotaApi.md#quotas_id_put) | **PUT** /quotas/{id} | Update the specified quota
+
+
+# **quotas_id_get**
+> Quota quotas_id_get(id)
+
+Get the specified quota
+
+Get the specified quota
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::QuotaApi.new
+
+id = 56 # Integer | Quota ID
+
+
+begin
+  #Get the specified quota
+  result = api_instance.quotas_id_get(id)
+  p result
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling QuotaApi->quotas_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Quota ID | 
+
+### Return type
+
+[**Quota**](Quota.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **quotas_id_put**
+> quotas_id_put(id, hard)
+
+Update the specified quota
+
+Update hard limits of the specified quota
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::QuotaApi.new
+
+id = 56 # Integer | Quota ID
+
+hard = Harbor2LegacyClient::QuotaUpdateReq.new # QuotaUpdateReq | The new hard limits for the quota
+
+
+begin
+  #Update the specified quota
+  api_instance.quotas_id_put(id, hard)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling QuotaApi->quotas_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Quota ID | 
+ **hard** | [**QuotaUpdateReq**](QuotaUpdateReq.md)| The new hard limits for the quota | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+

data/docs/QuotaRefObject.md

@@ -0,0 +1,7 @@
+# Harbor2LegacyClient::QuotaRefObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/QuotaSwitcher.md

@@ -0,0 +1,8 @@
+# Harbor2LegacyClient::QuotaSwitcher
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** | The quota is enable or disable | [optional] 
+
+

data/docs/QuotaUpdateReq.md

@@ -0,0 +1,8 @@
+# Harbor2LegacyClient::QuotaUpdateReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hard** | [**ResourceList**](ResourceList.md) | The new hard limits for the quota | [optional] 
+
+

data/docs/Registry.md

@@ -0,0 +1,17 @@
+# Harbor2LegacyClient::Registry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The registry ID. | [optional] 
+**url** | **String** | The registry URL string. | [optional] 
+**name** | **String** | The registry name. | [optional] 
+**credential** | [**RegistryCredential**](RegistryCredential.md) |  | [optional] 
+**type** | **String** | Type of the registry, e.g. 'harbor'. | [optional] 
+**insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the server. | [optional] 
+**description** | **String** | Description of the registry. | [optional] 
+**status** | **String** | Health status of the registry. | [optional] 
+**creation_time** | **String** | The create time of the policy. | [optional] 
+**update_time** | **String** | The update time of the policy. | [optional] 
+
+

data/docs/RegistryCredential.md

@@ -0,0 +1,10 @@
+# Harbor2LegacyClient::RegistryCredential
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Credential type, such as 'basic', 'oauth'. | [optional] 
+**access_key** | **String** | Access key, e.g. user name when credential type is 'basic'. | [optional] 
+**access_secret** | **String** | Access secret, e.g. password when credential type is 'basic'. | [optional] 
+
+

data/docs/RegistryInfo.md

@@ -0,0 +1,11 @@
+# Harbor2LegacyClient::RegistryInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The registry type | [optional] 
+**description** | **String** | The description | [optional] 
+**supported_resource_filters** | [**Array<FilterStyle>**](FilterStyle.md) | The filters that the registry supports | [optional] 
+**supported_triggers** | **Array<String>** | The triggers that the registry supports | [optional] 
+
+

data/docs/ReplicationExecution.md

@@ -0,0 +1,19 @@
+# Harbor2LegacyClient::ReplicationExecution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID | [optional] 
+**policy_id** | **Integer** | The policy ID | [optional] 
+**status** | **String** | The status | [optional] 
+**status_text** | **String** | The status text | [optional] 
+**trigger** | **String** | The trigger mode | [optional] 
+**total** | **Integer** | The total count of all tasks | [optional] 
+**failed** | **Integer** | The count of failed tasks | [optional] 
+**succeed** | **Integer** | The count of succeed tasks | [optional] 
+**in_progress** | **Integer** | The count of in_progress tasks | [optional] 
+**stopped** | **Integer** | The count of stopped tasks | [optional] 
+**start_time** | **String** | The start time | [optional] 
+**end_time** | **String** | The end time | [optional] 
+
+

data/docs/ReplicationFilter.md

@@ -0,0 +1,9 @@
+# Harbor2LegacyClient::ReplicationFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The replication policy filter type. | [optional] 
+**value** | **String** | The value of replication policy filter. | [optional] 
+
+

data/docs/ReplicationPolicy.md

@@ -0,0 +1,20 @@
+# Harbor2LegacyClient::ReplicationPolicy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The policy ID. | [optional] 
+**name** | **String** | The policy name. | [optional] 
+**description** | **String** | The description of the policy. | [optional] 
+**src_registry** | [**Registry**](Registry.md) | The source registry. | [optional] 
+**dest_registry** | [**Registry**](Registry.md) | The destination registry. | [optional] 
+**dest_namespace** | **String** | The destination namespace. | [optional] 
+**trigger** | [**ReplicationTrigger**](ReplicationTrigger.md) |  | [optional] 
+**filters** | [**Array<ReplicationFilter>**](ReplicationFilter.md) | The replication policy filter array. | [optional] 
+**deletion** | **BOOLEAN** | Whether to replicate the deletion operation. | [optional] 
+**override** | **BOOLEAN** | Whether to override the resources on the destination registry. | [optional] 
+**enabled** | **BOOLEAN** | Whether the policy is enabled or not. | [optional] 
+**creation_time** | **String** | The create time of the policy. | [optional] 
+**update_time** | **String** | The update time of the policy. | [optional] 
+
+

data/docs/ReplicationTask.md

@@ -0,0 +1,16 @@
+# Harbor2LegacyClient::ReplicationTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID | [optional] 
+**execution_id** | **Integer** | The execution ID | [optional] 
+**resource_type** | **String** | The resource type | [optional] 
+**src_resource** | **String** | The source resource | [optional] 
+**dst_resource** | **String** | The destination resource | [optional] 
+**job_id** | **String** | The job ID | [optional] 
+**status** | **String** | The status | [optional] 
+**start_time** | **String** | The start time | [optional] 
+**end_time** | **String** | The end time | [optional] 
+
+

data/docs/ReplicationTrigger.md

@@ -0,0 +1,9 @@
+# Harbor2LegacyClient::ReplicationTrigger
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The replication policy trigger type. The valid values are manual, event_based and scheduled. | [optional] 
+**trigger_settings** | [**TriggerSettings**](TriggerSettings.md) |  | [optional] 
+
+

data/docs/ResourceList.md

@@ -0,0 +1,7 @@
+# Harbor2LegacyClient::ResourceList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RetentionApi.md

@@ -0,0 +1,449 @@
+# Harbor2LegacyClient::RetentionApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**retentions_id_executions_eid_patch**](RetentionApi.md#retentions_id_executions_eid_patch) | **PATCH** /retentions/{id}/executions/{eid} | Stop a Retention job
+[**retentions_id_executions_eid_tasks_get**](RetentionApi.md#retentions_id_executions_eid_tasks_get) | **GET** /retentions/{id}/executions/{eid}/tasks | Get Retention job tasks
+[**retentions_id_executions_eid_tasks_tid_get**](RetentionApi.md#retentions_id_executions_eid_tasks_tid_get) | **GET** /retentions/{id}/executions/{eid}/tasks/{tid} | Get Retention job task log
+[**retentions_id_executions_get**](RetentionApi.md#retentions_id_executions_get) | **GET** /retentions/{id}/executions | Get a Retention job
+[**retentions_id_executions_post**](RetentionApi.md#retentions_id_executions_post) | **POST** /retentions/{id}/executions | Trigger a Retention job
+[**retentions_id_get**](RetentionApi.md#retentions_id_get) | **GET** /retentions/{id} | Get Retention Policy
+[**retentions_metadatas_get**](RetentionApi.md#retentions_metadatas_get) | **GET** /retentions/metadatas | Get Retention Metadatas
+[**retentions_post**](RetentionApi.md#retentions_post) | **POST** /retentions | Create Retention Policy
+
+
+# **retentions_id_executions_eid_patch**
+> retentions_id_executions_eid_patch(id, eid, action)
+
+Stop a Retention job
+
+Stop a Retention job, only support \"stop\" action now.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+id = 789 # Integer | Retention ID.
+
+eid = 789 # Integer | Retention execution ID.
+
+action = Harbor2LegacyClient::Action1.new # Action1 | The action, only support \"stop\" now.
+
+
+begin
+  #Stop a Retention job
+  api_instance.retentions_id_executions_eid_patch(id, eid, action)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_id_executions_eid_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Retention ID. | 
+ **eid** | **Integer**| Retention execution ID. | 
+ **action** | [**Action1**](Action1.md)| The action, only support \"stop\" now. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_id_executions_eid_tasks_get**
+> Array<RetentionExecutionTask> retentions_id_executions_eid_tasks_get(id, eid)
+
+Get Retention job tasks
+
+Get Retention job tasks, each repository as a task.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+id = 789 # Integer | Retention ID.
+
+eid = 789 # Integer | Retention execution ID.
+
+
+begin
+  #Get Retention job tasks
+  result = api_instance.retentions_id_executions_eid_tasks_get(id, eid)
+  p result
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_id_executions_eid_tasks_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Retention ID. | 
+ **eid** | **Integer**| Retention execution ID. | 
+
+### Return type
+
+[**Array<RetentionExecutionTask>**](RetentionExecutionTask.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_id_executions_eid_tasks_tid_get**
+> String retentions_id_executions_eid_tasks_tid_get(id, eid, tid)
+
+Get Retention job task log
+
+Get Retention job task log, tags ratain or deletion detail will be shown in a table.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+id = 789 # Integer | Retention ID.
+
+eid = 789 # Integer | Retention execution ID.
+
+tid = 789 # Integer | Retention execution ID.
+
+
+begin
+  #Get Retention job task log
+  result = api_instance.retentions_id_executions_eid_tasks_tid_get(id, eid, tid)
+  p result
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_id_executions_eid_tasks_tid_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Retention ID. | 
+ **eid** | **Integer**| Retention execution ID. | 
+ **tid** | **Integer**| Retention execution ID. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_id_executions_get**
+> Array<RetentionExecution> retentions_id_executions_get(id)
+
+Get a Retention job
+
+Get a Retention job, job status may be delayed before job service schedule it up.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+id = 789 # Integer | Retention ID.
+
+
+begin
+  #Get a Retention job
+  result = api_instance.retentions_id_executions_get(id)
+  p result
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_id_executions_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Retention ID. | 
+
+### Return type
+
+[**Array<RetentionExecution>**](RetentionExecution.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_id_executions_post**
+> retentions_id_executions_post(id, action)
+
+Trigger a Retention job
+
+Trigger a Retention job, if dry_run is True, nothing would be deleted actually.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+id = 789 # Integer | Retention ID.
+
+action = Harbor2LegacyClient::Action.new # Action | 
+
+
+begin
+  #Trigger a Retention job
+  api_instance.retentions_id_executions_post(id, action)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_id_executions_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Retention ID. | 
+ **action** | [**Action**](Action.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_id_get**
+> RetentionPolicy retentions_id_get(id)
+
+Get Retention Policy
+
+Get Retention Policy.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+id = 789 # Integer | Retention ID.
+
+
+begin
+  #Get Retention Policy
+  result = api_instance.retentions_id_get(id)
+  p result
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Retention ID. | 
+
+### Return type
+
+[**RetentionPolicy**](RetentionPolicy.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_metadatas_get**
+> RetentionMetadata retentions_metadatas_get
+
+Get Retention Metadatas
+
+Get Retention Metadatas.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+begin
+  #Get Retention Metadatas
+  result = api_instance.retentions_metadatas_get
+  p result
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_metadatas_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RetentionMetadata**](RetentionMetadata.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **retentions_post**
+> retentions_post(policy)
+
+Create Retention Policy
+
+Create Retention Policy, you can reference metadatas API for the policy model. You can check project metadatas to find whether a retention policy is already binded. This method should only be called when no retention policy binded to project yet. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::RetentionApi.new
+
+policy = Harbor2LegacyClient::RetentionPolicy.new # RetentionPolicy | Create Retention Policy successfully.
+
+
+begin
+  #Create Retention Policy
+  api_instance.retentions_post(policy)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling RetentionApi->retentions_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **policy** | [**RetentionPolicy**](RetentionPolicy.md)| Create Retention Policy successfully. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+