harbor_swagger_client 1.0.4 → 2.0.0

data/docs/ProjectDeletable.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ProjectDeletable
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deletable** | **BOOLEAN** | Whether the project can be deleted. | [optional] 
+**message** | **String** | The detail message when the project can not be deleted. | [optional] 
+
+

data/docs/ProjectMetadata.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **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_whitelist** | **String** | Whether this project reuse the system level CVE whitelist as the whitelist of its own.  The valid values are \"true\", \"false\". If it is set to \"true\" the actual whitelist associate with this project, if any, will be ignored. | [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] 
+**retention_id** | **String** | The ID of the tag retention policy for the project | [optional] 
 
 

data/docs/ProjectReq.md

@@ -4,9 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **project_name** | **String** | The name of the project. | [optional] 
+**public** | **BOOLEAN** | deprecated, reserved for project creation in replication | [optional] 
 **metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 
-**cve_whitelist** | [**CVEWhitelist**](CVEWhitelist.md) | The CVE whitelist of the project. | [optional] 
-**count_limit** | **Integer** | The count quota of the project. | [optional] 
+**cve_allowlist** | [**CVEAllowlist**](CVEAllowlist.md) | The CVE allowlist 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/ProjectSummary.md

@@ -6,9 +6,11 @@ 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] 
-**master_count** | **Integer** | The total number of master 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] 
+**limited_guest_count** | **Integer** | The total number of limited guest members. | [optional] 
 **quota** | [**ProjectSummaryQuota**](ProjectSummaryQuota.md) |  | [optional] 
+**registry** | [**Registry**](Registry.md) |  | [optional] 
 
 

data/docs/{ImmutableTagRule.md → ProviderUnderProject.md}

@@ -1,11 +1,11 @@
-# SwaggerClient::ImmutableTagRule
+# SwaggerClient::ProviderUnderProject
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** |  | [optional] 
-**project_id** | **Integer** |  | [optional] 
-**tag_filter** | **String** |  | [optional] 
+**provider** | **String** |  | [optional] 
 **enabled** | **BOOLEAN** |  | [optional] 
+**default** | **BOOLEAN** |  | [optional] 
 
 

data/docs/Reference.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Reference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_id** | **Integer** | The parent ID of the reference | [optional] 
+**child_id** | **Integer** | The child ID of the reference | [optional] 
+**child_digest** | **String** | The digest of the child artifact | [optional] 
+**platform** | [**Platform**](Platform.md) |  | [optional] 
+**annotations** | [**Annotations**](Annotations.md) |  | [optional] 
+**urls** | **Array<String>** | The download URLs | [optional] 
+
+

data/docs/ReplicationApi.md

