harbor2_client 0.1.0

data/docs/ProjectDeletable.md

@@ -0,0 +1,9 @@
+# Harbor2Client::ProjectDeletable
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deletable** | **BOOLEAN** | Whether the project can be deleted. | [optional] 
+**message** | **String** | The detail message when the project can not be deleted. | [optional] 
+
+

data/docs/ProjectMetadata.md

@@ -0,0 +1,14 @@
+# Harbor2Client::ProjectMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public** | **String** | The public status of the project. The valid values are \"true\", \"false\". | [optional] 
+**enable_content_trust** | **String** | Whether content trust is enabled or not. If it is enabled, user can't pull unsigned images from this project. The valid values are \"true\", \"false\". | [optional] 
+**prevent_vul** | **String** | Whether prevent the vulnerable images from running. The valid values are \"true\", \"false\". | [optional] 
+**severity** | **String** | If the vulnerability is high than severity defined here, the images can't be pulled. The valid values are \"none\", \"low\", \"medium\", \"high\", \"critical\". | [optional] 
+**auto_scan** | **String** | Whether scan images automatically when pushing. The valid values are \"true\", \"false\". | [optional] 
+**reuse_sys_cve_allowlist** | **String** | Whether this project reuse the system level CVE allowlist as the allowlist of its own.  The valid values are \"true\", \"false\". If it is set to \"true\" the actual allowlist associate with this project, if any, will be ignored. | [optional] 
+**retention_id** | **String** | The ID of the tag retention policy for the project | [optional] 
+
+

data/docs/ProjectReq.md

@@ -0,0 +1,13 @@
+# Harbor2Client::ProjectReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_name** | **String** | The name of the project. | [optional] 
+**public** | **BOOLEAN** | deprecated, reserved for project creation in replication | [optional] 
+**metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 
+**cve_allowlist** | [**CVEAllowlist**](CVEAllowlist.md) | The CVE allowlist of the project. | [optional] 
+**storage_limit** | **Integer** | The storage quota of the project. | [optional] 
+**registry_id** | **Integer** | The ID of referenced registry when creating the proxy cache project | [optional] 
+
+

data/docs/ProjectSummary.md

@@ -0,0 +1,16 @@
+# Harbor2Client::ProjectSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repo_count** | **Integer** | The number of the repositories under this project. | [optional] 
+**chart_count** | **Integer** | The total number of charts under this project. | [optional] 
+**project_admin_count** | **Integer** | The total number of project admin members. | [optional] 
+**maintainer_count** | **Integer** | The total number of maintainer members. | [optional] 
+**developer_count** | **Integer** | The total number of developer members. | [optional] 
+**guest_count** | **Integer** | The total number of guest members. | [optional] 
+**limited_guest_count** | **Integer** | The total number of limited guest members. | [optional] 
+**quota** | [**ProjectSummaryQuota**](ProjectSummaryQuota.md) |  | [optional] 
+**registry** | [**Registry**](Registry.md) |  | [optional] 
+
+

data/docs/ProjectSummaryQuota.md

@@ -0,0 +1,9 @@
+# Harbor2Client::ProjectSummaryQuota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional] 
+**used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional] 
+
+

data/docs/ProviderUnderProject.md

@@ -0,0 +1,11 @@
+# Harbor2Client::ProviderUnderProject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**provider** | **String** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**default** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Reference.md

@@ -0,0 +1,13 @@
+# Harbor2Client::Reference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_id** | **Integer** | The parent ID of the reference | [optional] 
+**child_id** | **Integer** | The child ID of the reference | [optional] 
+**child_digest** | **String** | The digest of the child artifact | [optional] 
+**platform** | [**Platform**](Platform.md) |  | [optional] 
+**annotations** | [**Annotations**](Annotations.md) |  | [optional] 
+**urls** | **Array<String>** | The download URLs | [optional] 
+
+

data/docs/Registry.md

@@ -0,0 +1,17 @@
+# Harbor2Client::Registry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The registry ID. | [optional] 
+**url** | **String** | The registry URL string. | [optional] 
+**name** | **String** | The registry name. | [optional] 
+**credential** | [**RegistryCredential**](RegistryCredential.md) |  | [optional] 
+**type** | **String** | Type of the registry, e.g. 'harbor'. | [optional] 
+**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] 
+
+

data/docs/RegistryCredential.md

@@ -0,0 +1,10 @@
+# Harbor2Client::RegistryCredential
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Credential type, such as 'basic', 'oauth'. | [optional] 
+**access_key** | **String** | Access key, e.g. user name when credential type is 'basic'. | [optional] 
+**access_secret** | **String** | Access secret, e.g. password when credential type is 'basic'. | [optional] 
+
+

