harbor2_client 0.1.0 → 2.3.3.3

data/docs/ScannerApi.md

@@ -0,0 +1,479 @@
+# Harbor2Client::ScannerApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_scanner**](ScannerApi.md#create_scanner) | **POST** /scanners | Create a scanner registration
+[**delete_scanner**](ScannerApi.md#delete_scanner) | **DELETE** /scanners/{registration_id} | Delete a scanner registration
+[**get_scanner**](ScannerApi.md#get_scanner) | **GET** /scanners/{registration_id} | Get a scanner registration details
+[**get_scanner_metadata**](ScannerApi.md#get_scanner_metadata) | **GET** /scanners/{registration_id}/metadata | Get the metadata of the specified scanner registration
+[**list_scanners**](ScannerApi.md#list_scanners) | **GET** /scanners | List scanner registrations
+[**ping_scanner**](ScannerApi.md#ping_scanner) | **POST** /scanners/ping | Tests scanner registration settings
+[**set_scanner_as_default**](ScannerApi.md#set_scanner_as_default) | **PATCH** /scanners/{registration_id} | Set system default scanner registration
+[**update_scanner**](ScannerApi.md#update_scanner) | **PUT** /scanners/{registration_id} | Update a scanner registration
+
+
+# **create_scanner**
+> create_scanner(registration, opts)
+
+Create a scanner registration
+
+Creats a new scanner registration with the given data. 
+
+### 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::ScannerApi.new
+
+registration = Harbor2Client::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registration to be created.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create a scanner registration
+  api_instance.create_scanner(registration, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->create_scanner: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration** | [**ScannerRegistrationReq**](ScannerRegistrationReq.md)| A scanner registration to be created. | 
+ **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_scanner**
+> ScannerRegistration delete_scanner(registration_id, opts)
+
+Delete a scanner registration
+
+Deletes the specified scanner registration. 
+
+### 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::ScannerApi.new
+
+registration_id = 'registration_id_example' # String | The scanner registration identifier.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete a scanner registration
+  result = api_instance.delete_scanner(registration_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->delete_scanner: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration_id** | **String**| The scanner registration identifier. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**ScannerRegistration**](ScannerRegistration.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_scanner**
+> ScannerRegistration get_scanner(registration_id, opts)
+
+Get a scanner registration details
+
+Retruns the details of the specified scanner registration. 
+
+### 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::ScannerApi.new
+
+registration_id = 'registration_id_example' # String | The scanner registration identifer.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get a scanner registration details
+  result = api_instance.get_scanner(registration_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->get_scanner: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration_id** | **String**| The scanner registration identifer. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**ScannerRegistration**](ScannerRegistration.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_scanner_metadata**
+> ScannerAdapterMetadata get_scanner_metadata(registration_id, opts)
+
+Get the metadata of the specified scanner registration
+
+Get the metadata of the specified scanner registration, including the capabilities and customized properties. 
+
+### 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::ScannerApi.new
+
+registration_id = 'registration_id_example' # String | The scanner registration identifier.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the metadata of the specified scanner registration
+  result = api_instance.get_scanner_metadata(registration_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->get_scanner_metadata: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration_id** | **String**| The scanner registration identifier. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**ScannerAdapterMetadata**](ScannerAdapterMetadata.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_scanners**
+> Array<ScannerRegistration> list_scanners(opts)
+
+List scanner registrations
+
+Returns a list of currently configured scanner registrations. 
+
+### 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::ScannerApi.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]
+  sort: 'sort_example', # String | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+}
+
+begin
+  #List scanner registrations
+  result = api_instance.list_scanners(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->list_scanners: #{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] 
+ **sort** | **String**| Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\" | [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<ScannerRegistration>**](ScannerRegistration.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **ping_scanner**
+> ping_scanner(settings, opts)
+
+Tests scanner registration settings
+
+Pings scanner adapter to test endpoint URL and authorization settings. 
+
+### 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::ScannerApi.new
+
+settings = Harbor2Client::ScannerRegistrationSettings.new # ScannerRegistrationSettings | A scanner registration settings to be tested.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Tests scanner registration settings
+  api_instance.ping_scanner(settings, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->ping_scanner: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **settings** | [**ScannerRegistrationSettings**](ScannerRegistrationSettings.md)| A scanner registration settings to be tested. | 
+ **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
+
+
+
+# **set_scanner_as_default**
+> set_scanner_as_default(registration_id, payload, opts)
+
+Set system default scanner registration
+
+Set the specified scanner registration as the system default one. 
+
+### 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::ScannerApi.new
+
+registration_id = 'registration_id_example' # String | The scanner registration identifier.
+
+payload = Harbor2Client::IsDefault.new # IsDefault | 
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Set system default scanner registration
+  api_instance.set_scanner_as_default(registration_id, payload, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->set_scanner_as_default: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration_id** | **String**| The scanner registration identifier. | 
+ **payload** | [**IsDefault**](IsDefault.md)|  | 
+ **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_scanner**
+> update_scanner(registration_id, registration, opts)
+
+Update a scanner registration
+
+Updates the specified scanner registration. 
+
+### 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::ScannerApi.new
+
+registration_id = 'registration_id_example' # String | The scanner registration identifier.
+
+registration = Harbor2Client::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registraiton to be updated.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update a scanner registration
+  api_instance.update_scanner(registration_id, registration, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScannerApi->update_scanner: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration_id** | **String**| The scanner registration identifier. | 
+ **registration** | [**ScannerRegistrationReq**](ScannerRegistrationReq.md)| A scanner registraiton to be updated. | 
+ **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
+
+
+

data/docs/ScannerCapability.md

@@ -0,0 +1,9 @@
+# Harbor2Client::ScannerCapability
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consumes_mime_types** | **Array<String>** |  | [optional] 
+**produces_mime_types** | **Array<String>** |  | [optional] 
+
+

data/docs/ScannerRegistration.md

@@ -0,0 +1,23 @@
+# Harbor2Client::ScannerRegistration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | The unique identifier of this registration. | [optional] 
+**name** | **String** | The name of this registration. | [optional] 
+**description** | **String** | An optional description of this registration. | [optional] 
+**url** | **String** | A base URL of the scanner adapter | [optional] 
+**disabled** | **BOOLEAN** | Indicate whether the registration is enabled or not | [optional] [default to false]
+**is_default** | **BOOLEAN** | Indicate if the registration is set as the system default one | [optional] [default to false]
+**auth** | **String** | Specify what authentication approach is adopted for the HTTP communications. Supported types Basic\", \"Bearer\" and api key header \"X-ScannerAdapter-API-Key\"  | [optional] [default to '']
+**access_credential** | **String** | An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.  | [optional] 
+**skip_cert_verify** | **BOOLEAN** | Indicate if skip the certificate verification when sending HTTP requests | [optional] [default to false]
+**use_internal_addr** | **BOOLEAN** | Indicate whether use internal registry addr for the scanner to pull content or not | [optional] [default to false]
+**create_time** | **DateTime** | The creation time of this registration | [optional] 
+**update_time** | **DateTime** | The update time of this registration | [optional] 
+**adapter** | **String** | Optional property to describe the name of the scanner registration | [optional] 
+**vendor** | **String** | Optional property to describe the vendor of the scanner registration | [optional] 
+**version** | **String** | Optional property to describe the version of the scanner registration | [optional] 
+**health** | **String** | Indicate the healthy of the registration | [optional] [default to '']
+
+

data/docs/ScannerRegistrationReq.md

@@ -0,0 +1,15 @@
+# Harbor2Client::ScannerRegistrationReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this registration | 
+**description** | **String** | An optional description of this registration. | [optional] 
+**url** | **String** | A base URL of the scanner adapter. | 
+**auth** | **String** | Specify what authentication approach is adopted for the HTTP communications. Supported types Basic\", \"Bearer\" and api key header \"X-ScannerAdapter-API-Key\"  | [optional] 
+**access_credential** | **String** | An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.  | [optional] 
+**skip_cert_verify** | **BOOLEAN** | Indicate if skip the certificate verification when sending HTTP requests | [optional] [default to false]
+**use_internal_addr** | **BOOLEAN** | Indicate whether use internal registry addr for the scanner to pull content or not | [optional] [default to false]
+**disabled** | **BOOLEAN** | Indicate whether the registration is enabled or not | [optional] [default to false]
+
+

data/docs/ScannerRegistrationSettings.md

@@ -0,0 +1,11 @@
+# Harbor2Client::ScannerRegistrationSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this registration | 
+**url** | **String** | A base URL of the scanner adapter. | 
+**auth** | **String** | Specify what authentication approach is adopted for the HTTP communications. Supported types Basic\", \"Bearer\" and api key header \"X-ScannerAdapter-API-Key\"  | [optional] [default to '']
+**access_credential** | **String** | An optional value of the HTTP Authorization header sent with each request to the Scanner Adapter API.  | [optional] 
+
+

data/docs/Schedule.md

@@ -0,0 +1,13 @@
+# Harbor2Client::Schedule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The id of the schedule. | [optional] 
+**status** | **String** | The status of the schedule. | [optional] 
+**creation_time** | **DateTime** | the creation time of the schedule. | [optional] 
+**update_time** | **DateTime** | the update time of the schedule. | [optional] 
+**schedule** | [**ScheduleObj**](ScheduleObj.md) |  | [optional] 
+**parameters** | **Hash<String, Object>** | The parameters of schedule job | [optional] 
+
+

data/docs/ScheduleObj.md

@@ -0,0 +1,9 @@
+# Harbor2Client::ScheduleObj
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The schedule type. The valid values are 'Hourly', 'Daily', 'Weekly', 'Custom', 'Manual' and 'None'. 'Manual' means to trigger it right away and 'None' means to cancel the schedule.  | [optional] 
+**cron** | **String** | A cron expression, a time-based job scheduler. | [optional] 
+
+

data/docs/Search.md

@@ -0,0 +1,10 @@
+# Harbor2Client::Search
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project** | [**Array<Project>**](Project.md) | Search results of the projects that matched the filter keywords. | [optional] 
+**repository** | [**Array<SearchRepository>**](SearchRepository.md) | Search results of the repositories that matched the filter keywords. | [optional] 
+**chart** | [**Array<SearchResult>**](SearchResult.md) | Search results of the charts that macthed the filter keywords. | [optional] 
+
+

data/docs/SearchApi.md

@@ -0,0 +1,66 @@
+# Harbor2Client::SearchApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](SearchApi.md#search) | **GET** /search | Search for projects, repositories and helm charts
+
+
+# **search**
+> Search search(q, opts)
+
+Search for projects, repositories and helm charts
+
+The Search endpoint returns information about the projects, repositories and helm charts offered at public status or related to the current logged in user. The response includes the project, repository list and charts in a proper display order.
+
+### 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::SearchApi.new
+
+q = 'q_example' # String | Search parameter for project and repository name.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Search for projects, repositories and helm charts
+  result = api_instance.search(q, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling SearchApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q** | **String**| Search parameter for project and repository name. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Search**](Search.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SearchRepository.md

@@ -0,0 +1,13 @@
+# Harbor2Client::SearchRepository
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_id** | **Integer** | The ID of the project that the repository belongs to | [optional] 
+**project_name** | **String** | The name of the project that the repository belongs to | [optional] 
+**project_public** | **BOOLEAN** | The flag to indicate the publicity of the project that the repository belongs to (1 is public, 0 is not) | [optional] 
+**repository_name** | **String** | The name of the repository | [optional] 
+**pull_count** | **Integer** | The count how many times the repository is pulled | [optional] 
+**artifact_count** | **Integer** | The count of artifacts in the repository | [optional] 
+
+

data/docs/SearchResult.md

@@ -0,0 +1,10 @@
+# Harbor2Client::SearchResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The chart name with repo name | [optional] 
+**score** | **Integer** | The matched level | [optional] 
+**chart** | [**ChartVersion**](ChartVersion.md) |  | [optional] 
+
+

data/docs/StartReplicationExecution.md

@@ -0,0 +1,8 @@
+# Harbor2Client::StartReplicationExecution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**policy_id** | **Integer** | The ID of policy that the execution belongs to. | [optional] 
+
+