harbor_swagger_client 1.0.2 → 1.0.3

data/spec/docs/Search.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Search
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project** | [**Array<Project>**](Project.md) | Search results of the projects that matched the filter keywords. | [optional] 
+**repository** | [**Array<SearchRepository>**](SearchRepository.md) | Search results of the repositories that matched the filter keywords. | [optional] 
+**chart** | [**Array<SearchResult>**](SearchResult.md) | Search results of the charts that macthed the filter keywords. | [optional] 
+
+

data/spec/docs/SearchRepository.md

@@ -0,0 +1,13 @@
+# SwaggerClient::SearchRepository
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_id** | **Integer** | The ID of the project that the repository belongs to | [optional] 
+**project_name** | **String** | The name of the project that the repository belongs to | [optional] 
+**project_public** | **BOOLEAN** | The flag to indicate the publicity of the project that the repository belongs to (1 is public, 0 is not) | [optional] 
+**repository_name** | **String** | The name of the repository | [optional] 
+**pull_count** | **Integer** | The count how many times the repository is pulled | [optional] 
+**tags_count** | **Integer** | The count of tags in the repository | [optional] 
+
+

data/spec/docs/SearchResult.md

@@ -0,0 +1,10 @@
+# SwaggerClient::SearchResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The chart name with repo name | [optional] 
+**score** | **Integer** | The matched level | [optional] 
+**chart** | [**ChartVersion**](ChartVersion.md) |  | [optional] 
+
+

data/spec/docs/SecurityReport.md

@@ -0,0 +1,8 @@
+# SwaggerClient::SecurityReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signature** | [**DigitalSignature**](DigitalSignature.md) |  | [optional] 
+
+

data/spec/docs/StatisticMap.md

@@ -0,0 +1,13 @@
+# SwaggerClient::StatisticMap
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**private_project_count** | **Integer** | The count of the private projects which the user is a member of. | [optional] 
+**private_repo_count** | **Integer** | The count of the private repositories belonging to the projects which the user is a member of. | [optional] 
+**public_project_count** | **Integer** | The count of the public projects. | [optional] 
+**public_repo_count** | **Integer** | The count of the public repositories belonging to the public projects which the user is a member of. | [optional] 
+**total_project_count** | **Integer** | The count of the total projects, only be seen when the is admin. | [optional] 
+**total_repo_count** | **Integer** | The count of the total repositories, only be seen when the user is admin. | [optional] 
+
+

data/spec/docs/Stats.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Stats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | The total number of scan processes triggered by the scan all action | [optional] 
+**completed** | **Integer** | The number of the finished scan processes triggered by the scan all action | [optional] 
+**requester** | **String** | The requester identity which usually uses the ID of the scan all job | [optional] 
+**metrics** | **Hash<String, Integer>** | The metrics data for the each status | [optional] 
+
+

data/spec/docs/Storage.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Storage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Total volume size. | [optional] 
+**free** | **Integer** | Free volume size. | [optional] 
+
+

data/spec/docs/StringConfigItem.md

@@ -0,0 +1,9 @@
+# SwaggerClient::StringConfigItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The string value of current config item | [optional] 
+**editable** | **BOOLEAN** | The configure item can be updated or not | [optional] 
+
+

data/spec/docs/SystemApi.md

