harbor2_legacy_client 0.2.1 → 2.3.3.0

data/docs/RobotAccount.md

@@ -1,15 +0,0 @@
-# Harbor2LegacyClient::RobotAccount
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Integer** | The id of robot account | [optional] 
-**name** | **String** | The name of robot account | [optional] 
-**description** | **String** | The description of robot account | [optional] 
-**expires_at** | **Integer** | The expiration of robot account (in seconds) | [optional] 
-**project_id** | **Integer** | The project id of robot account | [optional] 
-**disabled** | **BOOLEAN** | The robot account is disable or enable | [optional] 
-**creation_time** | **String** | The creation time of the robot account | [optional] 
-**update_time** | **String** | The update time of the robot account | [optional] 
-
-

data/docs/RobotAccountAccess.md

@@ -1,9 +0,0 @@
-# Harbor2LegacyClient::RobotAccountAccess
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**resource** | **String** | the resource of harbor | [optional] 
-**action** | **String** | the action to resource that perdefined in harbor rbac | [optional] 
-
-

data/docs/RobotAccountApi.md

@@ -1,291 +0,0 @@
-# Harbor2LegacyClient::RobotAccountApi
-
-All URIs are relative to *http://localhost/api/v2.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**projects_project_id_robots_get**](RobotAccountApi.md#projects_project_id_robots_get) | **GET** /projects/{project_id}/robots | Get all robot accounts of specified project
-[**projects_project_id_robots_post**](RobotAccountApi.md#projects_project_id_robots_post) | **POST** /projects/{project_id}/robots | Create a robot account for project
-[**projects_project_id_robots_robot_id_delete**](RobotAccountApi.md#projects_project_id_robots_robot_id_delete) | **DELETE** /projects/{project_id}/robots/{robot_id} | Delete the specified robot account
-[**projects_project_id_robots_robot_id_get**](RobotAccountApi.md#projects_project_id_robots_robot_id_get) | **GET** /projects/{project_id}/robots/{robot_id} | Return the infor of the specified robot account.
-[**projects_project_id_robots_robot_id_put**](RobotAccountApi.md#projects_project_id_robots_robot_id_put) | **PUT** /projects/{project_id}/robots/{robot_id} | Update status of robot account.
-
-
-# **projects_project_id_robots_get**
-> Array<RobotAccount> projects_project_id_robots_get(project_id)
-
-Get all robot accounts of specified project
-
-Get all robot accounts of 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::RobotAccountApi.new
-
-project_id = 789 # Integer | Relevant project ID.
-
-
-begin
-  #Get all robot accounts of specified project
-  result = api_instance.projects_project_id_robots_get(project_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling RobotAccountApi->projects_project_id_robots_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| Relevant project ID. | 
-
-### Return type
-
-[**Array<RobotAccount>**](RobotAccount.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **projects_project_id_robots_post**
-> RobotAccountPostRep projects_project_id_robots_post(project_id, robot)
-
-Create a robot account for project
-
-Create a robot account for 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::RobotAccountApi.new
-
-project_id = 789 # Integer | Relevant project ID.
-
-robot = Harbor2LegacyClient::RobotAccountCreate.new # RobotAccountCreate | Request body of creating a robot account.
-
-
-begin
-  #Create a robot account for project
-  result = api_instance.projects_project_id_robots_post(project_id, robot)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling RobotAccountApi->projects_project_id_robots_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| Relevant project ID. | 
- **robot** | [**RobotAccountCreate**](RobotAccountCreate.md)| Request body of creating a robot account. | 
-
-### Return type
-
-[**RobotAccountPostRep**](RobotAccountPostRep.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **projects_project_id_robots_robot_id_delete**
-> projects_project_id_robots_robot_id_delete(project_id, robot_id)
-
-Delete the specified robot account
-
-Delete the specified robot account
-
-### 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::RobotAccountApi.new
-
-project_id = 789 # Integer | Relevant project ID.
-
-robot_id = 789 # Integer | The ID of robot account.
-
-
-begin
-  #Delete the specified robot account
-  api_instance.projects_project_id_robots_robot_id_delete(project_id, robot_id)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling RobotAccountApi->projects_project_id_robots_robot_id_delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| Relevant project ID. | 
- **robot_id** | **Integer**| The ID of robot account. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **projects_project_id_robots_robot_id_get**
-> RobotAccount projects_project_id_robots_robot_id_get(project_id, robot_id)
-
-Return the infor of the specified robot account.
-
-Return the infor of the specified robot account.
-
-### 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::RobotAccountApi.new
-
-project_id = 789 # Integer | Relevant project ID.
-
-robot_id = 789 # Integer | The ID of robot account.
-
-
-begin
-  #Return the infor of the specified robot account.
-  result = api_instance.projects_project_id_robots_robot_id_get(project_id, robot_id)
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling RobotAccountApi->projects_project_id_robots_robot_id_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| Relevant project ID. | 
- **robot_id** | **Integer**| The ID of robot account. | 
-
-### Return type
-
-[**RobotAccount**](RobotAccount.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **projects_project_id_robots_robot_id_put**
-> projects_project_id_robots_robot_id_put(project_id, robot_id, robot)
-
-Update status of robot account.
-
-Used to disable/enable a specified robot account.
-
-### 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::RobotAccountApi.new
-
-project_id = 789 # Integer | Relevant project ID.
-
-robot_id = 789 # Integer | The ID of robot account.
-
-robot = Harbor2LegacyClient::RobotAccountUpdate.new # RobotAccountUpdate | Request body of enable/disable a robot account.
-
-
-begin
-  #Update status of robot account.
-  api_instance.projects_project_id_robots_robot_id_put(project_id, robot_id, robot)
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling RobotAccountApi->projects_project_id_robots_robot_id_put: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| Relevant project ID. | 
- **robot_id** | **Integer**| The ID of robot account. | 
- **robot** | [**RobotAccountUpdate**](RobotAccountUpdate.md)| Request body of enable/disable a robot account. | 
-
-### 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/RobotAccountCreate.md

@@ -1,11 +0,0 @@
-# Harbor2LegacyClient::RobotAccountCreate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of robot account | [optional] 
-**description** | **String** | The description of robot account | [optional] 
-**expires_at** | **Integer** | The expiration time on or after which the JWT MUST NOT be accepted for processing. | [optional] 
-**access** | [**Array<RobotAccountAccess>**](RobotAccountAccess.md) | The permission of robot account | [optional] 
-
-

data/docs/RobotAccountPostRep.md

@@ -1,9 +0,0 @@
-# Harbor2LegacyClient::RobotAccountPostRep
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | the name of robot account | [optional] 
-**token** | **String** | the token of robot account | [optional] 
-
-

data/docs/RobotAccountUpdate.md

@@ -1,8 +0,0 @@
-# Harbor2LegacyClient::RobotAccountUpdate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**disabled** | **BOOLEAN** | The robot account is disable or enable | [optional] 
-
-

data/docs/Role.md

@@ -1,11 +0,0 @@
-# Harbor2LegacyClient::Role
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**role_id** | **Integer** | ID in table. | [optional] 
-**role_code** | **String** | Description of permissions for the role. | [optional] 
-**role_name** | **String** | Name the the role. | [optional] 
-**role_mask** | **String** |  | [optional] 
-
-

data/docs/RoleParam.md

@@ -1,9 +0,0 @@
-# Harbor2LegacyClient::RoleParam
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**roles** | **Array<Integer>** | Role ID for updating project role member. | [optional] 
-**username** | **String** | Username relevant to a project role member. | [optional] 
-
-

data/docs/RoleRequest.md

@@ -1,8 +0,0 @@
-# Harbor2LegacyClient::RoleRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**role_id** | **Integer** | The role id 1 for projectAdmin, 2 for developer, 3 for guest, 4 for maintainer | [optional] 
-
-

data/docs/ScanApi.md

@@ -1,104 +0,0 @@
-# Harbor2LegacyClient::ScanApi
-
-All URIs are relative to *http://localhost/api/v2.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**scans_all_metrics_get**](ScanApi.md#scans_all_metrics_get) | **GET** /scans/all/metrics | Get the metrics of the latest scan all process
-[**scans_schedule_metrics_get**](ScanApi.md#scans_schedule_metrics_get) | **GET** /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process
-
-
-# **scans_all_metrics_get**
-> Stats scans_all_metrics_get
-
-Get the metrics of the latest scan all process
-
-Get the metrics of the latest scan all process
-
-### 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::ScanApi.new
-
-begin
-  #Get the metrics of the latest scan all process
-  result = api_instance.scans_all_metrics_get
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScanApi->scans_all_metrics_get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Stats**](Stats.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
-# **scans_schedule_metrics_get**
-> Stats scans_schedule_metrics_get
-
-Get the metrics of the latest scheduled scan all process
-
-Get the metrics of the latest scheduled scan all process
-
-### 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::ScanApi.new
-
-begin
-  #Get the metrics of the latest scheduled scan all process
-  result = api_instance.scans_schedule_metrics_get
-  p result
-rescue Harbor2LegacyClient::ApiError => e
-  puts "Exception when calling ScanApi->scans_schedule_metrics_get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Stats**](Stats.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-

data/docs/Scanner.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::Scanner
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the scanner | [optional] 
-**vendor** | **String** | Name of the scanner provider | [optional] 
-**version** | **String** | Version of the scanner adapter | [optional] 
-
-

data/docs/ScannerAdapterMetadata.md

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::ScannerAdapterMetadata
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | [**Scanner**](Scanner.md) |  | [optional] 
-**capabilities** | [**Array<ScannerCapability>**](ScannerCapability.md) |  | [optional] 
-**properties** | **Hash<String, String>** |  | [optional] 
-
-

data/docs/ScannerCapability.md

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

data/docs/ScannerRegistration.md

@@ -1,21 +0,0 @@
-# Harbor2LegacyClient::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]
-**health** | **String** | Indicate the healthy of the registration | [optional] [default to '']
-**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]
-**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] 
-
-

data/docs/ScannerRegistrationReq.md

@@ -1,15 +0,0 @@
-# Harbor2LegacyClient::ScannerRegistrationReq
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
-**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]
-**disabled** | **BOOLEAN** | Indicate whether the registration is enabled or not | [optional] [default to false]
-
-

data/docs/ScannerRegistrationSettings.md

@@ -1,11 +0,0 @@
-# Harbor2LegacyClient::ScannerRegistrationSettings
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of this registration | [optional] 
-**url** | **String** | A base URL of the scanner adapter. | [optional] 
-**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] 
-
-