harbor2_legacy_client 0.1.0

data/docs/CVEAllowlist.md

@@ -0,0 +1,11 @@
+# Harbor2LegacyClient::CVEAllowlist
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the allowlist | [optional] 
+**project_id** | **Integer** | ID of the project which the allowlist belongs to.  For system level allowlist this attribute is zero. | [optional] 
+**expires_at** | **Integer** | the time for expiration of the allowlist, in the form of seconds since epoch.  This is an optional attribute, if it's not set the CVE allowlist does not expire. | [optional] 
+**items** | [**Array<CVEAllowlistItem>**](CVEAllowlistItem.md) |  | [optional] 
+
+

data/docs/CVEAllowlistItem.md

@@ -0,0 +1,8 @@
+# Harbor2LegacyClient::CVEAllowlistItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cve_id** | **String** | The ID of the CVE, such as \"CVE-2019-10164\" | [optional] 
+
+

data/docs/ChartAPIError.md

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

data/docs/ChartMetadata.md

@@ -0,0 +1,18 @@
+# Harbor2LegacyClient::ChartMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the chart | 
+**home** | **String** | The URL to the relevant project page | [optional] 
+**sources** | **Array<String>** | The URL to the source code of chart | [optional] 
+**version** | **String** | A SemVer 2 version of chart | 
+**description** | **String** | A one-sentence description of chart | [optional] 
+**keywords** | **Array<String>** | A list of string keywords | [optional] 
+**engine** | **String** | The name of template engine | 
+**icon** | **String** | The URL to an icon file | 
+**api_version** | **String** | The API version of this chart | 
+**app_version** | **String** | The version of the application enclosed in the chart | 
+**deprecated** | **BOOLEAN** | Whether or not this chart is deprecated | [optional] 
+
+

data/docs/ChartRepositoryApi.md

