harbor2_client 0.1.0 → 2.3.3.3

data/docs/Statistic.md

@@ -0,0 +1,14 @@
+# Harbor2Client::Statistic
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**private_project_count** | **Integer** | The count of the private projects | [optional] 
+**private_repo_count** | **Integer** | The count of the private repositories | [optional] 
+**public_project_count** | **Integer** | The count of the public projects | [optional] 
+**public_repo_count** | **Integer** | The count of the public repositories | [optional] 
+**total_project_count** | **Integer** | The count of the total projects, only be seen by the system admin | [optional] 
+**total_repo_count** | **Integer** | The count of the total repositories, only be seen by the system admin | [optional] 
+**total_storage_consumption** | **Integer** | The total storage consumption of blobs, only be seen by the system admin | [optional] 
+
+

data/docs/StatisticApi.md

@@ -0,0 +1,63 @@
+# Harbor2Client::StatisticApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_statistic**](StatisticApi.md#get_statistic) | **GET** /statistics | Get the statistic information about the projects and repositories
+
+
+# **get_statistic**
+> Statistic get_statistic(opts)
+
+Get the statistic information about the projects and repositories
+
+Get the statistic information about the projects and repositories
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::StatisticApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the statistic information about the projects and repositories
+  result = api_instance.get_statistic(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling StatisticApi->get_statistic: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Statistic**](Statistic.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Stats.md

@@ -0,0 +1,12 @@
+# Harbor2Client::Stats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | The total number of scan processes triggered by the scan all action | [optional] 
+**completed** | **Integer** | The number of the finished scan processes triggered by the scan all action | [optional] 
+**metrics** | **Hash<String, Integer>** | The metrics data for the each status | [optional] 
+**ongoing** | **BOOLEAN** | A flag indicating job status of scan all. | [optional] 
+**trigger** | **String** | The trigger of the scan all job. | [optional] 
+
+

data/docs/Storage.md

@@ -0,0 +1,9 @@
+# Harbor2Client::Storage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Total volume size. | [optional] 
+**free** | **Integer** | Free volume size. | [optional] 
+
+

data/docs/StringConfigItem.md

@@ -0,0 +1,9 @@
+# Harbor2Client::StringConfigItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The string value of current config item | [optional] 
+**editable** | **BOOLEAN** | The configure item can be updated or not | [optional] 
+
+

data/docs/SupportedWebhookEventTypes.md

@@ -0,0 +1,9 @@
+# Harbor2Client::SupportedWebhookEventTypes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_type** | [**Array<EventType>**](EventType.md) |  | [optional] 
+**notify_type** | [**Array<NotifyType>**](NotifyType.md) |  | [optional] 
+
+

data/docs/SystemCVEAllowlistApi.md

@@ -0,0 +1,119 @@
+# Harbor2Client::SystemCVEAllowlistApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_system_cve_allowlist**](SystemCVEAllowlistApi.md#get_system_cve_allowlist) | **GET** /system/CVEAllowlist | Get the system level allowlist of CVE.
+[**put_system_cve_allowlist**](SystemCVEAllowlistApi.md#put_system_cve_allowlist) | **PUT** /system/CVEAllowlist | Update the system level allowlist of CVE.
+
+
+# **get_system_cve_allowlist**
+> CVEAllowlist get_system_cve_allowlist(opts)
+
+Get the system level allowlist of CVE.
+
+Get the system level allowlist of CVE.  This API can be called by all authenticated users.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::SystemCVEAllowlistApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the system level allowlist of CVE.
+  result = api_instance.get_system_cve_allowlist(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling SystemCVEAllowlistApi->get_system_cve_allowlist: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**CVEAllowlist**](CVEAllowlist.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_system_cve_allowlist**
+> put_system_cve_allowlist(opts)
+
+Update the system level allowlist of CVE.
+
+This API overwrites the system level allowlist of CVE with the list in request body.  Only system Admin has permission to call this API.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::SystemCVEAllowlistApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  allowlist: Harbor2Client::CVEAllowlist.new # CVEAllowlist | The allowlist with new content
+}
+
+begin
+  #Update the system level allowlist of CVE.
+  api_instance.put_system_cve_allowlist(opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling SystemCVEAllowlistApi->put_system_cve_allowlist: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **allowlist** | [**CVEAllowlist**](CVEAllowlist.md)| The allowlist with new content | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SystemInfo.md

@@ -0,0 +1,8 @@
+# Harbor2Client::SystemInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage** | [**Array<Storage>**](Storage.md) | The storage of system. | [optional] 
+
+

data/docs/SysteminfoApi.md

@@ -0,0 +1,173 @@
+# Harbor2Client::SysteminfoApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_cert**](SysteminfoApi.md#get_cert) | **GET** /systeminfo/getcert | Get default root certificate.
+[**get_system_info**](SysteminfoApi.md#get_system_info) | **GET** /systeminfo | Get general system info
+[**get_volumes**](SysteminfoApi.md#get_volumes) | **GET** /systeminfo/volumes | Get system volume info (total/free size).
+
+
+# **get_cert**
+> File get_cert(opts)
+
+Get default root certificate.
+
+This endpoint is for downloading a default root certificate. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::SysteminfoApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get default root certificate.
+  result = api_instance.get_cert(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling SysteminfoApi->get_cert: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/octet-stream
+
+
+
+# **get_system_info**
+> GeneralInfo get_system_info(opts)
+
+Get general system info
+
+This API is for retrieving general system info, this can be called by anonymous request.  Some attributes will be omitted in the response when this API is called by anonymous request. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::SysteminfoApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get general system info
+  result = api_instance.get_system_info(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling SysteminfoApi->get_system_info: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**GeneralInfo**](GeneralInfo.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_volumes**
+> SystemInfo get_volumes(opts)
+
+Get system volume info (total/free size).
+
+This endpoint is for retrieving system volume info that only provides for admin user.  Note that the response only reflects the storage status of local disk. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::SysteminfoApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get system volume info (total/free size).
+  result = api_instance.get_volumes(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling SysteminfoApi->get_volumes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**SystemInfo**](SystemInfo.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+