harbor2_client 0.2.0 → 2.3.3.0

data/docs/Body1.md

@@ -0,0 +1,8 @@
+# Harbor2Client::Body1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** |  | [optional] 
+
+

data/docs/BoolConfigItem.md

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

data/docs/ChartMetadata.md

@@ -0,0 +1,18 @@
+# Harbor2Client::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/ChartVersion.md

@@ -0,0 +1,23 @@
+# Harbor2Client::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** | [**Array<Label>**](Label.md) | A list of label | [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 @@
+# Harbor2Client::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/Configurations.md

@@ -0,0 +1,62 @@
+# Harbor2Client::Configurations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_mode** | **String** | The auth mode of current system, such as \"db_auth\", \"ldap_auth\", \"oidc_auth\" | [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_identity** | **String** | By default it's empty so the email_username is picked | [optional] 
+**email_insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the email server. | [optional] 
+**email_password** | **String** | Email password | [optional] 
+**email_port** | **Integer** | The port of 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_username** | **String** | The username for authenticate against SMTP server | [optional] 
+**ldap_base_dn** | **String** | The Base DN for LDAP binding. | [optional] 
+**ldap_filter** | **String** | The filter for LDAP search | [optional] 
+**ldap_group_base_dn** | **String** | The base DN to search LDAP group. | [optional] 
+**ldap_group_admin_dn** | **String** | Specify the ldap group which have the same privilege with Harbor admin | [optional] 
+**ldap_group_attribute_name** | **String** | The attribute which is used as identity of the LDAP group, default is cn.' | [optional] 
+**ldap_group_search_filter** | **String** | The filter to search the ldap group | [optional] 
+**ldap_group_search_scope** | **Integer** | The scope to search ldap group. ''0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE'' | [optional] 
+**ldap_scope** | **Integer** | The scope to search ldap users,'0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE' | [optional] 
+**ldap_search_dn** | **String** | The DN of the user to do the search. | [optional] 
+**ldap_search_password** | **String** | The password of the ldap search dn | [optional] 
+**ldap_timeout** | **Integer** | Timeout in seconds for connection to LDAP server | [optional] 
+**ldap_uid** | **String** | The attribute which is used as identity for the LDAP binding, such as \"CN\" or \"SAMAccountname\" | [optional] 
+**ldap_url** | **String** | The URL of LDAP server | [optional] 
+**ldap_verify_cert** | **BOOLEAN** | Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate. | [optional] 
+**ldap_group_membership_attribute** | **String** | The user attribute to identify the group membership | [optional] 
+**project_creation_restriction** | **String** | Indicate who can create projects, it could be ''adminonly'' or ''everyone''. | [optional] 
+**read_only** | **BOOLEAN** | The flag to indicate whether Harbor is in readonly mode. | [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] 
+**token_expiration** | **Integer** | The expiration time of the token for internal Registry, in minutes. | [optional] 
+**uaa_client_id** | **String** | The client id of UAA | [optional] 
+**uaa_client_secret** | **String** | The client secret of the UAA | [optional] 
+**uaa_endpoint** | **String** | The endpoint of the UAA | [optional] 
+**uaa_verify_cert** | **BOOLEAN** | Verify the certificate in UAA server | [optional] 
+**http_authproxy_endpoint** | **String** | The endpoint of the HTTP auth | [optional] 
+**http_authproxy_tokenreview_endpoint** | **String** | The token review endpoint | [optional] 
+**http_authproxy_admin_groups** | **String** | The group which has the harbor admin privileges | [optional] 
+**http_authproxy_admin_usernames** | **String** | The username which has the harbor admin privileges | [optional] 
+**http_authproxy_verify_cert** | **BOOLEAN** | Verify the HTTP auth provider's certificate | [optional] 
+**http_authproxy_skip_search** | **BOOLEAN** | Search user before onboard | [optional] 
+**http_authproxy_server_certificate** | **String** | The certificate of the HTTP auth provider | [optional] 
+**oidc_name** | **String** | The OIDC provider name | [optional] 
+**oidc_endpoint** | **String** | The endpoint of the OIDC provider | [optional] 
+**oidc_client_id** | **String** | The client ID of the OIDC provider | [optional] 
+**oidc_client_secret** | **String** | The OIDC provider secret | [optional] 
+**oidc_groups_claim** | **String** | The attribute claims the group name | [optional] 
+**oidc_admin_group** | **String** | The OIDC group which has the harbor admin privileges | [optional] 
+**oidc_scope** | **String** | The scope of the OIDC provider | [optional] 
+**oidc_user_claim** | **String** | The attribute claims the username | [optional] 
+**oidc_verify_cert** | **BOOLEAN** | Verify the OIDC provider's certificate' | [optional] 
+**oidc_auto_onboard** | **BOOLEAN** | Auto onboard the OIDC user | [optional] 
+**oidc_extra_redirect_parms** | **String** | Extra parameters to add when redirect request to OIDC provider | [optional] 
+**robot_token_duration** | **Integer** | The robot account token duration in days | [optional] 
+**robot_name_prefix** | **String** | The rebot account name prefix | [optional] 
+**notification_enable** | **BOOLEAN** | Enable notification | [optional] 
+**quota_per_project_enable** | **BOOLEAN** | Enable quota per project | [optional] 
+**storage_per_project** | **Integer** | The storage quota per project | [optional] 
+
+

