harbor_swagger_client 1.0.4 → 2.0.0

data/docs/RobotCreate.md

@@ -0,0 +1,14 @@
+# SwaggerClient::RobotCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the tag | [optional] 
+**description** | **String** | The description of the robot | [optional] 
+**secret** | **String** | The secret of the robot | [optional] 
+**level** | **String** | The level of the robot, project or system | [optional] 
+**disable** | **BOOLEAN** | The disable status of the robot | [optional] 
+**duration** | **Integer** | The duration of the robot in days | [optional] 
+**permissions** | [**Array<Permission>**](Permission.md) |  | [optional] 
+
+

data/docs/{RobotAccountCreate.md → RobotCreateV1.md}

@@ -1,4 +1,4 @@
-# SwaggerClient::RobotAccountCreate
+# SwaggerClient::RobotCreateV1
 
 ## Properties
 Name | Type | Description | Notes
@@ -6,6 +6,6 @@ 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] 
+**access** | [**Array<Access>**](Access.md) | The permission of robot account | [optional] 
 
 

data/docs/RobotCreated.md

@@ -0,0 +1,12 @@
+# SwaggerClient::RobotCreated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the robot | [optional] 
+**name** | **String** | The name of the tag | [optional] 
+**secret** | **String** | The secret of the robot | [optional] 
+**creation_time** | **DateTime** | The creation time of the robot. | [optional] 
+**expires_at** | **Integer** | The expiration data of the robot | [optional] 
+
+

data/docs/{Action1.md → RobotSec.md}

@@ -1,8 +1,8 @@
-# SwaggerClient::Action1
+# SwaggerClient::RobotSec
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**action** | **String** |  | [optional] 
+**secret** | **String** | The secret of the robot | [optional] 
 
 

data/docs/Robotv1Api.md

