harbor2_client 0.1.0 → 2.3.3.3

data/docs/ImmutableRule.md

@@ -0,0 +1,15 @@
+# Harbor2Client::ImmutableRule
+
+## 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<ImmutableSelector>**](ImmutableSelector.md) |  | [optional] 
+**scope_selectors** | **Hash<String, Array<ImmutableSelector>>** |  | [optional] 
+
+

data/docs/ImmutableSelector.md

@@ -0,0 +1,11 @@
+# Harbor2Client::ImmutableSelector
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** |  | [optional] 
+**decoration** | **String** |  | [optional] 
+**pattern** | **String** |  | [optional] 
+**extras** | **String** |  | [optional] 
+
+

data/docs/IntegerConfigItem.md

@@ -0,0 +1,9 @@
+# Harbor2Client::IntegerConfigItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Integer** | The integer value of current config item | [optional] 
+**editable** | **BOOLEAN** | The configure item can be updated or not | [optional] 
+
+

data/docs/InternalConfigurationsResponse.md

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

data/docs/IsDefault.md

@@ -0,0 +1,8 @@
+# Harbor2Client::IsDefault
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_default** | **BOOLEAN** | A flag indicating whether a scanner registration is default. | [optional] 
+
+

data/docs/LabelApi.md

@@ -0,0 +1,309 @@
+# Harbor2Client::LabelApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_label**](LabelApi.md#create_label) | **POST** /labels | Post creates a label
+[**delete_label**](LabelApi.md#delete_label) | **DELETE** /labels/{label_id} | Delete the label specified by ID.
+[**get_label_by_id**](LabelApi.md#get_label_by_id) | **GET** /labels/{label_id} | Get the label specified by ID.
+[**list_labels**](LabelApi.md#list_labels) | **GET** /labels | List labels according to the query strings.
+[**update_label**](LabelApi.md#update_label) | **PUT** /labels/{label_id} | Update the label properties.
+
+
+# **create_label**
+> create_label(label, opts)
+
+Post creates a label
+
+This endpoint let user creates a label. 
+
+### 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::LabelApi.new
+
+label = Harbor2Client::Label.new # Label | The json object of label.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Post creates a label
+  api_instance.create_label(label, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LabelApi->create_label: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label** | [**Label**](Label.md)| The json object of label. | 
+ **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_label**
+> delete_label(label_id, opts)
+
+Delete the label specified by ID.
+
+Delete the label specified by ID. 
+
+### 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::LabelApi.new
+
+label_id = 789 # Integer | Label ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Delete the label specified by ID.
+  api_instance.delete_label(label_id, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LabelApi->delete_label: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **Integer**| Label 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_label_by_id**
+> Label get_label_by_id(label_id, opts)
+
+Get the label specified by ID.
+
+This endpoint let user get the label by specific ID. 
+
+### 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::LabelApi.new
+
+label_id = 789 # Integer | Label ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get the label specified by ID.
+  result = api_instance.get_label_by_id(label_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LabelApi->get_label_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **Integer**| Label ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**Label**](Label.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_labels**
+> Array<Label> list_labels(opts)
+
+List labels according to the query strings.
+
+This endpoint let user list labels by name, scope and project_id 
+
+### 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::LabelApi.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]
+  sort: 'sort_example', # String | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  name: 'name_example', # String | The label name.
+  scope: 'scope_example', # String | The label scope. Valid values are g and p. g for global labels and p for project labels.
+  project_id: 789 # Integer | Relevant project ID, required when scope is p.
+}
+
+begin
+  #List labels according to the query strings.
+  result = api_instance.list_labels(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LabelApi->list_labels: #{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] 
+ **sort** | **String**| Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\" | [optional] 
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **name** | **String**| The label name. | [optional] 
+ **scope** | **String**| The label scope. Valid values are g and p. g for global labels and p for project labels. | [optional] 
+ **project_id** | **Integer**| Relevant project ID, required when scope is p. | [optional] 
+
+### Return type
+
+[**Array<Label>**](Label.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_label**
+> update_label(label_idlabel, opts)
+
+Update the label properties.
+
+This endpoint let user update label properties. 
+
+### 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::LabelApi.new
+
+label_id = 789 # Integer | Label ID
+
+label = Harbor2Client::Label.new # Label | The updated label json object.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update the label properties.
+  api_instance.update_label(label_idlabel, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LabelApi->update_label: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **Integer**| Label ID | 
+ **label** | [**Label**](Label.md)| The updated label json object. | 
+ **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/LdapApi.md

@@ -0,0 +1,238 @@
+# Harbor2Client::LdapApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**import_ldap_user**](LdapApi.md#import_ldap_user) | **POST** /ldap/users/import | Import selected available ldap users.
+[**ping_ldap**](LdapApi.md#ping_ldap) | **POST** /ldap/ping | Ping available ldap service.
+[**search_ldap_group**](LdapApi.md#search_ldap_group) | **GET** /ldap/groups/search | Search available ldap groups.
+[**search_ldap_user**](LdapApi.md#search_ldap_user) | **GET** /ldap/users/search | Search available ldap users.
+
+
+# **import_ldap_user**
+> import_ldap_user(uid_list, opts)
+
+Import selected available ldap users.
+
+This endpoint adds the selected available ldap users to harbor based on related configuration parameters from the system. System will try to guess the user email address and realname, add to harbor user information. If have errors when import user, will return the list of importing failed uid and the failed reason. 
+
+### 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::LdapApi.new
+
+uid_list = Harbor2Client::LdapImportUsers.new # LdapImportUsers | The uid listed for importing. This list will check users validity of ldap service based on configuration from the system.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Import selected available ldap users.
+  api_instance.import_ldap_user(uid_list, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LdapApi->import_ldap_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uid_list** | [**LdapImportUsers**](LdapImportUsers.md)| The uid listed for importing. This list will check users validity of ldap service based on configuration from the system. | 
+ **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
+
+
+
+# **ping_ldap**
+> LdapPingResult ping_ldap(opts)
+
+Ping available ldap service.
+
+This endpoint ping the available ldap service for test related configuration parameters. 
+
+### 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::LdapApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  ldapconf: Harbor2Client::LdapConf.new # LdapConf | ldap configuration. support input ldap service configuration. If it is a empty request, will load current configuration from the system.
+}
+
+begin
+  #Ping available ldap service.
+  result = api_instance.ping_ldap(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LdapApi->ping_ldap: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **ldapconf** | [**LdapConf**](LdapConf.md)| ldap configuration. support input ldap service configuration. If it is a empty request, will load current configuration from the system. | [optional] 
+
+### Return type
+
+[**LdapPingResult**](LdapPingResult.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **search_ldap_group**
+> Array<UserGroup> search_ldap_group(opts)
+
+Search available ldap groups.
+
+This endpoint searches the available ldap groups based on related configuration parameters. support to search by groupname or groupdn. 
+
+### 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::LdapApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  groupname: 'groupname_example', # String | Ldap group name
+  groupdn: 'groupdn_example' # String | The LDAP group DN
+}
+
+begin
+  #Search available ldap groups.
+  result = api_instance.search_ldap_group(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LdapApi->search_ldap_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **groupname** | **String**| Ldap group name | [optional] 
+ **groupdn** | **String**| The LDAP group DN | [optional] 
+
+### Return type
+
+[**Array<UserGroup>**](UserGroup.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **search_ldap_user**
+> Array<LdapUser> search_ldap_user(opts)
+
+Search available ldap users.
+
+This endpoint searches the available ldap users based on related configuration parameters. Support searched by input ladp configuration, load configuration from the system and specific filter. 
+
+### 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::LdapApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  username: 'username_example' # String | Registered user ID
+}
+
+begin
+  #Search available ldap users.
+  result = api_instance.search_ldap_user(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling LdapApi->search_ldap_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **username** | **String**| Registered user ID | [optional] 
+
+### Return type
+
+[**Array<LdapUser>**](LdapUser.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/LdapConf.md

@@ -0,0 +1,16 @@
+# Harbor2Client::LdapConf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ldap_url** | **String** | The url of ldap service. | [optional] 
+**ldap_search_dn** | **String** | The search dn of ldap service. | [optional] 
+**ldap_search_password** | **String** | The search password of ldap service. | [optional] 
+**ldap_base_dn** | **String** | The base dn of ldap service. | [optional] 
+**ldap_filter** | **String** | The serach filter of ldap service. | [optional] 
+**ldap_uid** | **String** | The serach uid from ldap service attributes. | [optional] 
+**ldap_scope** | **Integer** | The serach scope of ldap service. | [optional] 
+**ldap_connection_timeout** | **Integer** | The connect timeout of ldap service(second). | [optional] 
+**ldap_verify_cert** | **BOOLEAN** | Verify Ldap server certificate. | [optional] 
+
+

data/docs/LdapFailedImportUser.md

@@ -0,0 +1,9 @@
+# Harbor2Client::LdapFailedImportUser
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **String** | the uid can't add to system. | [optional] 
+**error** | **String** | fail reason. | [optional] 
+
+

data/docs/LdapImportUsers.md

@@ -0,0 +1,8 @@
+# Harbor2Client::LdapImportUsers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ldap_uid_list** | **Array<String>** | selected uid list | [optional] 
+
+

data/docs/LdapPingResult.md

@@ -0,0 +1,9 @@
+# Harbor2Client::LdapPingResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **BOOLEAN** | Test success | [optional] 
+**message** | **String** | The ping operation output message. | [optional] 
+
+

data/docs/LdapUser.md

@@ -0,0 +1,10 @@
+# Harbor2Client::LdapUser
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | ldap username. | [optional] 
+**realname** | **String** | The user realname from \"uid\" or \"cn\" attribute. | [optional] 
+**email** | **String** | The user email address from \"mail\" or \"email\" attribute. | [optional] 
+
+