data/docs/Repository.md

@@ -0,0 +1,15 @@
+# Harbor2Client::Repository
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the repository | [optional] 
+**project_id** | **Integer** | The ID of the project that the repository belongs to | [optional] 
+**name** | **String** | The name of the repository | [optional] 
+**description** | **String** | The description of the repository | [optional] 
+**artifact_count** | **Integer** | The count of the artifacts inside the repository | [optional] 
+**pull_count** | **Integer** | The count that the artifact inside the repository pulled | [optional] 
+**creation_time** | **DateTime** | The creation time of the repository | [optional] 
+**update_time** | **DateTime** | The update time of the repository | [optional] 
+
+

data/docs/RepositoryApi.md

@@ -0,0 +1,256 @@
+# Harbor2Client::RepositoryApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_repository**](RepositoryApi.md#delete_repository) | **DELETE** /projects/{project_name}/repositories/{repository_name} | Delete repository
+[**get_repository**](RepositoryApi.md#get_repository) | **GET** /projects/{project_name}/repositories/{repository_name} | Get repository
+[**list_repositories**](RepositoryApi.md#list_repositories) | **GET** /projects/{project_name}/repositories | List repositories
+[**update_repository**](RepositoryApi.md#update_repository) | **PUT** /projects/{project_name}/repositories/{repository_name} | Update repository
+
+
+# **delete_repository**
+> delete_repository(project_namerepository_name, , opts)
+
+Delete repository
+
+Delete the repository specified by name
+
+### 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::RepositoryApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete repository
+  api_instance.delete_repository(project_namerepository_name, , opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling RepositoryApi->delete_repository: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **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
+
+
+
+# **get_repository**
+> Repository get_repository(project_namerepository_name, , opts)
+
+Get repository
+
+Get the repository specified by name
+
+### 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::RepositoryApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get repository
+  result = api_instance.get_repository(project_namerepository_name, , opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling RepositoryApi->get_repository: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Repository**](Repository.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_repositories**
+> Array<Repository> list_repositories(project_name, opts)
+
+List repositories
+
+List repositories of the specified 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::RepositoryApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  q: 'q_example' # String | Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+}
+
+begin
+  #List repositories
+  result = api_instance.list_repositories(project_name, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling RepositoryApi->list_repositories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **q** | **String**| Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max] | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+
+### Return type
+
+[**Array<Repository>**](Repository.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_repository**
+> update_repository(project_namerepository_name, repository, opts)
+
+Update repository
+
+Update the repository specified by name
+
+### 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::RepositoryApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+repository = Harbor2Client::Repository.new # Repository | The JSON object of repository.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update repository
+  api_instance.update_repository(project_namerepository_name, repository, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling RepositoryApi->update_repository: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **repository** | [**Repository**](Repository.md)| The JSON object of repository. | 
+ **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/ResourceList.md

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

data/docs/ScanApi.md

@@ -0,0 +1,138 @@
+# Harbor2Client::ScanApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_report_log**](ScanApi.md#get_report_log) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/log | Get the log of the scan report
+[**scan_artifact**](ScanApi.md#scan_artifact) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan | Scan the artifact
+
+
+# **get_report_log**
+> String get_report_log(project_namerepository_name, reference, report_id, opts)
+
+Get the log of the scan report
+
+Get the log of the scan report
+
+### 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::ScanApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
+
+report_id = 'report_id_example' # String | The report id to get the log
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the log of the scan report
+  result = api_instance.get_report_log(project_namerepository_name, reference, report_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanApi->get_report_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **reference** | **String**| The reference of the artifact, can be digest or tag | 
+ **report_id** | **String**| The report id to get the log | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+
+# **scan_artifact**
+> scan_artifact(project_namerepository_name, reference, , opts)
+
+Scan the artifact
+
+Scan the specified artifact
+
+### 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::ScanApi.new
+
+project_name = 'project_name_example' # String | The name of the project
+
+repository_name = 'repository_name_example' # String | The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+
+reference = 'reference_example' # String | The reference of the artifact, can be digest or tag
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Scan the artifact
+  api_instance.scan_artifact(project_namerepository_name, reference, , opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ScanApi->scan_artifact: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name** | **String**| The name of the project | 
+ **repository_name** | **String**| The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb | 
+ **reference** | **String**| The reference of the artifact, can be digest or tag | 
+ **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
+
+
+