harbor_swagger_client 1.0.2 → 1.0.3

data/docs/Project.md

@@ -11,7 +11,8 @@ Name | Type | Description | Notes
 **deleted** | **BOOLEAN** | A deletion mark of the project. | [optional] 
 **owner_name** | **String** | The owner name of the project. | [optional] 
 **togglable** | **BOOLEAN** | Correspond to the UI about whether the project's publicity is  updatable (for UI) | [optional] 
-**current_user_role_id** | **Integer** | The role ID of the current user who triggered the API (for UI) | [optional] 
+**current_user_role_id** | **Integer** | The role ID with highest permission of the current user who triggered the API (for UI) | [optional] 
+**current_user_role_ids** | **Array<Integer>** | The list of role ID of the current user who triggered the API (for UI) | [optional] 
 **repo_count** | **Integer** | The number of the repositories under this project. | [optional] 
 **chart_count** | **Integer** | The total number of charts under this project. | [optional] 
 **metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 

data/docs/ProjectMetadata.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **public** | **String** | The public status of the project. The valid values are \"true\", \"false\". | [optional] 
 **enable_content_trust** | **String** | Whether content trust is enabled or not. If it is enabled, user can't pull unsigned images from this project. The valid values are \"true\", \"false\". | [optional] 
 **prevent_vul** | **String** | Whether prevent the vulnerable images from running. The valid values are \"true\", \"false\". | [optional] 
-**severity** | **String** | If the vulnerability is high than severity defined here, the images can't be pulled. The valid values are \"negligible\", \"low\", \"medium\", \"high\", \"critical\". | [optional] 
+**severity** | **String** | If the vulnerability is high than severity defined here, the images can't be pulled. The valid values are \"none\", \"low\", \"medium\", \"high\", \"critical\". | [optional] 
 **auto_scan** | **String** | Whether scan images automatically when pushing. The valid values are \"true\", \"false\". | [optional] 
 **reuse_sys_cve_whitelist** | **String** | Whether this project reuse the system level CVE whitelist as the whitelist of its own.  The valid values are \"true\", \"false\". If it is set to \"true\" the actual whitelist associate with this project, if any, will be ignored. | [optional] 
 

data/docs/ProjectScanner.md

@@ -0,0 +1,8 @@
+# SwaggerClient::ProjectScanner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | The identifier of the scanner registration | [optional] 
+
+

data/docs/QuotaApi.md

