harbor_swagger_client 1.0.2 → 1.0.3

data/spec/docs/RetentionExecution.md

@@ -0,0 +1,14 @@
+# SwaggerClient::RetentionExecution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**policy_id** | **Integer** |  | [optional] 
+**start_time** | **String** |  | [optional] 
+**end_time** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**trigger** | **String** |  | [optional] 
+**dry_run** | **BOOLEAN** |  | [optional] 
+
+

data/spec/docs/RetentionExecutionTask.md

@@ -0,0 +1,18 @@
+# SwaggerClient::RetentionExecutionTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**execution_id** | **Integer** |  | [optional] 
+**repository** | **String** |  | [optional] 
+**job_id** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**status_code** | **Integer** |  | [optional] 
+**status_revision** | **Integer** |  | [optional] 
+**start_time** | **String** |  | [optional] 
+**end_time** | **String** |  | [optional] 
+**total** | **Integer** |  | [optional] 
+**retained** | **Integer** |  | [optional] 
+
+

data/spec/docs/RetentionMetadata.md

@@ -0,0 +1,10 @@
+# SwaggerClient::RetentionMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**templates** | [**Array<RetentionRuleMetadata>**](RetentionRuleMetadata.md) | templates | [optional] 
+**scope_selectors** | [**Array<RetentionSelectorMetadata>**](RetentionSelectorMetadata.md) | supported scope selectors | [optional] 
+**tag_selectors** | [**Array<RetentionSelectorMetadata>**](RetentionSelectorMetadata.md) | supported tag selectors | [optional] 
+
+

data/spec/docs/RetentionPolicy.md

@@ -0,0 +1,12 @@
+# SwaggerClient::RetentionPolicy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**algorithm** | **String** |  | [optional] 
+**rules** | [**Array<RetentionRule>**](RetentionRule.md) |  | [optional] 
+**trigger** | [**RetentionRuleTrigger**](RetentionRuleTrigger.md) |  | [optional] 
+**scope** | [**RetentionPolicyScope**](RetentionPolicyScope.md) |  | [optional] 
+
+

data/spec/docs/RetentionPolicyScope.md

@@ -0,0 +1,9 @@
+# SwaggerClient::RetentionPolicyScope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **String** |  | [optional] 
+**ref** | **Integer** |  | [optional] 
+
+

data/spec/docs/RetentionRule.md

@@ -0,0 +1,15 @@
+# SwaggerClient::RetentionRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**priority** | **Integer** |  | [optional] 
+**disabled** | **BOOLEAN** |  | [optional] 
+**action** | **String** |  | [optional] 
+**template** | **String** |  | [optional] 
+**params** | **Hash<String, Object>** |  | [optional] 
+**tag_selectors** | [**Array<RetentionSelector>**](RetentionSelector.md) |  | [optional] 
+**scope_selectors** | **Hash<String, Array<RetentionSelector>>** |  | [optional] 
+
+

data/spec/docs/RetentionRuleMetadata.md

@@ -0,0 +1,11 @@
+# SwaggerClient::RetentionRuleMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule_template** | **String** | rule id | [optional] 
+**display_text** | **String** | rule display text | [optional] 
+**action** | **String** | rule action | [optional] 
+**params** | [**Array<RetentionRuleParamMetadata>**](RetentionRuleParamMetadata.md) | rule params | [optional] 
+
+

data/spec/docs/RetentionRuleParamMetadata.md

@@ -0,0 +1,10 @@
+# SwaggerClient::RetentionRuleParamMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**unit** | **String** |  | [optional] 
+**required** | **BOOLEAN** |  | [optional] 
+
+

data/spec/docs/RetentionRuleTrigger.md

@@ -0,0 +1,10 @@
+# SwaggerClient::RetentionRuleTrigger
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** |  | [optional] 
+**settings** | **Object** |  | [optional] 
+**references** | **Object** |  | [optional] 
+
+

data/spec/docs/RetentionSelector.md

@@ -0,0 +1,10 @@
+# SwaggerClient::RetentionSelector
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** |  | [optional] 
+**decoration** | **String** |  | [optional] 
+**pattern** | **String** |  | [optional] 
+
+

data/spec/docs/RetentionSelectorMetadata.md

@@ -0,0 +1,10 @@
+# SwaggerClient::RetentionSelectorMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_text** | **String** |  | [optional] 
+**kind** | **String** |  | [optional] 
+**decorations** | **Array<String>** |  | [optional] 
+
+

data/spec/docs/RobotAccount.md

@@ -0,0 +1,15 @@
+# SwaggerClient::RobotAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The id of robot account | [optional] 
+**name** | **String** | The name of robot account | [optional] 
+**description** | **String** | The description of robot account | [optional] 
+**expires_at** | **Integer** | The expiration of robot account (in seconds) | [optional] 
+**project_id** | **Integer** | The project id of robot account | [optional] 
+**disabled** | **BOOLEAN** | The robot account is disable or enable | [optional] 
+**creation_time** | **String** | The creation time of the robot account | [optional] 
+**update_time** | **String** | The update time of the robot account | [optional] 
+
+

