harbor2_client 0.2.0 → 2.3.3.0

data/docs/ProjectApi.md

@@ -5,14 +5,17 @@ All URIs are relative to *http://localhost/api/v2.0*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create_project**](ProjectApi.md#create_project) | **POST** /projects | Create a new project.
-[**delete_project**](ProjectApi.md#delete_project) | **DELETE** /projects/{project_id} | Delete project by projectID
+[**delete_project**](ProjectApi.md#delete_project) | **DELETE** /projects/{project_name_or_id} | Delete project by projectID
 [**get_logs**](ProjectApi.md#get_logs) | **GET** /projects/{project_name}/logs | Get recent logs of the projects
-[**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_id} | Return specific project detail information
-[**get_project_deletable**](ProjectApi.md#get_project_deletable) | **GET** /projects/{project_id}/_deletable | Get the deletable status of the project
-[**get_project_summary**](ProjectApi.md#get_project_summary) | **GET** /projects/{project_id}/summary | Get summary of the project.
+[**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_name_or_id} | Return specific project detail information
+[**get_project_deletable**](ProjectApi.md#get_project_deletable) | **GET** /projects/{project_name_or_id}/_deletable | Get the deletable status of the project
+[**get_project_summary**](ProjectApi.md#get_project_summary) | **GET** /projects/{project_name_or_id}/summary | Get summary of the project.
+[**get_scanner_of_project**](ProjectApi.md#get_scanner_of_project) | **GET** /projects/{project_name_or_id}/scanner | Get project level scanner
 [**head_project**](ProjectApi.md#head_project) | **HEAD** /projects | Check if the project name user provided already exists.
 [**list_projects**](ProjectApi.md#list_projects) | **GET** /projects | List projects
-[**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{project_id} | Update properties for a selected project.
+[**list_scanner_candidates_of_project**](ProjectApi.md#list_scanner_candidates_of_project) | **GET** /projects/{project_name_or_id}/scanner/candidates | Get scanner registration candidates for configurating project level scanner
+[**set_scanner_of_project**](ProjectApi.md#set_scanner_of_project) | **PUT** /projects/{project_name_or_id}/scanner | Configure scanner for the specified project
+[**update_project**](ProjectApi.md#update_project) | **PUT** /projects/{project_name_or_id} | Update properties for a selected project.
 
 
 # **create_project**
@@ -39,6 +42,7 @@ project = Harbor2Client::ProjectReq.new # ProjectReq | New created project.
 
 opts = { 
   x_request_id: 'x_request_id_example' # String | An unique ID for the request
+  x_resource_name_in_location: false # BOOLEAN | The flag to indicate whether to return the name of the resource in Location. When X-Resource-Name-In-Location is true, the Location will return the name of the resource.
 }
 
 begin
@@ -55,6 +59,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project** | [**ProjectReq**](ProjectReq.md)| New created project. | 
  **x_request_id** | **String**| An unique ID for the request | [optional] 
+ **x_resource_name_in_location** | **BOOLEAN**| The flag to indicate whether to return the name of the resource in Location. When X-Resource-Name-In-Location is true, the Location will return the name of the resource. | [optional] [default to false]
 
 ### Return type
 
@@ -72,7 +77,7 @@ nil (empty response body)
 
 
 # **delete_project**
-> delete_project(project_id, opts)
+> delete_project(project_name_or_id, opts)
 
 Delete project by projectID
 
@@ -91,15 +96,16 @@ end
 
 api_instance = Harbor2Client::ProjectApi.new
 
-project_id = 789 # Integer | The ID of the project
+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.
 }
 
 begin
   #Delete project by projectID
-  api_instance.delete_project(project_id, opts)
+  api_instance.delete_project(project_name_or_id, opts)
 rescue Harbor2Client::ApiError => e
   puts "Exception when calling ProjectApi->delete_project: #{e}"
 end
@@ -109,8 +115,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The ID of the project | 
+ **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]
 
 ### Return type
 
@@ -151,7 +158,8 @@ 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]
+  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
 }
@@ -172,6 +180,7 @@ 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] 
+ **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]
 
@@ -191,7 +200,7 @@ Name | Type | Description  | Notes
 
 
 # **get_project**
-> Project get_project(project_id, opts)
+> Project get_project(project_name_or_id, opts)
 
 Return specific project detail information
 
@@ -210,15 +219,16 @@ end
 
 api_instance = Harbor2Client::ProjectApi.new
 
-project_id = 789 # Integer | The ID of the project
+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.
 }
 
 begin
   #Return specific project detail information
-  result = api_instance.get_project(project_id, opts)
+  result = api_instance.get_project(project_name_or_id, opts)
   p result
 rescue Harbor2Client::ApiError => e
   puts "Exception when calling ProjectApi->get_project: #{e}"
@@ -229,8 +239,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The ID of the project | 
+ **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]
 
 ### Return type
 
@@ -248,7 +259,7 @@ Name | Type | Description  | Notes
 
 
 # **get_project_deletable**
-> ProjectDeletable get_project_deletable(project_id, opts)
+> ProjectDeletable get_project_deletable(project_name_or_id, opts)
 
 Get the deletable status of the project
 
@@ -267,15 +278,16 @@ end
 
 api_instance = Harbor2Client::ProjectApi.new
 
-project_id = 789 # Integer | The ID of the project
+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.
 }
 
 begin
   #Get the deletable status of the project
-  result = api_instance.get_project_deletable(project_id, opts)
+  result = api_instance.get_project_deletable(project_name_or_id, opts)
   p result
 rescue Harbor2Client::ApiError => e
   puts "Exception when calling ProjectApi->get_project_deletable: #{e}"
@@ -286,8 +298,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The ID of the project | 
+ **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]
 
 ### Return type
 
@@ -305,7 +318,7 @@ Name | Type | Description  | Notes
 
 
 # **get_project_summary**
-> ProjectSummary get_project_summary(project_id, opts)
+> ProjectSummary get_project_summary(project_name_or_id, opts)
 
 Get summary of the project.
 
@@ -324,15 +337,16 @@ end
 
 api_instance = Harbor2Client::ProjectApi.new
 
-project_id = 789 # Integer | The ID of the project
+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.
 }
 
 begin
   #Get summary of the project.
-  result = api_instance.get_project_summary(project_id, opts)
+  result = api_instance.get_project_summary(project_name_or_id, opts)
   p result
 rescue Harbor2Client::ApiError => e
   puts "Exception when calling ProjectApi->get_project_summary: #{e}"
@@ -343,8 +357,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The ID of the project | 
+ **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]
 
 ### Return type
 
@@ -361,6 +376,65 @@ Name | Type | Description  | Notes
 
 
 
+# **get_scanner_of_project**
+> ScannerRegistration get_scanner_of_project(project_name_or_id, opts)
+
+Get project level scanner
+
+Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.
+
+### 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::ProjectApi.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.
+}
+
+begin
+  #Get project level scanner
+  result = api_instance.get_scanner_of_project(project_name_or_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectApi->get_scanner_of_project: #{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]
+
+### Return type
+
+[**ScannerRegistration**](ScannerRegistration.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **head_project**
 > head_project(project_name, opts)
 
@@ -439,11 +513,14 @@ api_instance = Harbor2Client::ProjectApi.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
+  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\"
   name: 'name_example', # String | The name of project.
   public: true, # BOOLEAN | The project is public or private.
-  owner: 'owner_example' # String | The name of project owner.
+  owner: 'owner_example', # String | The name of project owner.
+  with_detail: true # BOOLEAN | Bool value indicating whether return detailed information of the project
 }
 
 begin
@@ -460,11 +537,14 @@ end
 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]
+ **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] 
  **name** | **String**| The name of project. | [optional] 
  **public** | **BOOLEAN**| The project is public or private. | [optional] 
  **owner** | **String**| The name of project owner. | [optional] 
