harbor2_client 0.2.0 → 2.3.3.0

data/docs/Robotv1Api.md

@@ -0,0 +1,329 @@
+# Harbor2Client::Robotv1Api
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_robot_v1**](Robotv1Api.md#create_robot_v1) | **POST** /projects/{project_name_or_id}/robots | Create a robot account
+[**delete_robot_v1**](Robotv1Api.md#delete_robot_v1) | **DELETE** /projects/{project_name_or_id}/robots/{robot_id} | Delete a robot account
+[**get_robot_by_idv1**](Robotv1Api.md#get_robot_by_idv1) | **GET** /projects/{project_name_or_id}/robots/{robot_id} | Get a robot account
+[**list_robot_v1**](Robotv1Api.md#list_robot_v1) | **GET** /projects/{project_name_or_id}/robots | Get all robot accounts of specified project
+[**update_robot_v1**](Robotv1Api.md#update_robot_v1) | **PUT** /projects/{project_name_or_id}/robots/{robot_id} | Update status of robot account.
+
+
+# **create_robot_v1**
+> RobotCreated create_robot_v1(project_name_or_idrobot, opts)
+
+Create a robot account
+
+Create a robot account
+
+### 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::Robotv1Api.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+robot = Harbor2Client::RobotCreateV1.new # RobotCreateV1 | The JSON object of a robot account.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Create a robot account
+  result = api_instance.create_robot_v1(project_name_or_idrobot, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling Robotv1Api->create_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **robot** | [**RobotCreateV1**](RobotCreateV1.md)| The JSON object of a robot account. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+[**RobotCreated**](RobotCreated.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_robot_v1**
+> delete_robot_v1(project_name_or_idrobot_id, , opts)
+
+Delete a robot account
+
+This endpoint deletes specific robot account information by robot ID.
+
+### 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::Robotv1Api.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+robot_id = 56 # Integer | Robot ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Delete a robot account
+  api_instance.delete_robot_v1(project_name_or_idrobot_id, , opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling Robotv1Api->delete_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **robot_id** | **Integer**| Robot ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_robot_by_idv1**
+> Robot get_robot_by_idv1(project_name_or_idrobot_id, , opts)
+
+Get a robot account
+
+This endpoint returns specific robot account information by robot ID.
+
+### 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::Robotv1Api.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+robot_id = 56 # Integer | Robot ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Get a robot account
+  result = api_instance.get_robot_by_idv1(project_name_or_idrobot_id, , opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling Robotv1Api->get_robot_by_idv1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **robot_id** | **Integer**| Robot ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+[**Robot**](Robot.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_robot_v1**
+> Array<Robot> list_robot_v1(project_name_or_id, opts)
+
+Get all robot accounts of specified project
+
+Get all robot accounts of specified project
+
+### 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::Robotv1Api.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  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]
+  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\"
+}
+
+begin
+  #Get all robot accounts of specified project
+  result = api_instance.list_robot_v1(project_name_or_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling Robotv1Api->list_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+ **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] 
+ **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] 
+
+### Return type
+
+[**Array<Robot>**](Robot.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_robot_v1**
+> update_robot_v1(project_name_or_idrobot_id, robot, opts)
+
+Update status of robot account.
+
+Used to disable/enable a specified robot account.
+
+### 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::Robotv1Api.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+robot_id = 56 # Integer | Robot ID
+
+robot = Harbor2Client::Robot.new # Robot | The JSON object of a robot account.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Update status of robot account.
+  api_instance.update_robot_v1(project_name_or_idrobot_id, robot, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling Robotv1Api->update_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **robot_id** | **Integer**| Robot ID | 
+ **robot** | [**Robot**](Robot.md)| The JSON object of a robot account. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/RoleRequest.md

@@ -0,0 +1,8 @@
+# Harbor2Client::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/ScanAllApi.md

@@ -0,0 +1,287 @@
+# Harbor2Client::ScanAllApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_scan_all_schedule**](ScanAllApi.md#create_scan_all_schedule) | **POST** /system/scanAll/schedule | Create a schedule or a manual trigger for the scan all job.
+[**get_latest_scan_all_metrics**](ScanAllApi.md#get_latest_scan_all_metrics) | **GET** /scans/all/metrics | Get the metrics of the latest scan all process
+[**get_latest_scheduled_scan_all_metrics**](ScanAllApi.md#get_latest_scheduled_scan_all_metrics) | **GET** /scans/schedule/metrics | Get the metrics of the latest scheduled scan all process
+[**get_scan_all_schedule**](ScanAllApi.md#get_scan_all_schedule) | **GET** /system/scanAll/schedule | Get scan all's schedule.
+[**update_scan_all_schedule**](ScanAllApi.md#update_scan_all_schedule) | **PUT** /system/scanAll/schedule | Update scan all's schedule.
+
+
+# **create_scan_all_schedule**
+> create_scan_all_schedule(schedule, opts)
+
+Create a schedule or a manual trigger for the scan all job.
+
+This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.
+
+### 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::ScanAllApi.new
+
+schedule = Harbor2Client::Schedule.new # Schedule | Create a schedule or a manual trigger for the scan all job.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create a schedule or a manual trigger for the scan all job.
+  api_instance.create_scan_all_schedule(schedule, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanAllApi->create_scan_all_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **schedule** | [**Schedule**](Schedule.md)| Create a schedule or a manual trigger for the scan all job. | 
+ **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_latest_scan_all_metrics**
+> Stats get_latest_scan_all_metrics(opts)
+
+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_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::ScanAllApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the metrics of the latest scan all process
+  result = api_instance.get_latest_scan_all_metrics(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanAllApi->get_latest_scan_all_metrics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Stats**](Stats.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_latest_scheduled_scan_all_metrics**
+> Stats get_latest_scheduled_scan_all_metrics(opts)
+
+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_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::ScanAllApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the metrics of the latest scheduled scan all process
+  result = api_instance.get_latest_scheduled_scan_all_metrics(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanAllApi->get_latest_scheduled_scan_all_metrics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Stats**](Stats.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_scan_all_schedule**
+> Schedule get_scan_all_schedule(opts)
+
+Get scan all's schedule.
+
+This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.
+
+### 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::ScanAllApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get scan all's schedule.
+  result = api_instance.get_scan_all_schedule(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanAllApi->get_scan_all_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Schedule**](Schedule.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_scan_all_schedule**
+> update_scan_all_schedule(schedule, opts)
+
+Update scan all's schedule.
+
+This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.
+
+### 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::ScanAllApi.new
+
+schedule = Harbor2Client::Schedule.new # Schedule | Updates the schedule of scan all job, which scans all of images in Harbor.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update scan all's schedule.
+  api_instance.update_scan_all_schedule(schedule, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanAllApi->update_scan_all_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **schedule** | [**Schedule**](Schedule.md)| Updates the schedule of scan all job, which scans all of images in Harbor. | 
+ **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/Scanner.md

@@ -0,0 +1,10 @@
+# Harbor2Client::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

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