harbor2_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06c1b271fcc751ff934f87903ed25fa951bf33c55021049775eca50cf0c04aa2
+  data.tar.gz: 347fcaa8d68ba804c2361afc1ec4fc88714142a0eedad6cf185199fc760c6c5c
+SHA512:
+  metadata.gz: 5eacb7c454270d4dd637d129c51b3689d623e7748c152eebc80c584790113c7a32268de5e601e49aeb075c2dea92046cd650d2214e336c3ad2dd480857e9ea2c
+  data.tar.gz: eafd8a0fbb9325ec7a51c50daa3ac71677114bbbc120d5d17800be071b5ea5b292732a9423915ae42cfcbe7795fc6038188be7f12d6cfc94749ed8e595bd895c

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,186 @@
+# harbor2_client
+
+Harbor2Client - the Ruby gem for the [Harbor 2 API](https://github.com/goharbor/harbor/blob/master/api/v2.0/swagger.yaml).
+
+These APIs provide services for manipulating Harbor projects.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 2.0
+- Package version: 0.1.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build harbor2_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./harbor2_client-0.1.0.gem
+```
+(for development, run `gem install --dev ./harbor2_client-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'harbor2_client', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
+
+    gem 'harbor2_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```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::ArtifactApi.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
+
+label = Harbor2Client::Label.new # Label | The label that added to the artifact. Only the ID property is needed.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Add label to artifact
+  api_instance.add_label(project_namerepository_name, reference, label, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->add_label: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Harbor2Client::ArtifactApi* | [**add_label**](docs/ArtifactApi.md#add_label) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels | Add label to artifact
+*Harbor2Client::ArtifactApi* | [**copy_artifact**](docs/ArtifactApi.md#copy_artifact) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts | Copy artifact
+*Harbor2Client::ArtifactApi* | [**create_tag**](docs/ArtifactApi.md#create_tag) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags | Create tag
+*Harbor2Client::ArtifactApi* | [**delete_artifact**](docs/ArtifactApi.md#delete_artifact) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference} | Delete the specific artifact
+*Harbor2Client::ArtifactApi* | [**delete_tag**](docs/ArtifactApi.md#delete_tag) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags/{tag_name} | Delete tag
+*Harbor2Client::ArtifactApi* | [**get_addition**](docs/ArtifactApi.md#get_addition) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/{addition} | Get the addition of the specific artifact
+*Harbor2Client::ArtifactApi* | [**get_artifact**](docs/ArtifactApi.md#get_artifact) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference} | Get the specific artifact
+*Harbor2Client::ArtifactApi* | [**list_artifacts**](docs/ArtifactApi.md#list_artifacts) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts | List artifacts
+*Harbor2Client::ArtifactApi* | [**list_tags**](docs/ArtifactApi.md#list_tags) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags | List tags
+*Harbor2Client::ArtifactApi* | [**remove_label**](docs/ArtifactApi.md#remove_label) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels/{label_id} | Remove label from artifact
+*Harbor2Client::AuditlogApi* | [**list_audit_logs**](docs/AuditlogApi.md#list_audit_logs) | **GET** /audit-logs | Get recent logs of the projects which the user is a member of
+*Harbor2Client::IconApi* | [**get_icon**](docs/IconApi.md#get_icon) | **GET** /icons/{digest} | Get artifact icon
+*Harbor2Client::PreheatApi* | [**create_instance**](docs/PreheatApi.md#create_instance) | **POST** /p2p/preheat/instances | Create p2p provider instances
+*Harbor2Client::PreheatApi* | [**create_policy**](docs/PreheatApi.md#create_policy) | **POST** /projects/{project_name}/preheat/policies | Create a preheat policy under a project
+*Harbor2Client::PreheatApi* | [**delete_instance**](docs/PreheatApi.md#delete_instance) | **DELETE** /p2p/preheat/instances/{preheat_instance_name} | Delete the specified P2P provider instance
+*Harbor2Client::PreheatApi* | [**delete_policy**](docs/PreheatApi.md#delete_policy) | **DELETE** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Delete a preheat policy
+*Harbor2Client::PreheatApi* | [**get_execution**](docs/PreheatApi.md#get_execution) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id} | Get a execution detail by id
+*Harbor2Client::PreheatApi* | [**get_instance**](docs/PreheatApi.md#get_instance) | **GET** /p2p/preheat/instances/{preheat_instance_name} | Get a P2P provider instance
+*Harbor2Client::PreheatApi* | [**get_policy**](docs/PreheatApi.md#get_policy) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Get a preheat policy
+*Harbor2Client::PreheatApi* | [**get_preheat_log**](docs/PreheatApi.md#get_preheat_log) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks/{task_id}/logs | Get the log text stream of the specified task for the given execution
+*Harbor2Client::PreheatApi* | [**list_executions**](docs/PreheatApi.md#list_executions) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions | List executions for the given policy
+*Harbor2Client::PreheatApi* | [**list_instances**](docs/PreheatApi.md#list_instances) | **GET** /p2p/preheat/instances | List P2P provider instances
+*Harbor2Client::PreheatApi* | [**list_policies**](docs/PreheatApi.md#list_policies) | **GET** /projects/{project_name}/preheat/policies | List preheat policies
+*Harbor2Client::PreheatApi* | [**list_providers**](docs/PreheatApi.md#list_providers) | **GET** /p2p/preheat/providers | List P2P providers
+*Harbor2Client::PreheatApi* | [**list_providers_under_project**](docs/PreheatApi.md#list_providers_under_project) | **GET** /projects/{project_name}/preheat/providers | Get all providers at project level
+*Harbor2Client::PreheatApi* | [**list_tasks**](docs/PreheatApi.md#list_tasks) | **GET** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id}/tasks | List all the related tasks for the given execution
+*Harbor2Client::PreheatApi* | [**manual_preheat**](docs/PreheatApi.md#manual_preheat) | **POST** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Manual preheat
+*Harbor2Client::PreheatApi* | [**ping_instances**](docs/PreheatApi.md#ping_instances) | **POST** /p2p/preheat/instances/ping | Ping status of a instance.
+*Harbor2Client::PreheatApi* | [**stop_execution**](docs/PreheatApi.md#stop_execution) | **PATCH** /projects/{project_name}/preheat/policies/{preheat_policy_name}/executions/{execution_id} | Stop a execution
+*Harbor2Client::PreheatApi* | [**update_instance**](docs/PreheatApi.md#update_instance) | **PUT** /p2p/preheat/instances/{preheat_instance_name} | Update the specified P2P provider instance
+*Harbor2Client::PreheatApi* | [**update_policy**](docs/PreheatApi.md#update_policy) | **PUT** /projects/{project_name}/preheat/policies/{preheat_policy_name} | Update preheat policy
+*Harbor2Client::ProjectApi* | [**create_project**](docs/ProjectApi.md#create_project) | **POST** /projects | Create a new project.
+*Harbor2Client::ProjectApi* | [**delete_project**](docs/ProjectApi.md#delete_project) | **DELETE** /projects/{project_id} | Delete project by projectID
+*Harbor2Client::ProjectApi* | [**get_logs**](docs/ProjectApi.md#get_logs) | **GET** /projects/{project_name}/logs | Get recent logs of the projects
+*Harbor2Client::ProjectApi* | [**get_project**](docs/ProjectApi.md#get_project) | **GET** /projects/{project_id} | Return specific project detail information
+*Harbor2Client::ProjectApi* | [**get_project_deletable**](docs/ProjectApi.md#get_project_deletable) | **GET** /projects/{project_id}/_deletable | Get the deletable status of the project
+*Harbor2Client::ProjectApi* | [**get_project_summary**](docs/ProjectApi.md#get_project_summary) | **GET** /projects/{project_id}/summary | Get summary of the project.
+*Harbor2Client::ProjectApi* | [**head_project**](docs/ProjectApi.md#head_project) | **HEAD** /projects | Check if the project name user provided already exists.
+*Harbor2Client::ProjectApi* | [**list_projects**](docs/ProjectApi.md#list_projects) | **GET** /projects | List projects
+*Harbor2Client::ProjectApi* | [**update_project**](docs/ProjectApi.md#update_project) | **PUT** /projects/{project_id} | Update properties for a selected project.
+*Harbor2Client::RepositoryApi* | [**delete_repository**](docs/RepositoryApi.md#delete_repository) | **DELETE** /projects/{project_name}/repositories/{repository_name} | Delete repository
+*Harbor2Client::RepositoryApi* | [**get_repository**](docs/RepositoryApi.md#get_repository) | **GET** /projects/{project_name}/repositories/{repository_name} | Get repository
+*Harbor2Client::RepositoryApi* | [**list_repositories**](docs/RepositoryApi.md#list_repositories) | **GET** /projects/{project_name}/repositories | List repositories
+*Harbor2Client::RepositoryApi* | [**update_repository**](docs/RepositoryApi.md#update_repository) | **PUT** /projects/{project_name}/repositories/{repository_name} | Update repository
+*Harbor2Client::ScanApi* | [**get_report_log**](docs/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
+*Harbor2Client::ScanApi* | [**scan_artifact**](docs/ScanApi.md#scan_artifact) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan | Scan the artifact
+
+
+## Documentation for Models
+
+ - [Harbor2Client::AdditionLink](docs/AdditionLink.md)
+ - [Harbor2Client::AdditionLinks](docs/AdditionLinks.md)
+ - [Harbor2Client::Annotations](docs/Annotations.md)
+ - [Harbor2Client::Artifact](docs/Artifact.md)
+ - [Harbor2Client::AuditLog](docs/AuditLog.md)
+ - [Harbor2Client::CVEAllowlist](docs/CVEAllowlist.md)
+ - [Harbor2Client::CVEAllowlistItem](docs/CVEAllowlistItem.md)
+ - [Harbor2Client::Error](docs/Error.md)
+ - [Harbor2Client::Errors](docs/Errors.md)
+ - [Harbor2Client::Execution](docs/Execution.md)
+ - [Harbor2Client::ExtraAttrs](docs/ExtraAttrs.md)
+ - [Harbor2Client::Icon](docs/Icon.md)
+ - [Harbor2Client::Instance](docs/Instance.md)
+ - [Harbor2Client::Label](docs/Label.md)
+ - [Harbor2Client::Metadata](docs/Metadata.md)
+ - [Harbor2Client::Metrics](docs/Metrics.md)
+ - [Harbor2Client::NativeReportSummary](docs/NativeReportSummary.md)
+ - [Harbor2Client::Platform](docs/Platform.md)
+ - [Harbor2Client::PreheatPolicy](docs/PreheatPolicy.md)
+ - [Harbor2Client::Project](docs/Project.md)
+ - [Harbor2Client::ProjectDeletable](docs/ProjectDeletable.md)
+ - [Harbor2Client::ProjectMetadata](docs/ProjectMetadata.md)
+ - [Harbor2Client::ProjectReq](docs/ProjectReq.md)
+ - [Harbor2Client::ProjectSummary](docs/ProjectSummary.md)
+ - [Harbor2Client::ProjectSummaryQuota](docs/ProjectSummaryQuota.md)
+ - [Harbor2Client::ProviderUnderProject](docs/ProviderUnderProject.md)
+ - [Harbor2Client::Reference](docs/Reference.md)
+ - [Harbor2Client::Registry](docs/Registry.md)
+ - [Harbor2Client::RegistryCredential](docs/RegistryCredential.md)
+ - [Harbor2Client::Repository](docs/Repository.md)
+ - [Harbor2Client::ResourceList](docs/ResourceList.md)
+ - [Harbor2Client::ScanOverview](docs/ScanOverview.md)
+ - [Harbor2Client::Tag](docs/Tag.md)
+ - [Harbor2Client::Task](docs/Task.md)
+ - [Harbor2Client::VulnerabilitySummary](docs/VulnerabilitySummary.md)
+
+
+## Documentation for Authorization
+
+
+### basic
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AdditionLink.md

@@ -0,0 +1,9 @@
+# Harbor2Client::AdditionLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | The link of the addition | [optional] 
+**absolute** | **BOOLEAN** | Determine whether the link is an absolute URL or not | [optional] 
+
+

data/docs/AdditionLinks.md

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

data/docs/Annotations.md

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

data/docs/Artifact.md

@@ -0,0 +1,25 @@
+# Harbor2Client::Artifact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the artifact | [optional] 
+**type** | **String** | The type of the artifact, e.g. image, chart, etc | [optional] 
+**media_type** | **String** | The media type of the artifact | [optional] 
+**manifest_media_type** | **String** | The manifest media type of the artifact | [optional] 
+**project_id** | **Integer** | The ID of the project that the artifact belongs to | [optional] 
+**repository_id** | **Integer** | The ID of the repository that the artifact belongs to | [optional] 
+**digest** | **String** | The digest of the artifact | [optional] 
+**size** | **Integer** | The size of the artifact | [optional] 
+**icon** | **String** | The digest of the icon | [optional] 
+**push_time** | **DateTime** | The push time of the artifact | [optional] 
+**pull_time** | **DateTime** | The latest pull time of the artifact | [optional] 
+**extra_attrs** | [**ExtraAttrs**](ExtraAttrs.md) |  | [optional] 
+**annotations** | [**Annotations**](Annotations.md) |  | [optional] 
+**references** | [**Array<Reference>**](Reference.md) |  | [optional] 
+**tags** | [**Array<Tag>**](Tag.md) |  | [optional] 
+**addition_links** | [**AdditionLinks**](AdditionLinks.md) |  | [optional] 
+**labels** | [**Array<Label>**](Label.md) |  | [optional] 
+**scan_overview** | [**ScanOverview**](ScanOverview.md) | The overview of the scan result. | [optional] 
+
+

data/docs/ArtifactApi.md

@@ -0,0 +1,694 @@
+# Harbor2Client::ArtifactApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_label**](ArtifactApi.md#add_label) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels | Add label to artifact
+[**copy_artifact**](ArtifactApi.md#copy_artifact) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts | Copy artifact
+[**create_tag**](ArtifactApi.md#create_tag) | **POST** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags | Create tag
+[**delete_artifact**](ArtifactApi.md#delete_artifact) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference} | Delete the specific artifact
+[**delete_tag**](ArtifactApi.md#delete_tag) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags/{tag_name} | Delete tag
+[**get_addition**](ArtifactApi.md#get_addition) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/{addition} | Get the addition of the specific artifact
+[**get_artifact**](ArtifactApi.md#get_artifact) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference} | Get the specific artifact
+[**list_artifacts**](ArtifactApi.md#list_artifacts) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts | List artifacts
+[**list_tags**](ArtifactApi.md#list_tags) | **GET** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags | List tags
+[**remove_label**](ArtifactApi.md#remove_label) | **DELETE** /projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/labels/{label_id} | Remove label from artifact
+
+
+# **add_label**
+> add_label(project_namerepository_name, reference, label, opts)
+
+Add label to artifact
+
+Add label to the specified artiact.
+
+### 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::ArtifactApi.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
+
+label = Harbor2Client::Label.new # Label | The label that added to the artifact. Only the ID property is needed.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Add label to artifact
+  api_instance.add_label(project_namerepository_name, reference, label, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->add_label: #{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 | 
+ **label** | [**Label**](Label.md)| The label that added to the artifact. Only the ID property is needed. | 
+ **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
+
+
+
+# **copy_artifact**
+> copy_artifact(project_namerepository_name, from, opts)
+
+Copy artifact
+
+Copy the artifact specified in the \"from\" parameter to the repository.
+
+### 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::ArtifactApi.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
+
+from = 'from_example' # String | The artifact from which the new artifact is copied from, the format should be \"project/repository:tag\" or \"project/repository@digest\".
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Copy artifact
+  api_instance.copy_artifact(project_namerepository_name, from, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->copy_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 | 
+ **from** | **String**| The artifact from which the new artifact is copied from, the format should be \"project/repository:tag\" or \"project/repository@digest\". | 
+ **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
+
+
+
+# **create_tag**
+> create_tag(project_namerepository_name, reference, tag, opts)
+
+Create tag
+
+Create a tag for 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::ArtifactApi.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
+
+tag = Harbor2Client::Tag.new # Tag | The JSON object of tag.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create tag
+  api_instance.create_tag(project_namerepository_name, reference, tag, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->create_tag: #{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 | 
+ **tag** | [**Tag**](Tag.md)| The JSON object of 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
+
+
+
+# **delete_artifact**
+> delete_artifact(project_namerepository_name, reference, , opts)
+
+Delete the specific artifact
+
+Delete the artifact specified by the reference under the project and repository. The reference can be digest or tag
+
+### 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::ArtifactApi.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
+  #Delete the specific artifact
+  api_instance.delete_artifact(project_namerepository_name, reference, , opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->delete_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
+
+
+
+# **delete_tag**
+> delete_tag(project_namerepository_name, reference, tag_name, opts)
+
+Delete tag
+
+Delete the tag of 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::ArtifactApi.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
+
+tag_name = 'tag_name_example' # String | The name of the tag
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete tag
+  api_instance.delete_tag(project_namerepository_name, reference, tag_name, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->delete_tag: #{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 | 
+ **tag_name** | **String**| The name of the 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
+
+
+
+# **get_addition**
+> String get_addition(project_namerepository_name, reference, addition, opts)
+
+Get the addition of the specific artifact
+
+Get the addition of the artifact specified by the reference under the project and repository.
+
+### 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::ArtifactApi.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
+
+addition = 'addition_example' # String | The type of addition.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the addition of the specific artifact
+  result = api_instance.get_addition(project_namerepository_name, reference, addition, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->get_addition: #{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 | 
+ **addition** | **String**| The type of addition. | 
+ **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**: application/json
+
+
+
+# **get_artifact**
+> Artifact get_artifact(project_namerepository_name, reference, , opts)
+
+Get the specific artifact
+
+Get the artifact specified by the reference under the project and repository. The reference can be digest or tag.
+
+### 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::ArtifactApi.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
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  with_tag: true, # BOOLEAN | Specify whether the tags are inclued inside the returning artifacts
+  with_label: false, # BOOLEAN | Specify whether the labels are inclued inside the returning artifacts
+  with_scan_overview: false, # BOOLEAN | Specify whether the scan overview is inclued inside the returning artifacts
+  with_signature: false, # BOOLEAN | Specify whether the signature is inclued inside the returning artifacts
+  with_immutable_status: false # BOOLEAN | Specify whether the immutable status is inclued inside the tags of the returning artifacts. Only works when setting \"with_tag=true\"
+}
+
+begin
+  #Get the specific artifact
+  result = api_instance.get_artifact(project_namerepository_name, reference, , opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->get_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] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **with_tag** | **BOOLEAN**| Specify whether the tags are inclued inside the returning artifacts | [optional] [default to true]
+ **with_label** | **BOOLEAN**| Specify whether the labels are inclued inside the returning artifacts | [optional] [default to false]
+ **with_scan_overview** | **BOOLEAN**| Specify whether the scan overview is inclued inside the returning artifacts | [optional] [default to false]
+ **with_signature** | **BOOLEAN**| Specify whether the signature is inclued inside the returning artifacts | [optional] [default to false]
+ **with_immutable_status** | **BOOLEAN**| Specify whether the immutable status is inclued inside the tags of the returning artifacts. Only works when setting \"with_tag=true\" | [optional] [default to false]
+
+### Return type
+
+[**Artifact**](Artifact.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_artifacts**
+> Array<Artifact> list_artifacts(project_namerepository_name, , opts)
+
+List artifacts
+
+List artifacts under the specific project and repository. Except the basic properties, the other supported queries in \"q\" includes \"tags=*\" to list only tagged artifacts, \"tags=nil\" to list only untagged artifacts, \"tags=~v\" to list artifacts whose tag fuzzy matches \"v\", \"tags=v\" to list artifact whose tag exactly matches \"v\", \"labels=(id1, id2)\" to list artifacts that both labels with id1 and id2 are added to
+
+### 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::ArtifactApi.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
+  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
+  with_tag: true, # BOOLEAN | Specify whether the tags are included inside the returning artifacts
+  with_label: false, # BOOLEAN | Specify whether the labels are included inside the returning artifacts
+  with_scan_overview: false, # BOOLEAN | Specify whether the scan overview is included inside the returning artifacts
+  with_signature: false, # BOOLEAN | Specify whether the signature is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\"
+  with_immutable_status: false # BOOLEAN | Specify whether the immutable status is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\"
+}
+
+begin
+  #List artifacts
+  result = api_instance.list_artifacts(project_namerepository_name, , opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->list_artifacts: #{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] 
+ **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]
+ **with_tag** | **BOOLEAN**| Specify whether the tags are included inside the returning artifacts | [optional] [default to true]
+ **with_label** | **BOOLEAN**| Specify whether the labels are included inside the returning artifacts | [optional] [default to false]
+ **with_scan_overview** | **BOOLEAN**| Specify whether the scan overview is included inside the returning artifacts | [optional] [default to false]
+ **with_signature** | **BOOLEAN**| Specify whether the signature is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\" | [optional] [default to false]
+ **with_immutable_status** | **BOOLEAN**| Specify whether the immutable status is included inside the tags of the returning artifacts. Only works when setting \"with_tag=true\" | [optional] [default to false]
+
+### Return type
+
+[**Array<Artifact>**](Artifact.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_tags**
+> Array<Tag> list_tags(project_namerepository_name, reference, , opts)
+
+List tags
+
+List tags of the specific 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::ArtifactApi.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
+  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
+  with_signature: false, # BOOLEAN | Specify whether the signature is included inside the returning tags
+  with_immutable_status: false # BOOLEAN | Specify whether the immutable status is included inside the returning tags
+}
+
+begin
+  #List tags
+  result = api_instance.list_tags(project_namerepository_name, reference, , opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->list_tags: #{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] 
+ **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]
+ **with_signature** | **BOOLEAN**| Specify whether the signature is included inside the returning tags | [optional] [default to false]
+ **with_immutable_status** | **BOOLEAN**| Specify whether the immutable status is included inside the returning tags | [optional] [default to false]
+
+### Return type
+
+[**Array<Tag>**](Tag.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **remove_label**
+> remove_label(project_namerepository_name, reference, label_id, opts)
+
+Remove label from artifact
+
+Remove the label from the specified artiact.
+
+### 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::ArtifactApi.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
+
+label_id = 789 # Integer | The ID of the label that removed from the artifact.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Remove label from artifact
+  api_instance.remove_label(project_namerepository_name, reference, label_id, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ArtifactApi->remove_label: #{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 | 
+ **label_id** | **Integer**| The ID of the label that removed from the artifact. | 
+ **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
+
+
+