harbor2_legacy_client 0.2.1 → 2.3.3.0

data/docs/ScannersApi.md

@@ -1,600 +0,0 @@
-# Harbor2LegacyClient::ScannersApi
-
-All URIs are relative to *http://localhost/api/v2.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**projects_project_id_scanner_candidates_get**](ScannersApi.md#projects_project_id_scanner_candidates_get) | **GET** /projects/{project_id}/scanner/candidates | Get scanner registration candidates for configurating project level scanner
-[**projects_project_id_scanner_get**](ScannersApi.md#projects_project_id_scanner_get) | **GET** /projects/{project_id}/scanner | Get project level scanner
-[**projects_project_id_scanner_put**](ScannersApi.md#projects_project_id_scanner_put) | **PUT** /projects/{project_id}/scanner | Configure scanner for the specified project
-[**scanners_get**](ScannersApi.md#scanners_get) | **GET** /scanners | List scanner registrations
-[**scanners_ping_post**](ScannersApi.md#scanners_ping_post) | **POST** /scanners/ping | Tests scanner registration settings
-[**scanners_post**](ScannersApi.md#scanners_post) | **POST** /scanners | Create a scanner registration
-[**scanners_registration_id_delete**](ScannersApi.md#scanners_registration_id_delete) | **DELETE** /scanners/{registration_id} | Delete a scanner registration
-[**scanners_registration_id_get**](ScannersApi.md#scanners_registration_id_get) | **GET** /scanners/{registration_id} | Get a scanner registration details
-[**scanners_registration_id_metadata_get**](ScannersApi.md#scanners_registration_id_metadata_get) | **GET** /scanners/{registration_id}/metadata | Get the metadata of the specified scanner registration
-[**scanners_registration_id_patch**](ScannersApi.md#scanners_registration_id_patch) | **PATCH** /scanners/{registration_id} | Set system default scanner registration
-[**scanners_registration_id_put**](ScannersApi.md#scanners_registration_id_put) | **PUT** /scanners/{registration_id} | Update a scanner registration
-
-
-# **projects_project_id_scanner_candidates_get**
-> Array<ScannerRegistration> projects_project_id_scanner_candidates_get(project_id)
-
-Get scanner registration candidates for configurating project level scanner
-
-Retrieve the system configured scanner registrations as candidates of setting project level scanner. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-project_id = 789 # Integer | The project identifier.
-
-
-begin
-  #Get scanner registration candidates for configurating project level scanner
-  result = api_instance.projects_project_id_scanner_candidates_get(project_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->projects_project_id_scanner_candidates_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The project identifier. | 
-
-### Return type
-
-[**Array<ScannerRegistration>**](ScannerRegistration.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **projects_project_id_scanner_get**
-> ScannerRegistration projects_project_id_scanner_get(project_id)
-
-Get project level scanner
-
-Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-project_id = 789 # Integer | The project identifier.
-
-
-begin
-  #Get project level scanner
-  result = api_instance.projects_project_id_scanner_get(project_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->projects_project_id_scanner_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The project identifier. | 
-
-### Return type
-
-[**ScannerRegistration**](ScannerRegistration.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **projects_project_id_scanner_put**
-> projects_project_id_scanner_put(project_id, payload)
-
-Configure scanner for the specified project
-
-Set one of the system configured scanner registration as the indepndent scanner of the specified project.
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-project_id = 789 # Integer | The project identifier.
-
-payload = Harbor2LegacyClient::ProjectScanner.new # ProjectScanner | 
-
-
-begin
-  #Configure scanner for the specified project
-  api_instance.projects_project_id_scanner_put(project_id, payload)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->projects_project_id_scanner_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The project identifier. | 
- **payload** | [**ProjectScanner**](ProjectScanner.md)|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_get**
-> Array<ScannerRegistration> scanners_get
-
-List scanner registrations
-
-Returns a list of currently configured scanner registrations. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-begin
-  #List scanner registrations
-  result = api_instance.scanners_get
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Array<ScannerRegistration>**](ScannerRegistration.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_ping_post**
-> scanners_ping_post(settings)
-
-Tests scanner registration settings
-
-Pings scanner adapter to test endpoint URL and authorization settings. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-settings = Harbor2LegacyClient::ScannerRegistrationSettings.new # ScannerRegistrationSettings | A scanner registration settings to be tested.
-
-
-begin
-  #Tests scanner registration settings
-  api_instance.scanners_ping_post(settings)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_ping_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **settings** | [**ScannerRegistrationSettings**](ScannerRegistrationSettings.md)| A scanner registration settings to be tested. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_post**
-> scanners_post(registration)
-
-Create a scanner registration
-
-Creats a new scanner registration with the given data. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-registration = Harbor2LegacyClient::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registration to be created.
-
-
-begin
-  #Create a scanner registration
-  api_instance.scanners_post(registration)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registration** | [**ScannerRegistrationReq**](ScannerRegistrationReq.md)| A scanner registration to be created. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_registration_id_delete**
-> ScannerRegistration scanners_registration_id_delete(registration_id)
-
-Delete a scanner registration
-
-Deletes the specified scanner registration. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifier.
-
-
-begin
-  #Delete a scanner registration
-  result = api_instance.scanners_registration_id_delete(registration_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_registration_id_delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registration_id** | **String**| The scanner registration identifier. | 
-
-### Return type
-
-[**ScannerRegistration**](ScannerRegistration.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_registration_id_get**
-> ScannerRegistration scanners_registration_id_get(registration_id)
-
-Get a scanner registration details
-
-Retruns the details of the specified scanner registration. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifer.
-
-
-begin
-  #Get a scanner registration details
-  result = api_instance.scanners_registration_id_get(registration_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_registration_id_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registration_id** | **String**| The scanner registration identifer. | 
-
-### Return type
-
-[**ScannerRegistration**](ScannerRegistration.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_registration_id_metadata_get**
-> ScannerAdapterMetadata scanners_registration_id_metadata_get(registration_id)
-
-Get the metadata of the specified scanner registration
-
-Get the metadata of the specified scanner registration, including the capabilities and customzied properties. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifier.
-
-
-begin
-  #Get the metadata of the specified scanner registration
-  result = api_instance.scanners_registration_id_metadata_get(registration_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_registration_id_metadata_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registration_id** | **String**| The scanner registration identifier. | 
-
-### Return type
-
-[**ScannerAdapterMetadata**](ScannerAdapterMetadata.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_registration_id_patch**
-> scanners_registration_id_patch(registration_id, payload)
-
-Set system default scanner registration
-
-Set the specified scanner registration as the system default one. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifier.
-
-payload = Harbor2LegacyClient::IsDefault.new # IsDefault | 
-
-
-begin
-  #Set system default scanner registration
-  api_instance.scanners_registration_id_patch(registration_id, payload)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_registration_id_patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registration_id** | **String**| The scanner registration identifier. | 
- **payload** | [**IsDefault**](IsDefault.md)|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scanners_registration_id_put**
-> scanners_registration_id_put(registration_id, registration)
-
-Update a scanner registration
-
-Updates the specified scanner registration. 
-
-### Example
-```ruby
-# load the gem
-require 'harbor2_legacy_client'
-# setup authorization
-Harbor2LegacyClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = Harbor2LegacyClient::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifier.
-
-registration = Harbor2LegacyClient::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registraiton to be updated.
-
-
-begin
-  #Update a scanner registration
-  api_instance.scanners_registration_id_put(registration_id, registration)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScannersApi->scanners_registration_id_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **registration_id** | **String**| The scanner registration identifier. | 
- **registration** | [**ScannerRegistrationReq**](ScannerRegistrationReq.md)| A scanner registraiton to be updated. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-

data/docs/Search.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::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/SearchRepository.md

@@ -1,13 +0,0 @@
-# Harbor2LegacyClient::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

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::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/StatisticMap.md

@@ -1,13 +0,0 @@
-# Harbor2LegacyClient::StatisticMap
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**private_project_count** | **Integer** | The count of the private projects which the user is a member of. | [optional] 
-**private_repo_count** | **Integer** | The count of the private repositories belonging to the projects which the user is a member of. | [optional] 
-**public_project_count** | **Integer** | The count of the public projects. | [optional] 
-**public_repo_count** | **Integer** | The count of the public repositories belonging to the public projects which the user is a member of. | [optional] 
-**total_project_count** | **Integer** | The count of the total projects, only be seen when the is admin. | [optional] 
-**total_repo_count** | **Integer** | The count of the total repositories, only be seen when the user is admin. | [optional] 
-
-

data/docs/Stats.md

@@ -1,12 +0,0 @@
-# Harbor2LegacyClient::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] 
-**requester** | **String** | The requester identity which usually uses the ID of the scan all job | [optional] 
-**metrics** | **Hash<String, Integer>** | The metrics data for the each status | [optional] 
-**ongoing** | **BOOLEAN** | A flag indicating job status of scan all . | [optional] 
-
-

data/docs/Storage.md

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

data/docs/StringConfigItem.md

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

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

data/docs/SysAdminFlag.md

@@ -1,8 +0,0 @@
-# Harbor2LegacyClient::SysAdminFlag
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sysadmin_flag** | **BOOLEAN** | true-admin, false-not admin. | [optional] 
-
-