@@ -0,0 +1,317 @@
+# SwaggerClient::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_id_or_name}/robots | Create a robot account
+[**delete_robot_v1**](Robotv1Api.md#delete_robot_v1) | **DELETE** /projects/{project_id_or_name}/robots/{robot_id} | Delete a robot account
+[**get_robot_by_idv1**](Robotv1Api.md#get_robot_by_idv1) | **GET** /projects/{project_id_or_name}/robots/{robot_id} | Get a robot account
+[**list_robot_v1**](Robotv1Api.md#list_robot_v1) | **GET** /projects/{project_id_or_name}/robots | Get all robot accounts of specified project
+[**update_robot_v1**](Robotv1Api.md#update_robot_v1) | **PUT** /projects/{project_id_or_name}/robots/{robot_id} | Update status of robot account.
+
+
+# **create_robot_v1**
+> RobotCreated create_robot_v1(project_id_or_name, robot, opts)
+
+Create a robot account
+
+Create a robot account
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::Robotv1Api.new
+
+project_id_or_name = 'project_id_or_name_example' # String | The id or name of the project
+
+robot = SwaggerClient::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
+}
+
+begin
+  #Create a robot account
+  result = api_instance.create_robot_v1(project_id_or_name, robot, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling Robotv1Api->create_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id_or_name** | **String**| The id or name 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] 
+
+### 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_id_or_name, robot_id, , opts)
+
+Delete a robot account
+
+This endpoint deletes specific robot account information by robot ID.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::Robotv1Api.new
+
+project_id_or_name = 'project_id_or_name_example' # String | The id or name of the project
+
+robot_id = 56 # Integer | Robot ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete a robot account
+  api_instance.delete_robot_v1(project_id_or_name, robot_id, , opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling Robotv1Api->delete_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id_or_name** | **String**| The id or name of the project | 
+ **robot_id** | **Integer**| Robot ID | 
+ **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_robot_by_idv1**
+> Robot get_robot_by_idv1(project_id_or_name, robot_id, , opts)
+
+Get a robot account
+
+This endpoint returns specific robot account information by robot ID.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::Robotv1Api.new
+
+project_id_or_name = 'project_id_or_name_example' # String | The id or name of the project
+
+robot_id = 56 # Integer | Robot ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get a robot account
+  result = api_instance.get_robot_by_idv1(project_id_or_name, robot_id, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling Robotv1Api->get_robot_by_idv1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id_or_name** | **String**| The id or name of the project | 
+ **robot_id** | **Integer**| Robot ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### 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_id_or_name, , opts)
+
+Get all robot accounts of specified project
+
+Get all robot accounts of specified project
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::Robotv1Api.new
+
+project_id_or_name = 'project_id_or_name_example' # String | The id or name of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  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]
+}
+
+begin
+  #Get all robot accounts of specified project
+  result = api_instance.list_robot_v1(project_id_or_name, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling Robotv1Api->list_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id_or_name** | **String**| The id or name of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **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] 
+
+### 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_id_or_name, robot_id, robot, opts)
+
+Update status of robot account.
+
+Used to disable/enable a specified robot account.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::Robotv1Api.new
+
+project_id_or_name = 'project_id_or_name_example' # String | The id or name of the project
+
+robot_id = 56 # Integer | Robot ID
+
+robot = SwaggerClient::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
+}
+
+begin
+  #Update status of robot account.
+  api_instance.update_robot_v1(project_id_or_name, robot_id, robot, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling Robotv1Api->update_robot_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id_or_name** | **String**| The id or name 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] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ScanApi.md

@@ -4,16 +4,16 @@ 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
+[**get_report_log**](ScanApi.md#get_report_log) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/log | Get the log of the scan report
+[**scan_artifact**](ScanApi.md#scan_artifact) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan | Scan the artifact
 
 
-# **scans_all_metrics_get**
-> Stats scans_all_metrics_get
+# **get_report_log**
+> String get_report_log(project_namerepository_name, reference, report_id, opts)
 
-Get the metrics of the latest scan all process
+Get the log of the scan report
 
-Get the metrics of the latest scan all process
+Get the log of the scan report
 
 ### Example
 ```ruby
@@ -21,46 +21,65 @@ Get the metrics of the latest scan all process
 require 'harbor_swagger_client'
 # setup authorization
 SwaggerClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
+  # Configure HTTP basic authorization: basic
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = SwaggerClient::ScanApi.new
 
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
+
+report_id = 'report_id_example' # String | The report id to get the log
+
+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.scans_all_metrics_get
+  #Get the log of the scan report
+  result = api_instance.get_report_log(project_namerepository_name, reference, report_id, opts)
   p result
 rescue SwaggerClient::ApiError => e
-  puts "Exception when calling ScanApi->scans_all_metrics_get: #{e}"
+  puts "Exception when calling ScanApi->get_report_log: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **reference** | **String**| The reference of the artifact, can be digest or tag | 
+ **report_id** | **String**| The report id to get the log | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
 
 ### Return type
 
-[**Stats**](Stats.md)
+**String**
 
 ### Authorization
 
-[basicAuth](../README.md#basicAuth)
+[basic](../README.md#basic)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
+ - **Accept**: text/plain
 
 
 
-# **scans_schedule_metrics_get**
-> Stats scans_schedule_metrics_get
+# **scan_artifact**
+> scan_artifact(project_namerepository_name, reference, , opts)
 
-Get the metrics of the latest scheduled scan all process
+Scan the artifact
 
-Get the metrics of the latest scheduled scan all process
+Scan the specified artifact
 
 ### Example
 ```ruby
@@ -68,37 +87,52 @@ Get the metrics of the latest scheduled scan all process
 require 'harbor_swagger_client'
 # setup authorization
 SwaggerClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
+  # Configure HTTP basic authorization: basic
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = SwaggerClient::ScanApi.new
 
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
+
+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.scans_schedule_metrics_get
-  p result
+  #Scan the artifact
+  api_instance.scan_artifact(project_namerepository_name, reference, , opts)
 rescue SwaggerClient::ApiError => e
-  puts "Exception when calling ScanApi->scans_schedule_metrics_get: #{e}"
+  puts "Exception when calling ScanApi->scan_artifact: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **reference** | **String**| The reference of the artifact, can be digest or tag | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
 
 ### Return type
 
-[**Stats**](Stats.md)
+nil (empty response body)
 
 ### Authorization
 
-[basicAuth](../README.md#basicAuth)
+[basic](../README.md#basic)
 
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
+ - **Accept**: application/json