@@ -0,0 +1,163 @@
+# SwaggerClient::SystemApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**system_cve_whitelist_get**](SystemApi.md#system_cve_whitelist_get) | **GET** /system/CVEWhitelist | Get the system level whitelist of CVE.
+[**system_cve_whitelist_put**](SystemApi.md#system_cve_whitelist_put) | **PUT** /system/CVEWhitelist | Update the system level whitelist of CVE.
+[**system_oidc_ping_post**](SystemApi.md#system_oidc_ping_post) | **POST** /system/oidc/ping | Test the OIDC endpoint.
+
+
+# **system_cve_whitelist_get**
+> CVEWhitelist system_cve_whitelist_get
+
+Get the system level whitelist of CVE.
+
+Get the system level whitelist of CVE.  This API can be called by all authenticated users.
+
+### 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::SystemApi.new
+
+begin
+  #Get the system level whitelist of CVE.
+  result = api_instance.system_cve_whitelist_get
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling SystemApi->system_cve_whitelist_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CVEWhitelist**](CVEWhitelist.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **system_cve_whitelist_put**
+> system_cve_whitelist_put(opts)
+
+Update the system level whitelist of CVE.
+
+This API overwrites the system level whitelist of CVE with the list in request body.  Only system Admin has permission to call this API.
+
+### 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::SystemApi.new
+
+opts = { 
+  whitelist: SwaggerClient::CVEWhitelist.new # CVEWhitelist | The whitelist with new content
+}
+
+begin
+  #Update the system level whitelist of CVE.
+  api_instance.system_cve_whitelist_put(opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling SystemApi->system_cve_whitelist_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **whitelist** | [**CVEWhitelist**](CVEWhitelist.md)| The whitelist with new content | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **system_oidc_ping_post**
+> system_oidc_ping_post(endpoint)
+
+Test the OIDC endpoint.
+
+Test the OIDC endpoint, the setting of the endpoint is provided in the request.  This API can only be called by system admin.
+
+### 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::SystemApi.new
+
+endpoint = SwaggerClient::Endpoint.new # Endpoint | Request body for OIDC endpoint to be tested.
+
+
+begin
+  #Test the OIDC endpoint.
+  api_instance.system_oidc_ping_post(endpoint)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling SystemApi->system_oidc_ping_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **endpoint** | [**Endpoint**](Endpoint.md)| Request body for OIDC endpoint 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
+
+
+

data/spec/docs/SystemInfo.md

@@ -0,0 +1,8 @@
+# SwaggerClient::SystemInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**storage** | [**Array<Storage>**](Storage.md) | The storage of system. | [optional] 
+
+

data/spec/docs/Tags.md

@@ -0,0 +1,8 @@
+# SwaggerClient::Tags
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | The repository's used tag. | [optional] 
+
+

data/spec/docs/TriggerSettings.md

@@ -0,0 +1,8 @@
+# SwaggerClient::TriggerSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cron** | **String** | The cron string for scheduled trigger | [optional] 
+
+

data/spec/docs/UnauthorizedChartAPIError.md

@@ -0,0 +1,8 @@
+# SwaggerClient::UnauthorizedChartAPIError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | The error message returned by the chart API | 
+
+

data/spec/docs/User.md

@@ -0,0 +1,21 @@
+# SwaggerClient::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **Integer** | The ID of the user. | [optional] 
+**username** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+**realname** | **String** |  | [optional] 
+**comment** | **String** |  | [optional] 
+**deleted** | **BOOLEAN** |  | [optional] 
+**role_name** | **String** |  | [optional] 
+**role_id** | **Integer** |  | [optional] 
+**has_admin_role** | **BOOLEAN** |  | [optional] 
+**reset_uuid** | **String** |  | [optional] 
+**salt** | **String** |  | [optional] 
+**creation_time** | **String** |  | [optional] 
+**update_time** | **String** |  | [optional] 
+
+

data/spec/docs/UserEntity.md

@@ -0,0 +1,9 @@
+# SwaggerClient::UserEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **Integer** | The ID of the user. | [optional] 
+**username** | **String** | The name of the user. | [optional] 
+
+

data/spec/docs/UserGroup.md

@@ -0,0 +1,11 @@
+# SwaggerClient::UserGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the user group | [optional] 
+**group_name** | **String** | The name of the user group | [optional] 
+**group_type** | **Integer** | The group type, 1 for LDAP group, 2 for HTTP group. | [optional] 
+**ldap_group_dn** | **String** | The DN of the LDAP group if group type is 1 (LDAP group). | [optional] 
+
+

data/spec/docs/UserProfile.md

@@ -0,0 +1,10 @@
+# SwaggerClient::UserProfile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The new email. | [optional] 
+**realname** | **String** | The new realname. | [optional] 
+**comment** | **String** | The new comment. | [optional] 
+
+

data/spec/docs/UserSearch.md

@@ -0,0 +1,9 @@
+# SwaggerClient::UserSearch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **Integer** | The ID of the user. | [optional] 
+**username** | **String** |  | [optional] 
+
+

data/spec/docs/VulnNamespaceTimestamp.md

@@ -0,0 +1,9 @@
+# SwaggerClient::VulnNamespaceTimestamp
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**namespace** | **String** | The namespace of the Vulnerability | [optional] 
+**last_update** | **Integer** | The UTC timestamp in miliseconds of last successful update for vulnerability data. | [optional] 
+
+

data/spec/docs/VulnerabilityItem.md

@@ -0,0 +1,14 @@
+# SwaggerClient::VulnerabilityItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the CVE. | [optional] 
+**package** | **String** | An operating system or software dependency package containing the vulnerability. | [optional] 
+**version** | **String** | The version of the package containing the vulnerability. | [optional] 
+**fix_version** | **String** | The version of the package containing the fix if available. | [optional] 
+**severity** | **String** | A standard scale for measuring the severity of a vulnerability. | [optional] 
+**description** | **String** | Description of the CVE | [optional] 
+**links** | **Array<String>** | The list of link to the upstream database with the full description of the vulnerability. | [optional] 
+
+

data/spec/docs/VulnerabilitySummary.md

@@ -0,0 +1,10 @@
+# SwaggerClient::VulnerabilitySummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | The total number of the found vulnerabilities | [optional] 
+**fixable** | **Integer** | The number of the fixable vulnerabilities | [optional] 
+**summary** | **Hash<String, Integer>** | Numbers of the vulnerabilities with different severity | [optional] 
+
+

data/spec/docs/WebhookJob.md

@@ -0,0 +1,15 @@
+# SwaggerClient::WebhookJob
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The webhook job ID. | [optional] 
+**policy_id** | **Integer** | The webhook policy ID. | [optional] 
+**event_type** | **String** | The webhook job event type. | [optional] 
+**notify_type** | **String** | The webhook job notify type. | [optional] 
+**status** | **String** | The webhook job status. | [optional] 
+**job_detail** | **String** | The webhook job notify detailed data. | [optional] 
+**creation_time** | **String** | The webhook job creation time. | [optional] 
+**update_time** | **String** | The webhook job update time. | [optional] 
+
+

data/spec/docs/WebhookLastTrigger.md

@@ -0,0 +1,11 @@
+# SwaggerClient::WebhookLastTrigger
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_type** | **String** | The webhook event type. | [optional] 
+**enabled** | **BOOLEAN** | Whether or not the webhook policy enabled. | [optional] 
+**creation_time** | **String** | The creation time of webhook policy. | [optional] 
+**last_trigger_time** | **String** | The last trigger time of webhook policy. | [optional] 
+
+

data/spec/docs/WebhookPolicy.md

@@ -0,0 +1,17 @@
+# SwaggerClient::WebhookPolicy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The webhook policy ID. | [optional] 
+**name** | **String** | The name of webhook policy. | [optional] 
+**description** | **String** | The description of webhook policy. | [optional] 
+**project_id** | **Integer** | The project ID of webhook policy. | [optional] 
+**targets** | [**Array<WebhookTargetObject>**](WebhookTargetObject.md) |  | [optional] 
+**event_types** | **Array<String>** |  | [optional] 
+**creator** | **String** | The creator of the webhook policy. | [optional] 
+**creation_time** | **String** | The create time of the webhook policy. | [optional] 
+**update_time** | **String** | The update time of the webhook policy. | [optional] 
+**enabled** | **BOOLEAN** | Whether the webhook policy is enabled or not. | [optional] 
+
+