@@ -4,71 +4,10 @@ All URIs are relative to *http://localhost/api*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**quotas_get**](QuotaApi.md#quotas_get) | **GET** /quotas | List quotas
 [**quotas_id_get**](QuotaApi.md#quotas_id_get) | **GET** /quotas/{id} | Get the specified quota
 [**quotas_id_put**](QuotaApi.md#quotas_id_put) | **PUT** /quotas/{id} | Update the specified quota
 
 
-# **quotas_get**
-> Array<Quota> quotas_get(opts)
-
-List quotas
-
-List quotas
-
-### Example
-```ruby
-# load the gem
-require 'harbor_swagger_client'
-# setup authorization
-SwaggerClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = SwaggerClient::QuotaApi.new
-
-opts = { 
-  reference: 'reference_example', # String | The reference type of quota.
-  sort: 'sort_example', # String | Sort method, valid values include: 'hard.resource_name', '-hard.resource_name', 'used.resource_name', '-used.resource_name'. Here '-' stands for descending order, resource_name should be the real resource name of the quota. 
-  page: 56, # Integer | The page number, default is 1.
-  page_size: 56 # Integer | The size of per page, default is 10, maximum is 100.
-}
-
-begin
-  #List quotas
-  result = api_instance.quotas_get(opts)
-  p result
-rescue SwaggerClient::ApiError => e
-  puts "Exception when calling QuotaApi->quotas_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **reference** | **String**| The reference type of quota. | [optional] 
- **sort** | **String**| Sort method, valid values include: 'hard.resource_name', '-hard.resource_name', 'used.resource_name', '-used.resource_name'. Here '-' stands for descending order, resource_name should be the real resource name of the quota.  | [optional] 
- **page** | **Integer**| The page number, default is 1. | [optional] 
- **page_size** | **Integer**| The size of per page, default is 10, maximum is 100. | [optional] 
-
-### Return type
-
-[**Array<Quota>**](Quota.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json, text/plain
-
-
-
 # **quotas_id_get**
 > Quota quotas_id_get(id)
 

data/docs/Report.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Report
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**generated_at** | **String** | Time of generating this report | [optional] 
+**severity** | **String** | A standard scale for measuring the severity of a vulnerability. | [optional] 
+**vulnerabilities** | [**Array<VulnerabilityItem>**](VulnerabilityItem.md) |  | [optional] 
+**scanner** | [**Scanner**](Scanner.md) |  | [optional] 
+
+

data/docs/RetentionPolicy.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **id** | **Integer** |  | [optional] 
 **algorithm** | **String** |  | [optional] 
 **rules** | [**Array<RetentionRule>**](RetentionRule.md) |  | [optional] 
-**trigger** | **Object** |  | [optional] 
-**scope** | **Object** |  | [optional] 
+**trigger** | [**RetentionRuleTrigger**](RetentionRuleTrigger.md) |  | [optional] 
+**scope** | [**RetentionPolicyScope**](RetentionPolicyScope.md) |  | [optional] 
 
 

data/docs/ScanApi.md

@@ -0,0 +1,281 @@
+# SwaggerClient::ScanApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**repositories_repo_name_tags_tag_scan_get**](ScanApi.md#repositories_repo_name_tags_tag_scan_get) | **GET** /repositories/{repo_name}/tags/{tag}/scan | Get the scan report
+[**repositories_repo_name_tags_tag_scan_post**](ScanApi.md#repositories_repo_name_tags_tag_scan_post) | **POST** /repositories/{repo_name}/tags/{tag}/scan | Scan the image.
+[**repositories_repo_name_tags_tag_scan_uuid_log_get**](ScanApi.md#repositories_repo_name_tags_tag_scan_uuid_log_get) | **GET** /repositories/{repo_name}/tags/{tag}/scan/{uuid}/log | Get scan log
+[**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
+
+
+# **repositories_repo_name_tags_tag_scan_get**
+> Report repositories_repo_name_tags_tag_scan_get(repo_name, tag, opts)
+
+Get the scan report
+
+Retrieve the scan report for the artifact identified by the repo_name and tag. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ScanApi.new
+
+repo_name = 'repo_name_example' # String | Repository name
+
+tag = 'tag_example' # String | Tag name
+
+opts = { 
+  accept: 'accept_example' # String | Mimetype in header. e.g: \"application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0\" 
+}
+
+begin
+  #Get the scan report
+  result = api_instance.repositories_repo_name_tags_tag_scan_get(repo_name, tag, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ScanApi->repositories_repo_name_tags_tag_scan_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repo_name** | **String**| Repository name | 
+ **tag** | **String**| Tag name | 
+ **accept** | **String**| Mimetype in header. e.g: \"application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0\"  | [optional] 
+
+### Return type
+
+[**Report**](Report.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **repositories_repo_name_tags_tag_scan_post**
+> repositories_repo_name_tags_tag_scan_post(repo_name, tag)
+
+Scan the image.
+
+Trigger a scan targeting the artifact identified by the repo_name and tag. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ScanApi.new
+
+repo_name = 'repo_name_example' # String | Repository name
+
+tag = 'tag_example' # String | Tag name
+
+
+begin
+  #Scan the image.
+  api_instance.repositories_repo_name_tags_tag_scan_post(repo_name, tag)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ScanApi->repositories_repo_name_tags_tag_scan_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repo_name** | **String**| Repository name | 
+ **tag** | **String**| Tag name | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **repositories_repo_name_tags_tag_scan_uuid_log_get**
+> String repositories_repo_name_tags_tag_scan_uuid_log_get(repo_name, tag, uuid)
+
+Get scan log
+
+Get the log text stream for the given artifact and scan action.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ScanApi.new
+
+repo_name = 'repo_name_example' # String | Repository name
+
+tag = 'tag_example' # String | Tag name
+
+uuid = 'uuid_example' # String | the scan unique identifier
+
+
+begin
+  #Get scan log
+  result = api_instance.repositories_repo_name_tags_tag_scan_uuid_log_get(repo_name, tag, uuid)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ScanApi->repositories_repo_name_tags_tag_scan_uuid_log_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repo_name** | **String**| Repository name | 
+ **tag** | **String**| Tag name | 
+ **uuid** | **String**| the scan unique identifier | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+
+# **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 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ScanApi.new
+
+begin
+  #Get the metrics of the latest scan all process
+  result = api_instance.scans_all_metrics_get
+  p result
+rescue SwaggerClient::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 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::ScanApi.new
+
+begin
+  #Get the metrics of the latest scheduled scan all process
+  result = api_instance.scans_schedule_metrics_get
+  p result
+rescue SwaggerClient::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/ScanOverview.md

@@ -0,0 +1,7 @@
+# SwaggerClient::ScanOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Scanner.md

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

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