harbor2_legacy_client 0.2.1 → 2.3.3.0

data/docs/SystemApi.md

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

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

data/docs/TriggerSettings.md

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

data/docs/User.md

@@ -1,22 +0,0 @@
-# Harbor2LegacyClient::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] 
-**sysadmin_flag** | **BOOLEAN** |  | [optional] 
-**admin_role_in_auth** | **BOOLEAN** | indicate the admin privilege is grant by authenticator (LDAP), is always false unless it is the current login user | [optional] 
-**reset_uuid** | **String** |  | [optional] 
-**salt** | **String** |  | [optional] 
-**creation_time** | **String** |  | [optional] 
-**update_time** | **String** |  | [optional] 
-
-

data/docs/UserEntity.md

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

data/docs/UserGroup.md

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

@@ -1,10 +0,0 @@
-# Harbor2LegacyClient::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/docs/UserSearch.md

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

data/docs/WebhookJob.md

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

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

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

data/docs/WebhookTargetObject.md

@@ -1,11 +0,0 @@
-# Harbor2LegacyClient::WebhookTargetObject
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | The webhook target notify type. | [optional] 
-**address** | **String** | The webhook target address. | [optional] 
-**auth_header** | **String** | The webhook auth header. | [optional] 
-**skip_cert_verify** | **BOOLEAN** | Whether or not to skip cert verify. | [optional] 
-
-

data/lib/harbor2_legacy_client/api/quota_api.rb

@@ -1,136 +0,0 @@
-=begin
-#Harbor API
-
-#These APIs provide services for manipulating Harbor project.
-
-OpenAPI spec version: 2.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.17
-
-=end
-
-require 'uri'
-
-module Harbor2LegacyClient
-  class QuotaApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get the specified quota
-    # Get the specified quota
-    # @param id Quota ID
-    # @param [Hash] opts the optional parameters
-    # @return [Quota]
-    def quotas_id_get(id, opts = {})
-      data, _status_code, _headers = quotas_id_get_with_http_info(id, opts)
-      data
-    end
-
-    # Get the specified quota
-    # Get the specified quota
-    # @param id Quota ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Quota, Fixnum, Hash)>] Quota data, response status code and response headers
-    def quotas_id_get_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: QuotaApi.quotas_id_get ...'
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling QuotaApi.quotas_id_get"
-      end
-      # resource path
-      local_var_path = '/quotas/{id}'.sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Quota')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: QuotaApi#quotas_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Update the specified quota
-    # Update hard limits of the specified quota
-    # @param id Quota ID
-    # @param hard The new hard limits for the quota
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def quotas_id_put(id, hard, opts = {})
-      quotas_id_put_with_http_info(id, hard, opts)
-      nil
-    end
-
-    # Update the specified quota
-    # Update hard limits of the specified quota
-    # @param id Quota ID
-    # @param hard The new hard limits for the quota
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def quotas_id_put_with_http_info(id, hard, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: QuotaApi.quotas_id_put ...'
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling QuotaApi.quotas_id_put"
-      end
-      # verify the required parameter 'hard' is set
-      if @api_client.config.client_side_validation && hard.nil?
-        fail ArgumentError, "Missing the required parameter 'hard' when calling QuotaApi.quotas_id_put"
-      end
-      # resource path
-      local_var_path = '/quotas/{id}'.sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(hard)
-      auth_names = ['basicAuth']
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: QuotaApi#quotas_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end