@@ -0,0 +1,352 @@
+# SwaggerClient::ReplicationApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_replication_execution**](ReplicationApi.md#get_replication_execution) | **GET** /replication/executions/{id} | Get the specific replication execution
+[**get_replication_log**](ReplicationApi.md#get_replication_log) | **GET** /replication/executions/{id}/tasks/{task_id}/log | Get the log of the specific replication task
+[**list_replication_executions**](ReplicationApi.md#list_replication_executions) | **GET** /replication/executions | List replication executions
+[**list_replication_tasks**](ReplicationApi.md#list_replication_tasks) | **GET** /replication/executions/{id}/tasks | List replication tasks for a specific execution
+[**start_replication**](ReplicationApi.md#start_replication) | **POST** /replication/executions | Start one replication execution
+[**stop_replication**](ReplicationApi.md#stop_replication) | **PUT** /replication/executions/{id} | Stop the specific replication execution
+
+
+# **get_replication_execution**
+> ReplicationExecution get_replication_execution(id)
+
+Get the specific replication execution
+
+Get the replication execution specified by ID
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ReplicationApi.new
+
+id = 789 # Integer | The ID of the execution.
+
+
+begin
+  #Get the specific replication execution
+  result = api_instance.get_replication_execution(id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReplicationApi->get_replication_execution: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| The ID of the execution. | 
+
+### Return type
+
+[**ReplicationExecution**](ReplicationExecution.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_replication_log**
+> String get_replication_log(id, task_id)
+
+Get the log of the specific replication task
+
+Get the log of the specific replication task
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ReplicationApi.new
+
+id = 789 # Integer | The ID of the execution that the tasks belongs to.
+
+task_id = 789 # Integer | The ID of the task.
+
+
+begin
+  #Get the log of the specific replication task
+  result = api_instance.get_replication_log(id, task_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReplicationApi->get_replication_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| The ID of the execution that the tasks belongs to. | 
+ **task_id** | **Integer**| The ID of the task. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_replication_executions**
+> Array<ReplicationExecution> list_replication_executions(opts)
+
+List replication executions
+
+List replication executions
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ReplicationApi.new
+
+opts = { 
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  policy_id: 56, # Integer | The ID of the policy that the executions belong to.
+  status: 'status_example', # String | The execution status.
+  trigger: 'trigger_example' # String | The trigger mode.
+}
+
+begin
+  #List replication executions
+  result = api_instance.list_replication_executions(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReplicationApi->list_replication_executions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **policy_id** | **Integer**| The ID of the policy that the executions belong to. | [optional] 
+ **status** | **String**| The execution status. | [optional] 
+ **trigger** | **String**| The trigger mode. | [optional] 
+
+### Return type
+
+[**Array<ReplicationExecution>**](ReplicationExecution.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_replication_tasks**
+> Array<ReplicationTask> list_replication_tasks(id, opts)
+
+List replication tasks for a specific execution
+
+List replication tasks for a specific execution
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ReplicationApi.new
+
+id = 789 # Integer | The ID of the execution that the tasks belongs to.
+
+opts = { 
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  status: 'status_example', # String | The task status.
+  resource_type: 'resource_type_example' # String | The resource type.
+}
+
+begin
+  #List replication tasks for a specific execution
+  result = api_instance.list_replication_tasks(id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReplicationApi->list_replication_tasks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| The ID of the execution that the tasks belongs to. | 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **status** | **String**| The task status. | [optional] 
+ **resource_type** | **String**| The resource type. | [optional] 
+
+### Return type
+
+[**Array<ReplicationTask>**](ReplicationTask.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **start_replication**
+> start_replication(execution)
+
+Start one replication execution
+
+Start one replication execution according to the policy
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ReplicationApi.new
+
+execution = SwaggerClient::StartReplicationExecution.new # StartReplicationExecution | The ID of policy that the execution belongs to
+
+
+begin
+  #Start one replication execution
+  api_instance.start_replication(execution)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReplicationApi->start_replication: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **execution** | [**StartReplicationExecution**](StartReplicationExecution.md)| The ID of policy that the execution belongs to | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **stop_replication**
+> stop_replication(id)
+
+Stop the specific replication execution
+
+Stop the replication execution specified by ID
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ReplicationApi.new
+
+id = 789 # Integer | The ID of the execution.
+
+
+begin
+  #Stop the specific replication execution
+  api_instance.stop_replication(id)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ReplicationApi->stop_replication: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| The ID of the execution. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ReplicationExecution.md

@@ -3,17 +3,17 @@
 ## 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] 
+**id** | **Integer** | The ID of the execution | [optional] 
+**policy_id** | **Integer** | The ID if the policy that the execution belongs to | [optional] 
+**status** | **String** | The status of the execution | [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] 
+**start_time** | **DateTime** | The start time | [optional] 
+**end_time** | **DateTime** | The end time | [optional] 
+**status_text** | **String** | The status text | [optional] 
+**total** | **Integer** | The total count of all executions | [optional] 
+**failed** | **Integer** | The count of failed executions | [optional] 
+**succeed** | **Integer** | The count of succeed executions | [optional] 
+**in_progress** | **Integer** | The count of in_progress executions | [optional] 
+**stopped** | **Integer** | The count of stopped executions | [optional]