+ **with_detail** | **BOOLEAN**| Bool value indicating whether return detailed information of the project | [optional] [default to true]
 
 ### Return type
 
@@ -481,8 +561,136 @@ Name | Type | Description  | Notes
 
 
 
+# **list_scanner_candidates_of_project**
+> Array<ScannerRegistration> list_scanner_candidates_of_project(project_name_or_id, opts)
+
+Get scanner registration candidates for configurating project level scanner
+
+Retrieve the system configured scanner registrations as candidates of setting project level scanner.
+
+### 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::ProjectApi.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.
+  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
+}
+
+begin
+  #Get scanner registration candidates for configurating project level scanner
+  result = api_instance.list_scanner_candidates_of_project(project_name_or_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectApi->list_scanner_candidates_of_project: #{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]
+ **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]
+
+### Return type
+
+[**Array<ScannerRegistration>**](ScannerRegistration.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **set_scanner_of_project**
+> set_scanner_of_project(project_name_or_idpayload, opts)
+
+Configure scanner for the specified project
+
+Set one of the system configured scanner registration as the indepndent scanner of the specified project.
+
+### 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::ProjectApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+payload = Harbor2Client::ProjectScanner.new # ProjectScanner | 
+
+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
+  #Configure scanner for the specified project
+  api_instance.set_scanner_of_project(project_name_or_idpayload, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ProjectApi->set_scanner_of_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **payload** | [**ProjectScanner**](ProjectScanner.md)|  | 
+ **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
+
+
+
 # **update_project**
-> update_project(project_idproject, opts)
+> update_project(project_name_or_idproject, opts)
 
 Update properties for a selected project.
 
@@ -501,17 +709,18 @@ end
 
 api_instance = Harbor2Client::ProjectApi.new
 
-project_id = 789 # Integer | The ID of the project
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
 
 project = Harbor2Client::ProjectReq.new # ProjectReq | Updates of 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.
 }
 
 begin
   #Update properties for a selected project.
-  api_instance.update_project(project_idproject, opts)
+  api_instance.update_project(project_name_or_idproject, opts)
 rescue Harbor2Client::ApiError => e
   puts "Exception when calling ProjectApi->update_project: #{e}"
 end
@@ -521,9 +730,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **project_id** | **Integer**| The ID of the project | 
+ **project_name_or_id** | **String**| The name or id of the project | 
  **project** | [**ProjectReq**](ProjectReq.md)| Updates of 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]
 
 ### Return type
 

data/docs/ProjectMember.md

@@ -0,0 +1,10 @@
+# Harbor2Client::ProjectMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role_id** | **Integer** | The role id 1 for projectAdmin, 2 for developer, 3 for guest, 4 for maintainer | [optional] 
+**member_user** | [**UserEntity**](UserEntity.md) |  | [optional] 
+**member_group** | [**UserGroup**](UserGroup.md) |  | [optional] 
+
+

data/docs/ProjectMemberEntity.md

@@ -0,0 +1,14 @@
+# Harbor2Client::ProjectMemberEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | the project member id | [optional] 
+**project_id** | **Integer** | the project id | [optional] 
+**entity_name** | **String** | the name of the group member. | [optional] 
+**role_name** | **String** | the name of the role | [optional] 
+**role_id** | **Integer** | the role id | [optional] 
+**entity_id** | **Integer** | the id of entity, if the member is a user, it is user_id in user table. if the member is a user group, it is the user group's ID in user_group table. | [optional] 
+**entity_type** | **String** | the entity's type, u for user entity, g for group entity. | [optional] 
+
+