harbor_swagger_client 1.0.4 → 2.0.0

data/docs/ReplicationTask.md

@@ -3,14 +3,15 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | The ID | [optional] 
-**execution_id** | **Integer** | The execution ID | [optional] 
-**resource_type** | **String** | The resource type | [optional] 
-**src_resource** | **String** | The source resource | [optional] 
-**dst_resource** | **String** | The destination resource | [optional] 
-**job_id** | **String** | The job ID | [optional] 
-**status** | **String** | The status | [optional] 
-**start_time** | **String** | The start time | [optional] 
-**end_time** | **String** | The end time | [optional] 
+**id** | **Integer** | The ID of the task | [optional] 
+**execution_id** | **Integer** | The ID of the execution that the task belongs to | [optional] 
+**status** | **String** | The status of the task | [optional] 
+**job_id** | **String** | The ID of the underlying job that the task related to | [optional] 
+**operation** | **String** | The operation of the task | [optional] 
+**resource_type** | **String** | The type of the resource that the task operates | [optional] 
+**src_resource** | **String** | The source resource that the task operates | [optional] 
+**dst_resource** | **String** | The destination resource that the task operates | [optional] 
+**start_time** | **DateTime** | The start time of the task | [optional] 
+**end_time** | **DateTime** | The end time of the task | [optional] 
 
 

data/docs/Repository.md

@@ -0,0 +1,15 @@
+# SwaggerClient::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 @@
+# SwaggerClient::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 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::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 SwaggerClient::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 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::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 = SwaggerClient::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 SwaggerClient::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/Robot.md

@@ -0,0 +1,19 @@
+# SwaggerClient::Robot
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the robot | [optional] 
+**name** | **String** | The name of the tag | [optional] 
+**description** | **String** | The description of the robot | [optional] 
+**secret** | **String** | The secret of the robot | [optional] 
+**level** | **String** | The level of the robot, project or system | [optional] 
+**duration** | **Integer** | The duration of the robot in days | [optional] 
+**editable** | **BOOLEAN** | The editable status of the robot | [optional] 
+**disable** | **BOOLEAN** | The disable status of the robot | [optional] 
+**expires_at** | **Integer** | The expiration data of the robot | [optional] 
+**permissions** | [**Array<Permission>**](Permission.md) |  | [optional] 
+**creation_time** | **DateTime** | The creation time of the robot. | [optional] 
+**update_time** | **DateTime** | The update time of the robot. | [optional] 
+
+

data/docs/RobotApi.md

@@ -0,0 +1,363 @@
+# SwaggerClient::RobotApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_robot**](RobotApi.md#create_robot) | **POST** /robots | Create a robot account
+[**delete_robot**](RobotApi.md#delete_robot) | **DELETE** /robots/{robot_id} | Delete a robot account
+[**get_robot_by_id**](RobotApi.md#get_robot_by_id) | **GET** /robots/{robot_id} | Get a robot account
+[**list_robot**](RobotApi.md#list_robot) | **GET** /robots | Get robot account
+[**refresh_sec**](RobotApi.md#refresh_sec) | **PATCH** /robots/{robot_id} | Refresh the robot secret
+[**update_robot**](RobotApi.md#update_robot) | **PUT** /robots/{robot_id} | Update a robot account
+
+
+# **create_robot**
+> RobotCreated create_robot(robot, opts)
+
+Create a robot account
+
+Create a robot account
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotApi.new
+
+robot = SwaggerClient::RobotCreate.new # RobotCreate | The JSON object of a robot account.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create a robot account
+  result = api_instance.create_robot(robot, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotApi->create_robot: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **robot** | [**RobotCreate**](RobotCreate.md)| The JSON object of a robot account. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**RobotCreated**](RobotCreated.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_robot**
+> delete_robot(robot_id, , opts)
+
+Delete a robot account
+
+This endpoint deletes specific robot account information by robot ID.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotApi.new
+
+robot_id = 56 # Integer | Robot ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete a robot account
+  api_instance.delete_robot(robot_id, , opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotApi->delete_robot: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **robot_id** | **Integer**| Robot ID | 
+ **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_robot_by_id**
+> Robot get_robot_by_id(robot_id, , opts)
+
+Get a robot account
+
+This endpoint returns specific robot account information by robot ID.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotApi.new
+
+robot_id = 56 # Integer | Robot ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get a robot account
+  result = api_instance.get_robot_by_id(robot_id, , opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotApi->get_robot_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **robot_id** | **Integer**| Robot ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Robot**](Robot.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_robot**
+> Array<Robot> list_robot(opts)
+
+Get robot account
+
+List the robot accounts with the specified level and project.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotApi.new
+
+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
+  #Get robot account
+  result = api_instance.list_robot(opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotApi->list_robot: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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<Robot>**](Robot.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **refresh_sec**
+> RobotSec refresh_sec(robot_id, robot_sec, opts)
+
+Refresh the robot secret
+
+Refresh the robot secret
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotApi.new
+
+robot_id = 56 # Integer | Robot ID
+
+robot_sec = SwaggerClient::RobotSec.new # RobotSec | The JSON object of a robot account.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Refresh the robot secret
+  result = api_instance.refresh_sec(robot_id, robot_sec, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotApi->refresh_sec: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **robot_id** | **Integer**| Robot ID | 
+ **robot_sec** | [**RobotSec**](RobotSec.md)| The JSON object of a robot account. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**RobotSec**](RobotSec.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_robot**
+> update_robot(robot_id, robot, opts)
+
+Update a robot account
+
+This endpoint updates specific robot account information by robot ID.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotApi.new
+
+robot_id = 56 # Integer | Robot ID
+
+robot = SwaggerClient::Robot.new # Robot | The JSON object of a robot account.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update a robot account
+  api_instance.update_robot(robot_id, robot, opts)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotApi->update_robot: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **robot_id** | **Integer**| Robot ID | 
+ **robot** | [**Robot**](Robot.md)| The JSON object of a robot account. | 
+ **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
+
+
+