harbor_swagger_client 1.0.4 → 2.0.0

data/docs/AuditLog.md

@@ -0,0 +1,13 @@
+# SwaggerClient::AuditLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the audit log entry. | [optional] 
+**username** | **String** | Username of the user in this log entry. | [optional] 
+**resource** | **String** | Name of the repository in this log entry. | [optional] 
+**resource_type** | **String** | Tag of the repository in this log entry. | [optional] 
+**operation** | **String** | The operation against the repository in this log entry. | [optional] 
+**op_time** | **DateTime** | The time when this operation is triggered. | [optional] 
+
+

data/docs/AuditlogApi.md

@@ -0,0 +1,69 @@
+# SwaggerClient::AuditlogApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_audit_logs**](AuditlogApi.md#list_audit_logs) | **GET** /audit-logs | Get recent logs of the projects which the user is a member of
+
+
+# **list_audit_logs**
+> Array<AuditLog> list_audit_logs(opts)
+
+Get recent logs of the projects which the user is a member of
+
+This endpoint let user see the recent operation logs of the projects which he is member of 
+
+### 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::AuditlogApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  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]
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+}
+
+begin
+  #Get recent logs of the projects which the user is a member of
+  result = api_instance.list_audit_logs(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AuditlogApi->list_audit_logs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **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] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+
+### Return type
+
+[**Array<AuditLog>**](AuditLog.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AuthproxySetting.md

@@ -0,0 +1,12 @@
+# SwaggerClient::AuthproxySetting
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**endpoint** | **String** | The fully qualified URI of login endpoint of authproxy, such as 'https://192.168.1.2:8443/login' | [optional] 
+**tokenreivew_endpoint** | **String** | The fully qualified URI of token review endpoint of authproxy, such as 'https://192.168.1.2:8443/tokenreview' | [optional] 
+**skip_search** | **BOOLEAN** | The flag to determine whether Harbor can skip search the user/group when adding him as a member. | [optional] 
+**verify_cert** | **BOOLEAN** | The flag to determine whether Harbor should verify the certificate when connecting to the auth proxy. | [optional] 
+**server_certificate** | **String** | The certificate to be pinned when connecting auth proxy. | [optional] 
+
+

data/docs/CVEAllowlist.md

@@ -0,0 +1,13 @@
+# SwaggerClient::CVEAllowlist
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the allowlist | [optional] 
+**project_id** | **Integer** | ID of the project which the allowlist belongs to.  For system level allowlist this attribute is zero. | [optional] 
+**expires_at** | **Integer** | the time for expiration of the allowlist, in the form of seconds since epoch.  This is an optional attribute, if it's not set the CVE allowlist does not expire. | [optional] 
+**items** | [**Array<CVEAllowlistItem>**](CVEAllowlistItem.md) |  | [optional] 
+**creation_time** | **DateTime** | The creation time of the allowlist. | [optional] 
+**update_time** | **DateTime** | The update time of the allowlist. | [optional] 
+
+

data/docs/{CVEWhitelistItem.md → CVEAllowlistItem.md}

@@ -1,4 +1,4 @@
-# SwaggerClient::CVEWhitelistItem
+# SwaggerClient::CVEAllowlistItem
 
 ## Properties
 Name | Type | Description | Notes

data/docs/Error.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The error code | [optional] 
+**message** | **String** | The error message | [optional] 
+
+

data/docs/{Action.md → Errors.md}

@@ -1,8 +1,8 @@
-# SwaggerClient::Action
+# SwaggerClient::Errors
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**dry_run** | **BOOLEAN** |  | [optional] 
+**errors** | [**Array<Error>**](Error.md) |  | [optional] 
 
 

data/docs/Execution.md

@@ -0,0 +1,17 @@
+# SwaggerClient::Execution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of execution | [optional] 
+**vendor_type** | **String** | The vendor type of execution | [optional] 
+**vendor_id** | **Integer** | The vendor id of execution | [optional] 
+**status** | **String** | The status of execution | [optional] 
+**status_message** | **String** | The status message of execution | [optional] 
+**metrics** | [**Metrics**](Metrics.md) |  | [optional] 
+**trigger** | **String** | The trigger of execution | [optional] 
+**extra_attrs** | [**ExtraAttrs**](ExtraAttrs.md) |  | [optional] 
+**start_time** | **String** | The start time of execution | [optional] 
+**end_time** | **String** | The end time of execution | [optional] 
+
+

data/docs/{NotifyType.md → ExtraAttrs.md}

@@ -1,4 +1,4 @@
-# SwaggerClient::NotifyType
+# SwaggerClient::ExtraAttrs
 
 ## Properties
 Name | Type | Description | Notes

data/docs/GeneralInfo.md

@@ -12,5 +12,9 @@ Name | Type | Description | Notes
 **self_registration** | **BOOLEAN** | Indicate whether the Harbor instance enable user to register himself. | [optional] 
 **has_ca_root** | **BOOLEAN** | Indicate whether there is a ca root cert file ready for download in the file system. | [optional] 
 **harbor_version** | **String** | The build version of Harbor. | [optional] 
+**registry_storage_provider_name** | **String** | The storage provider's name of Harbor registry | [optional] 
+**read_only** | **BOOLEAN** | The flag to indicate whether Harbor is in readonly mode. | [optional] 
+**notification_enable** | **BOOLEAN** | The flag to indicate whether notification mechanism is enabled on Harbor instance. | [optional] 
+**authproxy_settings** | [**AuthproxySetting**](AuthproxySetting.md) | The setting of auth proxy this is only available when Harbor relies on authproxy for authentication. | [optional] 
 
 

data/docs/Icon.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Icon
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_type** | **String** | The content type of the icon | [optional] 
+**content** | **String** | The base64 encoded content of the icon | [optional] 
+
+

data/docs/IconApi.md

@@ -0,0 +1,66 @@
+# SwaggerClient::IconApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_icon**](IconApi.md#get_icon) | **GET** /icons/{digest} | Get artifact icon
+
+
+# **get_icon**
+> Icon get_icon(digest, opts)
+
+Get artifact icon
+
+Get the artifact icon with the specified digest. As the original icon image is resized and encoded before returning, the parameter \"digest\" in the path doesn't match the hash of the returned content
+
+### 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::IconApi.new
+
+digest = 'digest_example' # String | The digest of the resource
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get artifact icon
+  result = api_instance.get_icon(digest, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling IconApi->get_icon: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **digest** | **String**| The digest of the resource | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Icon**](Icon.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Instance.md

@@ -0,0 +1,19 @@
+# SwaggerClient::Instance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID | [optional] 
+**name** | **String** | Instance name | [optional] 
+**description** | **String** | Description of instance | [optional] 
+**vendor** | **String** | Based on which driver, identified by ID | [optional] 
+**endpoint** | **String** | The service endpoint of this instance | [optional] 
+**auth_mode** | **String** | The authentication way supported | [optional] 
+**auth_info** | **Hash<String, String>** | The auth credential data if exists | [optional] 
+**status** | **String** | The health status | [optional] 
+**enabled** | **BOOLEAN** | Whether the instance is activated or not | [optional] 
+**default** | **BOOLEAN** | Whether the instance is default or not | [optional] 
+**insecure** | **BOOLEAN** | Whether the instance endpoint is insecure or not | [optional] 
+**setup_timestamp** | **Integer** | The timestamp of instance setting up | [optional] 
+
+

data/docs/Label.md

@@ -3,14 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | The ID of label. | [optional] 
-**name** | **String** | The name of label. | [optional] 
-**description** | **String** | The description of label. | [optional] 
-**color** | **String** | The color of label. | [optional] 
-**scope** | **String** | The scope of label, g for global labels and p for project labels. | [optional] 
-**project_id** | **Integer** | The project ID if the label is a project label. | [optional] 
-**creation_time** | **String** | The creation time of label. | [optional] 
-**update_time** | **String** | The update time of label. | [optional] 
-**deleted** | **BOOLEAN** | The label is deleted or not. | [optional] 
+**id** | **Integer** | The ID of the label | [optional] 
+**name** | **String** | The name the label | [optional] 
+**description** | **String** | The description the label | [optional] 
+**color** | **String** | The color the label | [optional] 
+**scope** | **String** | The scope the label | [optional] 
+**project_id** | **Integer** | The ID of project that the label belongs to | [optional] 
+**creation_time** | **DateTime** | The creation time the label | [optional] 
+**update_time** | **DateTime** | The update time of the label | [optional] 
 
 

data/docs/Metadata.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Metadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | id | [optional] 
+**name** | **String** | name | [optional] 
+**icon** | **String** | icon | [optional] 
+**maintainers** | **Array<String>** | maintainers | [optional] 
+**version** | **String** | version | [optional] 
+**source** | **String** | source | [optional] 
+
+

data/docs/Metrics.md

@@ -0,0 +1,14 @@
+# SwaggerClient::Metrics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_count** | **Integer** | The count of task | [optional] 
+**success_task_count** | **Integer** | The count of success task | [optional] 
+**error_task_count** | **Integer** | The count of error task | [optional] 
+**pending_task_count** | **Integer** | The count of pending task | [optional] 
+**running_task_count** | **Integer** | The count of running task | [optional] 
+**scheduled_task_count** | **Integer** | The count of scheduled task | [optional] 
+**stopped_task_count** | **Integer** | The count of stopped task | [optional] 
+
+

data/docs/NativeReportSummary.md

@@ -0,0 +1,15 @@
+# SwaggerClient::NativeReportSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report_id** | **String** | id of the native scan report | [optional] 
+**scan_status** | **String** | The status of the report generating process | [optional] 
+**severity** | **String** | The overall severity | [optional] 
+**duration** | **Integer** | The seconds spent for generating the report | [optional] 
+**summary** | [**VulnerabilitySummary**](VulnerabilitySummary.md) |  | [optional] 
+**start_time** | **DateTime** | The start time of the scan process that generating report | [optional] 
+**end_time** | **DateTime** | The end time of the scan process that generating report | [optional] 
+**complete_percent** | **Integer** | The complete percent of the scanning which value is between 0 and 100 | [optional] 
+
+

data/docs/Permission.md

@@ -3,7 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**resource** | **String** | The permission resoruce | [optional] 
-**action** | **String** | The permission action | [optional] 
+**kind** | **String** | The kind of the permission | [optional] 
+**namespace** | **String** | The namespace of the permission | [optional] 
+**access** | [**Array<Access>**](Access.md) |  | [optional] 
 
 

data/docs/PingApi.md

@@ -0,0 +1,56 @@
+# SwaggerClient::PingApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ping_get**](PingApi.md#ping_get) | **GET** /ping | Ping Harbor to check if it's alive.
+
+
+# **ping_get**
+> String ping_get
+
+Ping Harbor to check if it's alive.
+
+This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.
+
+### 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::PingApi.new
+
+begin
+  #Ping Harbor to check if it's alive.
+  result = api_instance.ping_get
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PingApi->ping_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+

data/docs/Platform.md

@@ -0,0 +1,12 @@
+# SwaggerClient::Platform
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**architecture** | **String** | The architecture that the artifact applys to | [optional] 
+**os** | **String** | The OS that the artifact applys to | [optional] 
+**os_version** | **String** | The version of the OS that the artifact applys to | [optional] 
+**os_features** | **Array<String>** | The features of the OS that the artifact applys to | [optional] 
+**variant** | **String** | The variant of the CPU | [optional] 
+
+

data/docs/PreheatApi.md

@@ -0,0 +1,1176 @@
+# SwaggerClient::PreheatApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_instance**](PreheatApi.md#create_instance) | **POST** /p2p/preheat/instances | Create p2p provider instances
+[**create_policy**](PreheatApi.md#create_policy) | **POST** /projects/{project_name}/preheat/policies | Create a preheat policy under a project
+[**delete_instance**](PreheatApi.md#delete_instance) | **DELETE** /p2p/preheat/instances/{preheat_instance_name} | Delete the specified P2P provider instance
+[**delete_policy**](PreheatApi.md#delete_policy) | **DELETE** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Delete a preheat policy
+[**get_execution**](PreheatApi.md#get_execution) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id} | Get a execution detail by id
+[**get_instance**](PreheatApi.md#get_instance) | **GET** /p2p/preheat/instances/{preheat_instance_name} | Get a P2P provider instance
+[**get_policy**](PreheatApi.md#get_policy) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Get a preheat policy
+[**get_preheat_log**](PreheatApi.md#get_preheat_log) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks/{task_id}/logs | Get the log text stream of the specified task for the given execution
+[**list_executions**](PreheatApi.md#list_executions) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions | List executions for the given policy
+[**list_instances**](PreheatApi.md#list_instances) | **GET** /p2p/preheat/instances | List P2P provider instances
+[**list_policies**](PreheatApi.md#list_policies) | **GET** /projects/{project_name}/preheat/policies | List preheat policies
+[**list_providers**](PreheatApi.md#list_providers) | **GET** /p2p/preheat/providers | List P2P providers
+[**list_providers_under_project**](PreheatApi.md#list_providers_under_project) | **GET** /projects/{project_name}/preheat/providers | Get all providers at project level
+[**list_tasks**](PreheatApi.md#list_tasks) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks | List all the related tasks for the given execution
+[**manual_preheat**](PreheatApi.md#manual_preheat) | **POST** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Manual preheat
+[**ping_instances**](PreheatApi.md#ping_instances) | **POST** /p2p/preheat/instances/ping | Ping status of a instance.
+[**stop_execution**](PreheatApi.md#stop_execution) | **PATCH** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id} | Stop a execution
+[**update_instance**](PreheatApi.md#update_instance) | **PUT** /p2p/preheat/instances/{preheat_instance_name} | Update the specified P2P provider instance
+[**update_policy**](PreheatApi.md#update_policy) | **PUT** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Update preheat policy
+
+
+# **create_instance**
+> create_instance(instance, opts)
+
+Create p2p provider instances
+
+Create p2p provider instances
+
+### 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::PreheatApi.new
+
+instance = SwaggerClient::Instance.new # Instance | The JSON object of instance.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create p2p provider instances
+  api_instance.create_instance(instance, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->create_instance: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **instance** | [**Instance**](Instance.md)| The JSON object of instance. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_policy**
+> create_policy(project_namepolicy, opts)
+
+Create a preheat policy under a project
+
+Create a preheat policy under a project
+
+### 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+policy = SwaggerClient::PreheatPolicy.new # PreheatPolicy | The policy schema info
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create a preheat policy under a project
+  api_instance.create_policy(project_namepolicy, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->create_policy: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **policy** | [**PreheatPolicy**](PreheatPolicy.md)| The policy schema info | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_instance**
+> delete_instance(preheat_instance_name, opts)
+
+Delete the specified P2P provider instance
+
+Delete the specified P2P provider instance
+
+### 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::PreheatApi.new
+
+preheat_instance_name = 'preheat_instance_name_example' # String | Instance Name
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete the specified P2P provider instance
+  api_instance.delete_instance(preheat_instance_name, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->delete_instance: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **preheat_instance_name** | **String**| Instance Name | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_policy**
+> delete_policy(project_namepreheat_policy_name, , opts)
+
+Delete a preheat policy
+
+Delete a preheat 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete a preheat policy
+  api_instance.delete_policy(project_namepreheat_policy_name, , opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->delete_policy: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_execution**
+> Execution get_execution(project_namepreheat_policy_name, execution_id, , opts)
+
+Get a execution detail by id
+
+Get a execution detail 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+execution_id = 56 # Integer | Execution ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get a execution detail by id
+  result = api_instance.get_execution(project_namepreheat_policy_name, execution_id, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->get_execution: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **execution_id** | **Integer**| Execution ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Execution**](Execution.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_instance**
+> Instance get_instance(preheat_instance_name, opts)
+
+Get a P2P provider instance
+
+Get a P2P provider instance
+
+### 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::PreheatApi.new
+
+preheat_instance_name = 'preheat_instance_name_example' # String | Instance Name
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get a P2P provider instance
+  result = api_instance.get_instance(preheat_instance_name, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->get_instance: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **preheat_instance_name** | **String**| Instance Name | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Instance**](Instance.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_policy**
+> PreheatPolicy get_policy(project_namepreheat_policy_name, , opts)
+
+Get a preheat policy
+
+Get a preheat 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get a preheat policy
+  result = api_instance.get_policy(project_namepreheat_policy_name, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->get_policy: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**PreheatPolicy**](PreheatPolicy.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_preheat_log**
+> String get_preheat_log(project_namepreheat_policy_name, execution_id, task_id, opts)
+
+Get the log text stream of the specified task for the given execution
+
+Get the log text stream of the specified task for the given 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+execution_id = 56 # Integer | Execution ID
+
+task_id = 56 # Integer | Task ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the log text stream of the specified task for the given execution
+  result = api_instance.get_preheat_log(project_namepreheat_policy_name, execution_id, task_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->get_preheat_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **execution_id** | **Integer**| Execution ID | 
+ **task_id** | **Integer**| Task ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+
+# **list_executions**
+> Array<Execution> list_executions(project_namepreheat_policy_name, , opts)
+
+List executions for the given policy
+
+List executions for the given 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  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]
+}
+
+begin
+  #List executions for the given policy
+  result = api_instance.list_executions(project_namepreheat_policy_name, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->list_executions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **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] 
+
+### Return type
+
+[**Array<Execution>**](Execution.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_instances**
+> Array<Instance> list_instances(opts)
+
+List P2P provider instances
+
+List P2P provider instances
+
+### 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::PreheatApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  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]
+}
+
+begin
+  #List P2P provider instances
+  result = api_instance.list_instances(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->list_instances: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **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] 
+
+### Return type
+
+[**Array<Instance>**](Instance.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_policies**
+> Array<PreheatPolicy> list_policies(project_name, opts)
+
+List preheat policies
+
+List preheat policies
+
+### 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  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]
+}
+
+begin
+  #List preheat policies
+  result = api_instance.list_policies(project_name, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->list_policies: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **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] 
+
+### Return type
+
+[**Array<PreheatPolicy>**](PreheatPolicy.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_providers**
+> Array<Metadata> list_providers(opts)
+
+List P2P providers
+
+List P2P providers
+
+### 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::PreheatApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #List P2P providers
+  result = api_instance.list_providers(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->list_providers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Array<Metadata>**](Metadata.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_providers_under_project**
+> Array<ProviderUnderProject> list_providers_under_project(project_name, opts)
+
+Get all providers at project level
+
+Get all providers at project level
+
+### 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get all providers at project level
+  result = api_instance.list_providers_under_project(project_name, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->list_providers_under_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Array<ProviderUnderProject>**](ProviderUnderProject.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_tasks**
+> Array<Task> list_tasks(project_namepreheat_policy_name, execution_id, , opts)
+
+List all the related tasks for the given execution
+
+List all the related tasks for the given 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+execution_id = 56 # Integer | Execution ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  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]
+}
+
+begin
+  #List all the related tasks for the given execution
+  result = api_instance.list_tasks(project_namepreheat_policy_name, execution_id, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->list_tasks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **execution_id** | **Integer**| Execution ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **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] 
+
+### Return type
+
+[**Array<Task>**](Task.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **manual_preheat**
+> manual_preheat(project_namepreheat_policy_name, policy, opts)
+
+Manual preheat
+
+Manual preheat
+
+### 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+policy = SwaggerClient::PreheatPolicy.new # PreheatPolicy | The policy schema info
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Manual preheat
+  api_instance.manual_preheat(project_namepreheat_policy_name, policy, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->manual_preheat: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **policy** | [**PreheatPolicy**](PreheatPolicy.md)| The policy schema info | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **ping_instances**
+> ping_instances(instance, opts)
+
+Ping status of a instance.
+
+This endpoint checks status of a instance, the instance can be given by ID or Endpoint URL (together with credential) 
+
+### 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::PreheatApi.new
+
+instance = SwaggerClient::Instance.new # Instance | The JSON object of instance.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Ping status of a instance.
+  api_instance.ping_instances(instance, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->ping_instances: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **instance** | [**Instance**](Instance.md)| The JSON object of instance. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **stop_execution**
+> stop_execution(project_namepreheat_policy_name, execution_id, execution, opts)
+
+Stop a execution
+
+Stop a 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+execution_id = 56 # Integer | Execution ID
+
+execution = SwaggerClient::Execution.new # Execution | The data of execution
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Stop a execution
+  api_instance.stop_execution(project_namepreheat_policy_name, execution_id, execution, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->stop_execution: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **execution_id** | **Integer**| Execution ID | 
+ **execution** | [**Execution**](Execution.md)| The data of execution | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_instance**
+> update_instance(preheat_instance_nameinstance, opts)
+
+Update the specified P2P provider instance
+
+Update the specified P2P provider instance
+
+### 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::PreheatApi.new
+
+preheat_instance_name = 'preheat_instance_name_example' # String | Instance Name
+
+instance = SwaggerClient::Instance.new # Instance | The instance to update
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update the specified P2P provider instance
+  api_instance.update_instance(preheat_instance_nameinstance, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->update_instance: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **preheat_instance_name** | **String**| Instance Name | 
+ **instance** | [**Instance**](Instance.md)| The instance to update | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_policy**
+> update_policy(project_namepreheat_policy_name, policy, opts)
+
+Update preheat policy
+
+Update preheat 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::PreheatApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+preheat_policy_name = 'preheat_policy_name_example' # String | Preheat Policy Name
+
+policy = SwaggerClient::PreheatPolicy.new # PreheatPolicy | The policy schema info
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update preheat policy
+  api_instance.update_policy(project_namepreheat_policy_name, policy, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PreheatApi->update_policy: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **preheat_policy_name** | **String**| Preheat Policy Name | 
+ **policy** | [**PreheatPolicy**](PreheatPolicy.md)| The policy schema info | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+