data/docs/ConfigurationsResponse.md

@@ -0,0 +1,60 @@
+# Harbor2Client::ConfigurationsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_mode** | [**StringConfigItem**](StringConfigItem.md) | The auth mode of current system, such as \"db_auth\", \"ldap_auth\", \"oidc_auth\" | [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_identity** | [**StringConfigItem**](StringConfigItem.md) | By default it's empty so the email_username is picked | [optional] 
+**email_insecure** | [**BoolConfigItem**](BoolConfigItem.md) | Whether or not the certificate will be verified when Harbor tries to access the email server. | [optional] 
+**email_port** | [**IntegerConfigItem**](IntegerConfigItem.md) | The port of 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_username** | [**StringConfigItem**](StringConfigItem.md) | The username for authenticate against SMTP server | [optional] 
+**ldap_base_dn** | [**StringConfigItem**](StringConfigItem.md) | The Base DN for LDAP binding. | [optional] 
+**ldap_filter** | [**StringConfigItem**](StringConfigItem.md) | The filter for LDAP search | [optional] 
+**ldap_group_base_dn** | [**StringConfigItem**](StringConfigItem.md) | The base DN to search LDAP group. | [optional] 
+**ldap_group_admin_dn** | [**StringConfigItem**](StringConfigItem.md) | Specify the ldap group which have the same privilege with Harbor admin | [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_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 group. ''0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE'' | [optional] 
+**ldap_scope** | [**IntegerConfigItem**](IntegerConfigItem.md) | The scope to search ldap users,'0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE' | [optional] 
+**ldap_search_dn** | [**StringConfigItem**](StringConfigItem.md) | 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_uid** | [**StringConfigItem**](StringConfigItem.md) | The attribute which is used as identity for the LDAP binding, such as \"CN\" or \"SAMAccountname\" | [optional] 
+**ldap_url** | [**StringConfigItem**](StringConfigItem.md) | The URL of LDAP server | [optional] 
+**ldap_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate. | [optional] 
+**ldap_group_membership_attribute** | [**StringConfigItem**](StringConfigItem.md) | The user attribute to identify the group membership | [optional] 
+**project_creation_restriction** | [**StringConfigItem**](StringConfigItem.md) | Indicate who can create projects, it could be ''adminonly'' or ''everyone''. | [optional] 
+**read_only** | [**BoolConfigItem**](BoolConfigItem.md) | The flag to indicate whether Harbor is in readonly mode. | [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] 
+**token_expiration** | [**IntegerConfigItem**](IntegerConfigItem.md) | The expiration time of the token for internal Registry, in minutes. | [optional] 
+**uaa_client_id** | [**StringConfigItem**](StringConfigItem.md) | The client id of UAA | [optional] 
+**uaa_client_secret** | [**StringConfigItem**](StringConfigItem.md) | The client secret of the UAA | [optional] 
+**uaa_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The endpoint of the UAA | [optional] 
+**uaa_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Verify the certificate in UAA server | [optional] 
+**http_authproxy_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The endpoint of the HTTP auth | [optional] 
+**http_authproxy_tokenreview_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The token review endpoint | [optional] 
+**http_authproxy_admin_groups** | [**StringConfigItem**](StringConfigItem.md) | The group which has the harbor admin privileges | [optional] 
+**http_authproxy_admin_usernames** | [**StringConfigItem**](StringConfigItem.md) | The usernames which has the harbor admin privileges | [optional] 
+**http_authproxy_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Verify the HTTP auth provider's certificate | [optional] 
+**http_authproxy_skip_search** | [**BoolConfigItem**](BoolConfigItem.md) | Search user before onboard | [optional] 
+**http_authproxy_server_certificate** | [**StringConfigItem**](StringConfigItem.md) | The certificate of the HTTP auth provider | [optional] 
+**oidc_name** | [**StringConfigItem**](StringConfigItem.md) | The OIDC provider name | [optional] 
+**oidc_endpoint** | [**StringConfigItem**](StringConfigItem.md) | The endpoint of the OIDC provider | [optional] 
+**oidc_client_id** | [**StringConfigItem**](StringConfigItem.md) | The client ID of the OIDC provider | [optional] 
+**oidc_groups_claim** | [**StringConfigItem**](StringConfigItem.md) | The attribute claims the group name | [optional] 
+**oidc_admin_group** | [**StringConfigItem**](StringConfigItem.md) | The OIDC group which has the harbor admin privileges | [optional] 
+**oidc_scope** | [**StringConfigItem**](StringConfigItem.md) | The scope of the OIDC provider | [optional] 
+**oidc_user_claim** | [**StringConfigItem**](StringConfigItem.md) | The attribute claims the username | [optional] 
+**oidc_verify_cert** | [**BoolConfigItem**](BoolConfigItem.md) | Verify the OIDC provider's certificate' | [optional] 
+**oidc_auto_onboard** | [**BoolConfigItem**](BoolConfigItem.md) | Auto onboard the OIDC user | [optional] 
+**oidc_extra_redirect_parms** | [**StringConfigItem**](StringConfigItem.md) | Extra parameters to add when redirect request to OIDC provider | [optional] 
+**robot_token_duration** | [**IntegerConfigItem**](IntegerConfigItem.md) | The robot account token duration in days | [optional] 
+**robot_name_prefix** | [**StringConfigItem**](StringConfigItem.md) | The rebot account name prefix | [optional] 
+**notification_enable** | [**BoolConfigItem**](BoolConfigItem.md) | Enable notification | [optional] 
+**quota_per_project_enable** | [**BoolConfigItem**](BoolConfigItem.md) | Enable quota per project | [optional] 
+**storage_per_project** | [**IntegerConfigItem**](IntegerConfigItem.md) | The storage quota per project | [optional] 
+**scan_all_policy** | [**ConfigurationsResponseScanAllPolicy**](ConfigurationsResponseScanAllPolicy.md) |  | [optional] 
+
+

data/docs/ConfigurationsResponseScanAllPolicy.md

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

data/docs/ConfigurationsResponseScanAllPolicyParameter.md

@@ -0,0 +1,8 @@
+# Harbor2Client::ConfigurationsResponseScanAllPolicyParameter
+
+## 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/ConfigureApi.md

@@ -0,0 +1,175 @@
+# Harbor2Client::ConfigureApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_configurations**](ConfigureApi.md#get_configurations) | **GET** /configurations | Get system configurations.
+[**get_internalconfig**](ConfigureApi.md#get_internalconfig) | **GET** /internalconfig | Get internal configurations.
+[**update_configurations**](ConfigureApi.md#update_configurations) | **PUT** /configurations | Modify system configurations.
+
+
+# **get_configurations**
+> ConfigurationsResponse get_configurations(opts)
+
+Get system configurations.
+
+This endpoint is for retrieving system configurations that only provides for admin user. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::ConfigureApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get system configurations.
+  result = api_instance.get_configurations(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ConfigureApi->get_configurations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**ConfigurationsResponse**](ConfigurationsResponse.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_internalconfig**
+> InternalConfigurationsResponse get_internalconfig(opts)
+
+Get internal configurations.
+
+This endpoint is for retrieving system configurations that only provides for internal api call. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::ConfigureApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get internal configurations.
+  result = api_instance.get_internalconfig(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ConfigureApi->get_internalconfig: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**InternalConfigurationsResponse**](InternalConfigurationsResponse.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_configurations**
+> update_configurations(configurations, opts)
+
+Modify system configurations.
+
+This endpoint is for modifying system configurations that only provides for admin user. 
+
+### Example
+```ruby
+# load the gem
+require 'harbor2_client'
+# setup authorization
+Harbor2Client.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Harbor2Client::ConfigureApi.new
+
+configurations = Harbor2Client::Configurations.new # Configurations | The configuration map can contain a subset of the attributes of the schema, which are to be updated.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Modify system configurations.
+  api_instance.update_configurations(configurations, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ConfigureApi->update_configurations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **configurations** | [**Configurations**](Configurations.md)| The configuration map can contain a subset of the attributes of the schema, which are to be updated. | 
+ **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/Endpoint.md

@@ -0,0 +1,9 @@
+# Harbor2Client::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 @@
+# Harbor2Client::EventType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FilterStyle.md

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

data/docs/GCHistory.md

@@ -0,0 +1,16 @@
+# Harbor2Client::GCHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | the id of gc job. | [optional] 
+**job_name** | **String** | the job name of gc job. | [optional] 
+**job_kind** | **String** | the job kind of gc job. | [optional] 
+**job_parameters** | **String** | the job parameters of gc job. | [optional] 
+**schedule** | [**ScheduleObj**](ScheduleObj.md) |  | [optional] 
+**job_status** | **String** | the status of gc job. | [optional] 
+**deleted** | **BOOLEAN** | if gc job was deleted. | [optional] 
+**creation_time** | **DateTime** | the creation time of gc job. | [optional] 
+**update_time** | **DateTime** | the update time of gc job. | [optional] 
+
+