data/spec/docs/RobotAccountAccess.md

@@ -0,0 +1,9 @@
+# SwaggerClient::RobotAccountAccess
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource** | **String** | the resource of harbor | [optional] 
+**action** | **String** | the action to resource that perdefined in harbor rbac | [optional] 
+
+

data/spec/docs/RobotAccountApi.md

@@ -0,0 +1,291 @@
+# SwaggerClient::RobotAccountApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**projects_project_id_robots_get**](RobotAccountApi.md#projects_project_id_robots_get) | **GET** /projects/{project_id}/robots | Get all robot accounts of specified project
+[**projects_project_id_robots_post**](RobotAccountApi.md#projects_project_id_robots_post) | **POST** /projects/{project_id}/robots | Create a robot account for project
+[**projects_project_id_robots_robot_id_delete**](RobotAccountApi.md#projects_project_id_robots_robot_id_delete) | **DELETE** /projects/{project_id}/robots/{robot_id} | Delete the specified robot account
+[**projects_project_id_robots_robot_id_get**](RobotAccountApi.md#projects_project_id_robots_robot_id_get) | **GET** /projects/{project_id}/robots/{robot_id} | Return the infor of the specified robot account.
+[**projects_project_id_robots_robot_id_put**](RobotAccountApi.md#projects_project_id_robots_robot_id_put) | **PUT** /projects/{project_id}/robots/{robot_id} | Update status of robot account.
+
+
+# **projects_project_id_robots_get**
+> Array<RobotAccount> projects_project_id_robots_get(project_id)
+
+Get all robot accounts of specified project
+
+Get all robot accounts of specified project
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotAccountApi.new
+
+project_id = 789 # Integer | Relevant project ID.
+
+
+begin
+  #Get all robot accounts of specified project
+  result = api_instance.projects_project_id_robots_get(project_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotAccountApi->projects_project_id_robots_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **Integer**| Relevant project ID. | 
+
+### Return type
+
+[**Array<RobotAccount>**](RobotAccount.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **projects_project_id_robots_post**
+> RobotAccountPostRep projects_project_id_robots_post(project_id, robot)
+
+Create a robot account for project
+
+Create a robot account for project
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotAccountApi.new
+
+project_id = 789 # Integer | Relevant project ID.
+
+robot = SwaggerClient::RobotAccountCreate.new # RobotAccountCreate | Request body of creating a robot account.
+
+
+begin
+  #Create a robot account for project
+  result = api_instance.projects_project_id_robots_post(project_id, robot)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotAccountApi->projects_project_id_robots_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **Integer**| Relevant project ID. | 
+ **robot** | [**RobotAccountCreate**](RobotAccountCreate.md)| Request body of creating a robot account. | 
+
+### Return type
+
+[**RobotAccountPostRep**](RobotAccountPostRep.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **projects_project_id_robots_robot_id_delete**
+> projects_project_id_robots_robot_id_delete(project_id, robot_id)
+
+Delete the specified robot account
+
+Delete the specified robot account
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotAccountApi.new
+
+project_id = 789 # Integer | Relevant project ID.
+
+robot_id = 789 # Integer | The ID of robot account.
+
+
+begin
+  #Delete the specified robot account
+  api_instance.projects_project_id_robots_robot_id_delete(project_id, robot_id)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotAccountApi->projects_project_id_robots_robot_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **Integer**| Relevant project ID. | 
+ **robot_id** | **Integer**| The ID of robot account. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **projects_project_id_robots_robot_id_get**
+> RobotAccount projects_project_id_robots_robot_id_get(project_id, robot_id)
+
+Return the infor of the specified robot account.
+
+Return the infor of the specified robot account.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotAccountApi.new
+
+project_id = 789 # Integer | Relevant project ID.
+
+robot_id = 789 # Integer | The ID of robot account.
+
+
+begin
+  #Return the infor of the specified robot account.
+  result = api_instance.projects_project_id_robots_robot_id_get(project_id, robot_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotAccountApi->projects_project_id_robots_robot_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **Integer**| Relevant project ID. | 
+ **robot_id** | **Integer**| The ID of robot account. | 
+
+### Return type
+
+[**RobotAccount**](RobotAccount.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **projects_project_id_robots_robot_id_put**
+> projects_project_id_robots_robot_id_put(project_id, robot_id, robot)
+
+Update status of robot account.
+
+Used to disable/enable a specified robot account.
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::RobotAccountApi.new
+
+project_id = 789 # Integer | Relevant project ID.
+
+robot_id = 789 # Integer | The ID of robot account.
+
+robot = SwaggerClient::RobotAccountUpdate.new # RobotAccountUpdate | Request body of enable/disable a robot account.
+
+
+begin
+  #Update status of robot account.
+  api_instance.projects_project_id_robots_robot_id_put(project_id, robot_id, robot)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling RobotAccountApi->projects_project_id_robots_robot_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **Integer**| Relevant project ID. | 
+ **robot_id** | **Integer**| The ID of robot account. | 
+ **robot** | [**RobotAccountUpdate**](RobotAccountUpdate.md)| Request body of enable/disable a robot account. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+