harbor2_legacy_client 0.2.1 → 2.3.3.0

data/docs/ReplicationExecution.md

@@ -1,19 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

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

data/docs/RetentionApi.md

@@ -1,449 +0,0 @@
-# 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
-
-
-

data/docs/RetentionExecution.md

@@ -1,14 +0,0 @@
-# Harbor2LegacyClient::RetentionExecution
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Integer** |  | [optional] 
-**policy_id** | **Integer** |  | [optional] 
-**start_time** | **String** |  | [optional] 
-**end_time** | **String** |  | [optional] 
-**status** | **String** |  | [optional] 
-**trigger** | **String** |  | [optional] 
-**dry_run** | **BOOLEAN** |  | [optional] 
-
-

data/docs/RetentionExecutionTask.md

@@ -1,18 +0,0 @@
-# Harbor2LegacyClient::RetentionExecutionTask
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Integer** |  | [optional] 
-**execution_id** | **Integer** |  | [optional] 
-**repository** | **String** |  | [optional] 
-**job_id** | **String** |  | [optional] 
-**status** | **String** |  | [optional] 
-**status_code** | **Integer** |  | [optional] 
-**status_revision** | **Integer** |  | [optional] 
-**start_time** | **String** |  | [optional] 
-**end_time** | **String** |  | [optional] 
-**total** | **Integer** |  | [optional] 
-**retained** | **Integer** |  | [optional] 
-
-

data/docs/RetentionMetadata.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::RetentionMetadata
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**templates** | [**Array<RetentionRuleMetadata>**](RetentionRuleMetadata.md) | templates | [optional] 
-**scope_selectors** | [**Array<RetentionSelectorMetadata>**](RetentionSelectorMetadata.md) | supported scope selectors | [optional] 
-**tag_selectors** | [**Array<RetentionSelectorMetadata>**](RetentionSelectorMetadata.md) | supported tag selectors | [optional] 
-
-

data/docs/RetentionPolicy.md

@@ -1,12 +0,0 @@
-# Harbor2LegacyClient::RetentionPolicy
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Integer** |  | [optional] 
-**algorithm** | **String** |  | [optional] 
-**rules** | [**Array<RetentionRule>**](RetentionRule.md) |  | [optional] 
-**trigger** | [**RetentionRuleTrigger**](RetentionRuleTrigger.md) |  | [optional] 
-**scope** | [**RetentionPolicyScope**](RetentionPolicyScope.md) |  | [optional] 
-
-

data/docs/RetentionPolicyScope.md

@@ -1,9 +0,0 @@
-# Harbor2LegacyClient::RetentionPolicyScope
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**level** | **String** |  | [optional] 
-**ref** | **Integer** |  | [optional] 
-
-

data/docs/RetentionRule.md

@@ -1,15 +0,0 @@
-# Harbor2LegacyClient::RetentionRule
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Integer** |  | [optional] 
-**priority** | **Integer** |  | [optional] 
-**disabled** | **BOOLEAN** |  | [optional] 
-**action** | **String** |  | [optional] 
-**template** | **String** |  | [optional] 
-**params** | **Hash<String, Object>** |  | [optional] 
-**tag_selectors** | [**Array<RetentionSelector>**](RetentionSelector.md) |  | [optional] 
-**scope_selectors** | **Hash<String, Array<RetentionSelector>>** |  | [optional] 
-
-

data/docs/RetentionRuleMetadata.md

@@ -1,11 +0,0 @@
-# Harbor2LegacyClient::RetentionRuleMetadata
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rule_template** | **String** | rule id | [optional] 
-**display_text** | **String** | rule display text | [optional] 
-**action** | **String** | rule action | [optional] 
-**params** | [**Array<RetentionRuleParamMetadata>**](RetentionRuleParamMetadata.md) | rule params | [optional] 
-
-

data/docs/RetentionRuleParamMetadata.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::RetentionRuleParamMetadata
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** |  | [optional] 
-**unit** | **String** |  | [optional] 
-**required** | **BOOLEAN** |  | [optional] 
-
-

data/docs/RetentionRuleTrigger.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::RetentionRuleTrigger
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**kind** | **String** |  | [optional] 
-**settings** | **Object** |  | [optional] 
-**references** | **Object** |  | [optional] 
-
-

data/docs/RetentionSelector.md

@@ -1,11 +0,0 @@
-# Harbor2LegacyClient::RetentionSelector
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**kind** | **String** |  | [optional] 
-**decoration** | **String** |  | [optional] 
-**pattern** | **String** |  | [optional] 
-**extras** | **String** |  | [optional] 
-
-

data/docs/RetentionSelectorMetadata.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::RetentionSelectorMetadata
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**display_text** | **String** |  | [optional] 
-**kind** | **String** |  | [optional] 
-**decorations** | **Array<String>** |  | [optional] 
-
-