harbor2_client 0.1.0 → 2.3.3.3

data/docs/MemberApi.md

@@ -0,0 +1,322 @@
+# Harbor2Client::MemberApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_project_member**](MemberApi.md#create_project_member) | **POST** /projects/{project_name_or_id}/members | Create project member
+[**delete_project_member**](MemberApi.md#delete_project_member) | **DELETE** /projects/{project_name_or_id}/members/{mid} | Delete project member
+[**get_project_member**](MemberApi.md#get_project_member) | **GET** /projects/{project_name_or_id}/members/{mid} | Get the project member information
+[**list_project_members**](MemberApi.md#list_project_members) | **GET** /projects/{project_name_or_id}/members | Get all project member information
+[**update_project_member**](MemberApi.md#update_project_member) | **PUT** /projects/{project_name_or_id}/members/{mid} | Update project member
+
+
+# **create_project_member**
+> create_project_member(project_name_or_id, opts)
+
+Create project member
+
+Create project member relationship, the member can be one of the user_member and group_member,  The user_member need to specify user_id or username. If the user already exist in harbor DB, specify the user_id,  If does not exist in harbor DB, it will SearchAndOnBoard the user. The group_member need to specify id or ldap_group_dn. If the group already exist in harbor DB. specify the user group's id,  If does not exist, it will SearchAndOnBoard the group. 
+
+### 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::MemberApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  project_member: Harbor2Client::ProjectMember.new # ProjectMember | 
+}
+
+begin
+  #Create project member
+  api_instance.create_project_member(project_name_or_id, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling MemberApi->create_project_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+ **project_member** | [**ProjectMember**](ProjectMember.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_project_member**
+> delete_project_member(project_name_or_idmid, opts)
+
+Delete project member
+
+### 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::MemberApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+mid = 789 # Integer | Member ID.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Delete project member
+  api_instance.delete_project_member(project_name_or_idmid, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling MemberApi->delete_project_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **mid** | **Integer**| Member ID. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_project_member**
+> ProjectMemberEntity get_project_member(project_name_or_idmid, opts)
+
+Get the project member information
+
+Get the project member information
+
+### 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::MemberApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+mid = 789 # Integer | The member ID
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+}
+
+begin
+  #Get the project member information
+  result = api_instance.get_project_member(project_name_or_idmid, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling MemberApi->get_project_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **mid** | **Integer**| The member ID | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+
+### Return type
+
+[**ProjectMemberEntity**](ProjectMemberEntity.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_project_members**
+> Array<ProjectMemberEntity> list_project_members(project_name_or_id, opts)
+
+Get all project member information
+
+Get all project member information
+
+### 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::MemberApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  page: 1, # Integer | The page number
+  page_size: 10, # Integer | The size of per page
+  entityname: 'entityname_example' # String | The entity name to search.
+}
+
+begin
+  #Get all project member information
+  result = api_instance.list_project_members(project_name_or_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling MemberApi->list_project_members: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+ **page** | **Integer**| The page number | [optional] [default to 1]
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
+ **entityname** | **String**| The entity name to search. | [optional] 
+
+### Return type
+
+[**Array<ProjectMemberEntity>**](ProjectMemberEntity.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_project_member**
+> update_project_member(project_name_or_idmid, opts)
+
+Update project member
+
+Update project member relationship
+
+### 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::MemberApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+mid = 789 # Integer | Member ID.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_is_resource_name: false # BOOLEAN | The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.
+  role: Harbor2Client::RoleRequest.new # RoleRequest | 
+}
+
+begin
+  #Update project member
+  api_instance.update_project_member(project_name_or_idmid, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling MemberApi->update_project_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **mid** | **Integer**| Member ID. | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_is_resource_name** | **BOOLEAN**| The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name. | [optional] [default to false]
+ **role** | [**RoleRequest**](RoleRequest.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/NativeReportSummary.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **start_time** | **DateTime** | The start time of the scan process that generating report | [optional] 
 **end_time** | **DateTime** | The end time of the scan process that generating report | [optional] 
 **complete_percent** | **Integer** | The complete percent of the scanning which value is between 0 and 100 | [optional] 
+**scanner** | [**Scanner**](Scanner.md) |  | [optional] 
 
 

data/docs/NotifyType.md

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

data/docs/OIDCCliSecretReq.md

@@ -0,0 +1,8 @@
+# Harbor2Client::OIDCCliSecretReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**secret** | **String** | The new secret | [optional] 
+
+

data/docs/OIDCUserInfo.md

@@ -0,0 +1,13 @@
+# Harbor2Client::OIDCUserInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | the ID of the OIDC info record | [optional] 
+**user_id** | **Integer** | the ID of the user | [optional] 
+**subiss** | **String** | the concatenation of sub and issuer in the ID token | [optional] 
+**secret** | **String** | the secret of the OIDC user that can be used for CLI to push/pull artifacts | [optional] 
+**creation_time** | **DateTime** | The creation time of the OIDC user info record. | [optional] 
+**update_time** | **DateTime** | The update time of the OIDC user info record. | [optional] 
+
+

data/docs/OidcApi.md

@@ -0,0 +1,65 @@
+# Harbor2Client::OidcApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ping_oidc**](OidcApi.md#ping_oidc) | **POST** /system/oidc/ping | Test the OIDC endpoint.
+
+
+# **ping_oidc**
+> ping_oidc(endpoint, opts)
+
+Test the OIDC endpoint.
+
+Test the OIDC endpoint, the setting of the endpoint is provided in the request.  This API can only be called by system admin. 
+
+### 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::OidcApi.new
+
+endpoint = Harbor2Client::Endpoint.new # Endpoint | Request body for OIDC endpoint to be tested.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Test the OIDC endpoint.
+  api_instance.ping_oidc(endpoint, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling OidcApi->ping_oidc: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **endpoint** | [**Endpoint**](Endpoint.md)| Request body for OIDC endpoint to be tested. | 
+ **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/OverallHealthStatus.md

@@ -0,0 +1,9 @@
+# Harbor2Client::OverallHealthStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The overall health status. It is \"healthy\" only when all the components' status are \"healthy\" | [optional] 
+**components** | [**Array<ComponentHealthStatus>**](ComponentHealthStatus.md) |  | [optional] 
+
+

data/docs/PasswordReq.md

@@ -0,0 +1,9 @@
+# Harbor2Client::PasswordReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old_password** | **String** | The user's existing password. | [optional] 
+**new_password** | **String** | New password for marking as to be updated. | [optional] 
+
+

data/docs/Permission.md

@@ -0,0 +1,9 @@
+# Harbor2Client::Permission
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource** | **String** | The permission resoruce | [optional] 
+**action** | **String** | The permission action | [optional] 
+
+

data/docs/PingApi.md

@@ -0,0 +1,63 @@
+# Harbor2Client::PingApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_ping**](PingApi.md#get_ping) | **GET** /ping | Ping Harbor to check if it's alive.
+
+
+# **get_ping**
+> String get_ping(opts)
+
+Ping Harbor to check if it's alive.
+
+This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.
+
+### 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::PingApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Ping Harbor to check if it's alive.
+  result = api_instance.get_ping(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling PingApi->get_ping: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+

data/docs/PreheatApi.md

@@ -529,7 +529,8 @@ 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
-  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]
+  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\"
 }
 
 begin
@@ -551,6 +552,7 @@ Name | Type | Description  | Notes
  **page** | **Integer**| The page number | [optional] [default to 1]
  **page_size** | **Integer**| The size of per page | [optional] [default to 10]
  **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] 
 
 ### Return type
 
@@ -591,7 +593,8 @@ 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
-  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]
+  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\"
 }
 
 begin
@@ -611,6 +614,7 @@ Name | Type | Description  | Notes
  **page** | **Integer**| The page number | [optional] [default to 1]
  **page_size** | **Integer**| The size of per page | [optional] [default to 10]
  **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] 
 
 ### Return type
 
@@ -653,7 +657,8 @@ 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
-  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]
+  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\"
 }
 
 begin
@@ -674,6 +679,7 @@ Name | Type | Description  | Notes
  **page** | **Integer**| The page number | [optional] [default to 1]
  **page_size** | **Integer**| The size of per page | [optional] [default to 10]
  **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] 
 
 ### Return type
 
@@ -831,7 +837,8 @@ 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
-  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]
+  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\"
 }
 
 begin
@@ -854,6 +861,7 @@ Name | Type | Description  | Notes
  **page** | **Integer**| The page number | [optional] [default to 1]
  **page_size** | **Integer**| The size of per page | [optional] [default to 10]
  **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] 
 
 ### Return type