harbor2_client 0.2.0 → 2.3.3.0

data/docs/ProjectMetadataApi.md

@@ -0,0 +1,318 @@
+# Harbor2Client::ProjectMetadataApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_project_metadatas**](ProjectMetadataApi.md#add_project_metadatas) | **POST** /projects/{project_name_or_id}/metadatas/ | Add metadata for the specific project
+[**delete_project_metadata**](ProjectMetadataApi.md#delete_project_metadata) | **DELETE** /projects/{project_name_or_id}/metadatas/{meta_name} | Delete the specific metadata for the specific project
+[**get_project_metadata**](ProjectMetadataApi.md#get_project_metadata) | **GET** /projects/{project_name_or_id}/metadatas/{meta_name} | Get the specific metadata of the specific project
+[**list_project_metadatas**](ProjectMetadataApi.md#list_project_metadatas) | **GET** /projects/{project_name_or_id}/metadatas/ | Get the metadata of the specific project
+[**update_project_metadata**](ProjectMetadataApi.md#update_project_metadata) | **PUT** /projects/{project_name_or_id}/metadatas/{meta_name} | Update the specific metadata for the specific project
+
+
+# **add_project_metadatas**
+> add_project_metadatas(project_name_or_id, opts)
+
+Add metadata for the specific project
+
+Add metadata for the specific project
+
+### 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::ProjectMetadataApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  metadata: nil # Object | 
+}
+
+begin
+  #Add metadata for the specific project
+  api_instance.add_project_metadatas(project_name_or_id, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectMetadataApi->add_project_metadatas: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+ **metadata** | **Object**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_project_metadata**
+> delete_project_metadata(project_name_or_idmeta_name, opts)
+
+Delete the specific metadata for the specific project
+
+Delete the specific metadata for the specific project
+
+### 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::ProjectMetadataApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+meta_name = 'meta_name_example' # String | The name of metadata.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Delete the specific metadata for the specific project
+  api_instance.delete_project_metadata(project_name_or_idmeta_name, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectMetadataApi->delete_project_metadata: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **meta_name** | **String**| The name of metadata. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_project_metadata**
+> Hash<String, String> get_project_metadata(project_name_or_idmeta_name, opts)
+
+Get the specific metadata of the specific project
+
+Get the specific metadata of the specific project
+
+### 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::ProjectMetadataApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+meta_name = 'meta_name_example' # String | The name of metadata.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Get the specific metadata of the specific project
+  result = api_instance.get_project_metadata(project_name_or_idmeta_name, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectMetadataApi->get_project_metadata: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **meta_name** | **String**| The name of metadata. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+**Hash<String, String>**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_project_metadatas**
+> Hash<String, String> list_project_metadatas(project_name_or_id, opts)
+
+Get the metadata of the specific project
+
+Get the metadata of the specific project
+
+### 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::ProjectMetadataApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Get the metadata of the specific project
+  result = api_instance.list_project_metadatas(project_name_or_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectMetadataApi->list_project_metadatas: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+**Hash<String, String>**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_project_metadata**
+> update_project_metadata(project_name_or_idmeta_name, opts)
+
+Update the specific metadata for the specific project
+
+Update the specific metadata for the specific project
+
+### 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::ProjectMetadataApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+meta_name = 'meta_name_example' # String | The name of metadata.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  metadata: nil # Object | 
+}
+
+begin
+  #Update the specific metadata for the specific project
+  api_instance.update_project_metadata(project_name_or_idmeta_name, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectMetadataApi->update_project_metadata: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **meta_name** | **String**| The name of metadata. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+ **metadata** | **Object**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ProjectScanner.md

@@ -0,0 +1,8 @@
+# Harbor2Client::ProjectScanner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | The identifier of the scanner registration | 
+
+

data/docs/Quota.md

@@ -0,0 +1,13 @@
+# Harbor2Client::Quota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the quota | [optional] 
+**ref** | [**QuotaRefObject**](QuotaRefObject.md) | The reference object of the quota | [optional] 
+**hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional] 
+**used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional] 
+**creation_time** | **DateTime** | the creation time of the quota | [optional] 
+**update_time** | **DateTime** | the update time of the quota | [optional] 
+
+

data/docs/QuotaApi.md

@@ -0,0 +1,191 @@
+# Harbor2Client::QuotaApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_quota**](QuotaApi.md#get_quota) | **GET** /quotas/{id} | Get the specified quota
+[**list_quotas**](QuotaApi.md#list_quotas) | **GET** /quotas | List quotas
+[**update_quota**](QuotaApi.md#update_quota) | **PUT** /quotas/{id} | Update the specified quota
+
+
+# **get_quota**
+> Quota get_quota(id, opts)
+
+Get the specified quota
+
+Get the specified quota
+
+### 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::QuotaApi.new
+
+id = 56 # Integer | Quota ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the specified quota
+  result = api_instance.get_quota(id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling QuotaApi->get_quota: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Quota ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Quota**](Quota.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_quotas**
+> Array<Quota> list_quotas(opts)
+
+List quotas
+
+List quotas
+
+### 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::QuotaApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  reference: 'reference_example', # String | The reference type of quota.
+  reference_id: 'reference_id_example', # String | The reference id of quota.
+  sort: 'sort_example' # String | Sort method, valid values include: 'hard.resource_name', '-hard.resource_name', 'used.resource_name', '-used.resource_name'. Here '-' stands for descending order, resource_name should be the real resource name of the quota. 
+}
+
+begin
+  #List quotas
+  result = api_instance.list_quotas(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling QuotaApi->list_quotas: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **reference** | **String**| The reference type of quota. | [optional] 
+ **reference_id** | **String**| The reference id of quota. | [optional] 
+ **sort** | **String**| Sort method, valid values include: 'hard.resource_name', '-hard.resource_name', 'used.resource_name', '-used.resource_name'. Here '-' stands for descending order, resource_name should be the real resource name of the quota.  | [optional] 
+
+### Return type
+
+[**Array<Quota>**](Quota.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_quota**
+> update_quota(id, hard, opts)
+
+Update the specified quota
+
+Update hard limits of the specified quota
+
+### 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::QuotaApi.new
+
+id = 56 # Integer | Quota ID
+
+hard = Harbor2Client::QuotaUpdateReq.new # QuotaUpdateReq | The new hard limits for the quota
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update the specified quota
+  api_instance.update_quota(id, hard, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling QuotaApi->update_quota: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Quota ID | 
+ **hard** | [**QuotaUpdateReq**](QuotaUpdateReq.md)| The new hard limits for the quota | 
+ **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/QuotaRefObject.md

@@ -0,0 +1,7 @@
+# Harbor2Client::QuotaRefObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/QuotaUpdateReq.md

@@ -0,0 +1,8 @@
+# Harbor2Client::QuotaUpdateReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hard** | [**ResourceList**](ResourceList.md) | The new hard limits for the quota | [optional] 
+
+

data/docs/Registry.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the server. | [optional] 
 **description** | **String** | Description of the registry. | [optional] 
 **status** | **String** | Health status of the registry. | [optional] 
-**creation_time** | **String** | The create time of the policy. | [optional] 
-**update_time** | **String** | The update time of the policy. | [optional] 
+**creation_time** | **DateTime** | The create time of the policy. | [optional] 
+**update_time** | **DateTime** | The update time of the policy. | [optional]