harbor_swagger_client 1.0.3 → 1.0.4

data/spec/docs/RobotAccountCreate.md

@@ -1,10 +0,0 @@
-# SwaggerClient::RobotAccountCreate
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of robot account | [optional] 
-**description** | **String** | The description of robot account | [optional] 
-**access** | [**Array<RobotAccountAccess>**](RobotAccountAccess.md) | The permission of robot account | [optional] 
-
-

data/spec/docs/RobotAccountPostRep.md

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

data/spec/docs/RobotAccountUpdate.md

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

data/spec/docs/Role.md

@@ -1,11 +0,0 @@
-# SwaggerClient::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/spec/docs/RoleParam.md

@@ -1,9 +0,0 @@
-# SwaggerClient::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/spec/docs/RoleRequest.md

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

data/spec/docs/ScanApi.md

@@ -1,281 +0,0 @@
-# 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/spec/docs/ScanOverview.md

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

data/spec/docs/Scanner.md

@@ -1,10 +0,0 @@
-# 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/spec/docs/ScannerAdapterMetadata.md

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

data/spec/docs/ScannerCapability.md

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

data/spec/docs/ScannerRegistration.md

@@ -1,21 +0,0 @@
-# SwaggerClient::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/spec/docs/ScannerRegistrationReq.md

@@ -1,15 +0,0 @@
-# SwaggerClient::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/spec/docs/ScannerRegistrationSettings.md

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

data/spec/docs/ScannersApi.md

@@ -1,600 +0,0 @@
-# SwaggerClient::ScannersApi
-
-All URIs are relative to *http://localhost/api*
-
-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 '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::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 SwaggerClient::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 '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::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 SwaggerClient::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 '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::ScannersApi.new
-
-project_id = 789 # Integer | The project identifier.
-
-payload = SwaggerClient::ProjectScanner.new # ProjectScanner | 
-
-
-begin
-  #Configure scanner for the specified project
-  api_instance.projects_project_id_scanner_put(project_id, payload)
-rescue SwaggerClient::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 '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::ScannersApi.new
-
-begin
-  #List scanner registrations
-  result = api_instance.scanners_get
-  p result
-rescue SwaggerClient::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 '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::ScannersApi.new
-
-settings = SwaggerClient::ScannerRegistrationSettings.new # ScannerRegistrationSettings | A scanner registration settings to be tested.
-
-
-begin
-  #Tests scanner registration settings
-  api_instance.scanners_ping_post(settings)
-rescue SwaggerClient::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 '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::ScannersApi.new
-
-registration = SwaggerClient::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registration to be created.
-
-
-begin
-  #Create a scanner registration
-  api_instance.scanners_post(registration)
-rescue SwaggerClient::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 '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::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 SwaggerClient::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 '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::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 SwaggerClient::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 '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::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 SwaggerClient::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 '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::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifier.
-
-payload = SwaggerClient::IsDefault.new # IsDefault | 
-
-
-begin
-  #Set system default scanner registration
-  api_instance.scanners_registration_id_patch(registration_id, payload)
-rescue SwaggerClient::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 '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::ScannersApi.new
-
-registration_id = 'registration_id_example' # String | The scanner registration identifier.
-
-registration = SwaggerClient::ScannerRegistrationReq.new # ScannerRegistrationReq | A scanner registraiton to be updated.
-
-
-begin
-  #Update a scanner registration
-  api_instance.scanners_registration_id_put(registration_id, registration)
-rescue SwaggerClient::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
-
-
-