@@ -0,0 +1,191 @@
+# Harbor2LegacyClient::ChartRepositoryApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**chartrepo_repo_charts_name_version_labels_get**](ChartRepositoryApi.md#chartrepo_repo_charts_name_version_labels_get) | **GET** /chartrepo/{repo}/charts/{name}/{version}/labels | Return the attahced labels of chart.
+[**chartrepo_repo_charts_name_version_labels_id_delete**](ChartRepositoryApi.md#chartrepo_repo_charts_name_version_labels_id_delete) | **DELETE** /chartrepo/{repo}/charts/{name}/{version}/labels/{id} | Remove label from chart.
+[**chartrepo_repo_charts_name_version_labels_post**](ChartRepositoryApi.md#chartrepo_repo_charts_name_version_labels_post) | **POST** /chartrepo/{repo}/charts/{name}/{version}/labels | Mark label to chart.
+
+
+# **chartrepo_repo_charts_name_version_labels_get**
+> chartrepo_repo_charts_name_version_labels_get(repo, name, version)
+
+Return the attahced labels of chart.
+
+Return the attahced labels of the specified chart version.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::ChartRepositoryApi.new
+
+repo = 'repo_example' # String | The project name
+
+name = 'name_example' # String | The chart name
+
+version = 'version_example' # String | The chart version
+
+
+begin
+  #Return the attahced labels of chart.
+  api_instance.chartrepo_repo_charts_name_version_labels_get(repo, name, version)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling ChartRepositoryApi->chartrepo_repo_charts_name_version_labels_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repo** | **String**| The project name | 
+ **name** | **String**| The chart name | 
+ **version** | **String**| The chart version | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **chartrepo_repo_charts_name_version_labels_id_delete**
+> chartrepo_repo_charts_name_version_labels_id_delete(repo, name, version, id)
+
+Remove label from chart.
+
+Remove label from the specified chart version.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::ChartRepositoryApi.new
+
+repo = 'repo_example' # String | The project name
+
+name = 'name_example' # String | The chart name
+
+version = 'version_example' # String | The chart version
+
+id = 56 # Integer | The label ID
+
+
+begin
+  #Remove label from chart.
+  api_instance.chartrepo_repo_charts_name_version_labels_id_delete(repo, name, version, id)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling ChartRepositoryApi->chartrepo_repo_charts_name_version_labels_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repo** | **String**| The project name | 
+ **name** | **String**| The chart name | 
+ **version** | **String**| The chart version | 
+ **id** | **Integer**| The label ID | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **chartrepo_repo_charts_name_version_labels_post**
+> chartrepo_repo_charts_name_version_labels_post(repo, name, version, label)
+
+Mark label to chart.
+
+Mark label to the specified chart version.
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_legacy_client'
+# setup authorization
+Harbor2LegacyClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2LegacyClient::ChartRepositoryApi.new
+
+repo = 'repo_example' # String | The project name
+
+name = 'name_example' # String | The chart name
+
+version = 'version_example' # String | The chart version
+
+label = Harbor2LegacyClient::Label.new # Label | The label being marked to the chart version
+
+
+begin
+  #Mark label to chart.
+  api_instance.chartrepo_repo_charts_name_version_labels_post(repo, name, version, label)
+rescue Harbor2LegacyClient::ApiError => e
+  puts "Exception when calling ChartRepositoryApi->chartrepo_repo_charts_name_version_labels_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repo** | **String**| The project name | 
+ **name** | **String**| The chart name | 
+ **version** | **String**| The chart version | 
+ **label** | [**Label**](Label.md)| The label being marked to the chart version | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+

data/docs/ChartVersion.md

@@ -0,0 +1,23 @@
+# Harbor2LegacyClient::ChartVersion
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the chart | 
+**home** | **String** | The URL to the relevant project page | [optional] 
+**sources** | **Array<String>** | The URL to the source code of chart | [optional] 
+**version** | **String** | A SemVer 2 version of chart | 
+**description** | **String** | A one-sentence description of chart | [optional] 
+**keywords** | **Array<String>** | A list of string keywords | [optional] 
+**engine** | **String** | The name of template engine | 
+**icon** | **String** | The URL to an icon file | 
+**api_version** | **String** | The API version of this chart | 
+**app_version** | **String** | The version of the application enclosed in the chart | 
+**deprecated** | **BOOLEAN** | Whether or not this chart is deprecated | [optional] 
+**labels** | [**Labels**](Labels.md) |  | [optional] 
+**created** | **String** | The created time of the chart entry | [optional] 
+**removed** | **BOOLEAN** | A flag to indicate if the chart entry is removed | [optional] 
+**digest** | **String** | The digest value of the chart entry | [optional] 
+**urls** | **Array<String>** | The urls of the chart entry | [optional] 
+
+

data/docs/ComponentHealthStatus.md

@@ -0,0 +1,10 @@
+# Harbor2LegacyClient::ComponentHealthStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The component name | [optional] 
+**status** | **String** | The health status of component | [optional] 
+**error** | **String** | (optional) The error message when the status is \"unhealthy\" | [optional] 
+
+

data/docs/ComponentOverviewEntry.md

@@ -0,0 +1,9 @@
+# Harbor2LegacyClient::ComponentOverviewEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**severity** | **Integer** | 1-None/Negligible, 2-Unknown, 3-Low, 4-Medium, 5-High | [optional] 
+**count** | **Integer** | number of the components with certain severity. | [optional] 
+
+

data/docs/Configurations.md

@@ -0,0 +1,42 @@
+# Harbor2LegacyClient::Configurations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_mode** | **String** | The auth mode of current system, such as \"db_auth\", \"ldap_auth\" | [optional] 
+**count_per_project** | **String** | The default count quota for the new created projects. | [optional] 
+**email_from** | **String** | The sender name for Email notification. | [optional] 
+**email_host** | **String** | The hostname of SMTP server that sends Email notification. | [optional] 
+**email_port** | **Integer** | The port of SMTP server. | [optional] 
+**email_identity** | **String** | By default it's empty so the email_username is picked. | [optional] 
+**email_username** | **String** | The username for authenticate against SMTP server. | [optional] 
+**email_ssl** | **BOOLEAN** | When it's set to true the system will access Email server via TLS by default.  If it's set to false, it still will handle \"STARTTLS\" from server side. | [optional] 
+**email_insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the email server. | [optional] 
+**ldap_url** | **String** | The URL of LDAP server. | [optional] 
+**ldap_base_dn** | **String** | The Base DN for LDAP binding. | [optional] 
+**ldap_filter** | **String** | The filter for LDAP binding. | [optional] 
+**ldap_scope** | **Integer** | 0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE | [optional] 
+**ldap_uid** | **String** | The attribute which is used as identity for the LDAP binding, such as \"CN\" or \"SAMAccountname\" | [optional] 
+**ldap_search_dn** | **String** | The DN of the user to do the search. | [optional] 
+**ldap_timeout** | **Integer** | timeout in seconds for connection to LDAP server. | [optional] 
+**ldap_group_attribute_name** | **String** | The attribute which is used as identity of the LDAP group, default is cn. | [optional] 
+**ldap_group_base_dn** | **String** | The base DN to search LDAP group. | [optional] 
+**ldap_group_search_filter** | **String** | The filter to search the ldap group. | [optional] 
+**ldap_group_search_scope** | **Integer** | The scope to search ldap. '0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE' | [optional] 
+**ldap_group_admin_dn** | **String** | Specify the ldap group which have the same privilege with Harbor admin. | [optional] 
+**oidc_client_id** | **String** | The client id of the OIDC. | [optional] 
+**oidc_client_secret** | **String** | The client secret of the OIDC. | [optional] 
+**oidc_endpoint** | **String** | The URL of an OIDC-complaint server, must start with 'https://'. | [optional] 
+**oidc_name** | **String** | The name of the OIDC provider. | [optional] 
+**oidc_scope** | **String** | The scope sent to OIDC server during authentication, should be separated by comma. It has to contain “openid”, and “offline_access”. If you are using google, please remove “offline_access” from this field. | [optional] 
+**oidc_verify_cert** | **BOOLEAN** | Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate. | [optional] 
+**project_creation_restriction** | **String** | This attribute restricts what users have the permission to create project.  It can be \"everyone\" or \"adminonly\". | [optional] 
+**quota_per_project_enable** | **BOOLEAN** | This attribute indicates whether quota per project enabled in harbor | [optional] 
+**read_only** | **BOOLEAN** | 'docker push' is prohibited by Harbor if you set it to true.    | [optional] 
+**self_registration** | **BOOLEAN** | Whether the Harbor instance supports self-registration.  If it's set to false, admin need to add user to the instance. | [optional] 
+**storage_per_project** | **String** | The default storage quota for the new created projects. | [optional] 
+**token_expiration** | **Integer** | The expiration time of the token for internal Registry, in minutes. | [optional] 
+**verify_remote_cert** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access a remote Harbor instance for replication. | [optional] 
+**scan_all_policy** | [**ConfigurationsScanAllPolicy**](ConfigurationsScanAllPolicy.md) |  | [optional] 
+
+

data/docs/ConfigurationsResponse.md

@@ -0,0 +1,41 @@
+# Harbor2LegacyClient::ConfigurationsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_mode** | [**StringConfigItem**](StringConfigItem.md) | The auth mode of current system, such as \"db_auth\", \"ldap_auth\" | [optional] 
+**count_per_project** | [**IntegerConfigItem**](IntegerConfigItem.md) | The default count quota for the new created projects. | [optional] 
+**email_from** | [**StringConfigItem**](StringConfigItem.md) | The sender name for Email notification. | [optional] 
+**email_host** | [**StringConfigItem**](StringConfigItem.md) | The hostname of SMTP server that sends Email notification. | [optional] 
+**email_port** | [**IntegerConfigItem**](IntegerConfigItem.md) | The port of SMTP server. | [optional] 
+**email_identity** | [**StringConfigItem**](StringConfigItem.md) | By default it's empty so the email_username is picked. | [optional] 
+**email_username** | [**StringConfigItem**](StringConfigItem.md) | The username for authenticate against SMTP server. | [optional] 
+**email_ssl** | [**BoolConfigItem**](BoolConfigItem.md) | When it's set to true the system will access Email server via TLS by default.  If it's set to false, it still will handle \"STARTTLS\" from server side. | [optional] 
+**email_insecure** | [**BoolConfigItem**](BoolConfigItem.md) | Whether or not the certificate will be verified when Harbor tries to access the email server. | [optional] 
+**ldap_url** | [**StringConfigItem**](StringConfigItem.md) | The URL of LDAP server. | [optional] 
+**ldap_base_dn** | [**StringConfigItem**](StringConfigItem.md) | The Base DN for LDAP binding. | [optional] 
+**ldap_filter** | [**StringConfigItem**](StringConfigItem.md) | The filter for LDAP binding. | [optional] 
+**ldap_scope** | **Integer** | 0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE | [optional] 
+**ldap_uid** | [**StringConfigItem**](StringConfigItem.md) | The attribute which is used as identity for the LDAP binding, such as \"CN\" or \"SAMAccountname\" | [optional] 
+**ldap_search_dn** | **String** | The DN of the user to do the search. | [optional] 
+**ldap_timeout** | [**IntegerConfigItem**](IntegerConfigItem.md) | timeout in seconds for connection to LDAP server. | [optional] 
+**ldap_group_attribute_name** | [**StringConfigItem**](StringConfigItem.md) | The attribute which is used as identity of the LDAP group, default is cn. | [optional] 
+**ldap_group_base_dn** | [**StringConfigItem**](StringConfigItem.md) | The base DN to search LDAP group. | [optional] 
+**ldap_group_search_filter** | [**StringConfigItem**](StringConfigItem.md) | The filter to search the ldap group. | [optional] 
+**ldap_group_search_scope** | [**IntegerConfigItem**](IntegerConfigItem.md) | The scope to search ldap. '0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE' | [optional] 
+**ldap_group_admin_dn** | [**StringConfigItem**](StringConfigItem.md) | Specify the ldap group which have the same privilege with Harbor admin. | [optional] 
+**oidc_client_id** | [**StringConfigItem**](StringConfigItem.md) | The client id of the OIDC. | [optional] 
+**oidc_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The URL of an OIDC-complaint server, must start with 'https://'. | [optional] 
+**oidc_name** | [**StringConfigItem**](StringConfigItem.md) | The name of the OIDC provider. | [optional] 
+**oidc_scope** | [**StringConfigItem**](StringConfigItem.md) | The scope sent to OIDC server during authentication, should be separated by comma. It has to contain “openid”, and “offline_access”. If you are using google, please remove “offline_access” from this field. | [optional] 
+**oidc_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate. | [optional] 
+**project_creation_restriction** | [**StringConfigItem**](StringConfigItem.md) | This attribute restricts what users have the permission to create project.  It can be \"everyone\" or \"adminonly\". | [optional] 
+**quota_per_project_enable** | [**BoolConfigItem**](BoolConfigItem.md) | This attribute indicates whether quota per project enabled in harbor | [optional] 
+**read_only** | [**BoolConfigItem**](BoolConfigItem.md) | 'docker push' is prohibited by Harbor if you set it to true.    | [optional] 
+**self_registration** | [**BoolConfigItem**](BoolConfigItem.md) | Whether the Harbor instance supports self-registration.  If it's set to false, admin need to add user to the instance. | [optional] 
+**storage_per_project** | [**IntegerConfigItem**](IntegerConfigItem.md) | The default storage quota for the new created projects. | [optional] 
+**token_expiration** | [**IntegerConfigItem**](IntegerConfigItem.md) | The expiration time of the token for internal Registry, in minutes. | [optional] 
+**verify_remote_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Whether or not the certificate will be verified when Harbor tries to access a remote Harbor instance for replication. | [optional] 
+**scan_all_policy** | [**ConfigurationsScanAllPolicy**](ConfigurationsScanAllPolicy.md) |  | [optional] 
+
+

data/docs/ConfigurationsScanAllPolicy.md

@@ -0,0 +1,9 @@
+# Harbor2LegacyClient::ConfigurationsScanAllPolicy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of scan all policy, currently the valid values are \"none\" and \"daily\" | [optional] 
+**parameter** | [**ConfigurationsScanAllPolicyParameter**](ConfigurationsScanAllPolicyParameter.md) |  | [optional] 
+
+

data/docs/ConfigurationsScanAllPolicyParameter.md

@@ -0,0 +1,8 @@
+# Harbor2LegacyClient::ConfigurationsScanAllPolicyParameter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**daily_time** | **Integer** | The offset in seconds of UTC 0 o'clock, only valid when the policy type is \"daily\" | [optional] 
+
+

data/docs/ConflictFormatedError.md

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

data/docs/EmailServerSetting.md

@@ -0,0 +1,13 @@
+# Harbor2LegacyClient::EmailServerSetting
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_host** | **String** | The host of email server. | [optional] 
+**email_port** | **Integer** | The port of email server. | [optional] 
+**email_username** | **String** | The username of email server. | [optional] 
+**email_password** | **String** | The password of email server. | [optional] 
+**email_ssl** | **BOOLEAN** | Use ssl/tls or not. | [optional] 
+**email_identity** | **String** | The dentity of email server. | [optional] 
+
+

data/docs/Endpoint.md

@@ -0,0 +1,9 @@
+# Harbor2LegacyClient::Endpoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The URL of OIDC endpoint to be tested. | [optional] 
+**verify_cert** | **BOOLEAN** | Whether the certificate should be verified | [optional] 
+
+

data/docs/EventType.md

@@ -0,0 +1,7 @@
+# Harbor2LegacyClient::EventType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FilterStyle.md

@@ -0,0 +1,10 @@
+# Harbor2LegacyClient::FilterStyle
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The filter type | [optional] 
+**style** | **String** | The filter style | [optional] 
+**values** | **Array<String>** | The filter values | [optional] 
+
+