harbor2_client 0.1.0 → 2.3.3.3

data/docs/GcApi.md

@@ -0,0 +1,356 @@
+# Harbor2Client::GcApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_gc_schedule**](GcApi.md#create_gc_schedule) | **POST** /system/gc/schedule | Create a gc schedule.
+[**get_gc**](GcApi.md#get_gc) | **GET** /system/gc/{gc_id} | Get gc status.
+[**get_gc_history**](GcApi.md#get_gc_history) | **GET** /system/gc | Get gc results.
+[**get_gc_log**](GcApi.md#get_gc_log) | **GET** /system/gc/{gc_id}/log | Get gc job log.
+[**get_gc_schedule**](GcApi.md#get_gc_schedule) | **GET** /system/gc/schedule | Get gc's schedule.
+[**update_gc_schedule**](GcApi.md#update_gc_schedule) | **PUT** /system/gc/schedule | Update gc's schedule.
+
+
+# **create_gc_schedule**
+> create_gc_schedule(schedule, opts)
+
+Create a gc schedule.
+
+This endpoint is for update gc schedule. 
+
+### 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::GcApi.new
+
+schedule = Harbor2Client::Schedule.new # Schedule | Updates of gc's schedule.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Create a gc schedule.
+  api_instance.create_gc_schedule(schedule, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling GcApi->create_gc_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **schedule** | [**Schedule**](Schedule.md)| Updates of gc's schedule. | 
+ **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_gc**
+> GCHistory get_gc(gc_id, opts)
+
+Get gc status.
+
+This endpoint let user get gc status filtered 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::GcApi.new
+
+gc_id = 789 # Integer | The ID of the gc log
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get gc status.
+  result = api_instance.get_gc(gc_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling GcApi->get_gc: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gc_id** | **Integer**| The ID of the gc log | 
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**GCHistory**](GCHistory.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_gc_history**
+> Array<GCHistory> get_gc_history(opts)
+
+Get gc results.
+
+This endpoint let user get gc execution history.
+
+### 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::GcApi.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
+}
+
+begin
+  #Get gc results.
+  result = api_instance.get_gc_history(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling GcApi->get_gc_history: #{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]
+
+### Return type
+
+[**Array<GCHistory>**](GCHistory.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_gc_log**
+> String get_gc_log(gc_id, opts)
+
+Get gc job log.
+
+This endpoint let user get gc job logs filtered 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::GcApi.new
+
+gc_id = 789 # Integer | The ID of the gc log
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get gc job log.
+  result = api_instance.get_gc_log(gc_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling GcApi->get_gc_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gc_id** | **Integer**| The ID of the gc log | 
+ **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
+
+
+
+# **get_gc_schedule**
+> GCHistory get_gc_schedule(opts)
+
+Get gc's schedule.
+
+This endpoint is for get schedule of gc job.
+
+### 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::GcApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Get gc's schedule.
+  result = api_instance.get_gc_schedule(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling GcApi->get_gc_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**GCHistory**](GCHistory.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_gc_schedule**
+> update_gc_schedule(schedule, opts)
+
+Update gc's schedule.
+
+This endpoint is for update gc schedule. 
+
+### 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::GcApi.new
+
+schedule = Harbor2Client::Schedule.new # Schedule | Updates of gc's schedule.
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Update gc's schedule.
+  api_instance.update_gc_schedule(schedule, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling GcApi->update_gc_schedule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **schedule** | [**Schedule**](Schedule.md)| Updates of gc's schedule. | 
+ **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/GeneralInfo.md

@@ -0,0 +1,20 @@
+# Harbor2Client::GeneralInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**with_notary** | **BOOLEAN** | If the Harbor instance is deployed with nested notary. | [optional] 
+**with_chartmuseum** | **BOOLEAN** | If the Harbor instance is deployed with nested chartmuseum. | [optional] 
+**registry_url** | **String** | The url of registry against which the docker command should be issued. | [optional] 
+**external_url** | **String** | The external URL of Harbor, with protocol. | [optional] 
+**auth_mode** | **String** | The auth mode of current Harbor instance. | [optional] 
+**project_creation_restriction** | **String** | Indicate who can create projects, it could be 'adminonly' or 'everyone'. | [optional] 
+**self_registration** | **BOOLEAN** | Indicate whether the Harbor instance enable user to register himself. | [optional] 
+**has_ca_root** | **BOOLEAN** | Indicate whether there is a ca root cert file ready for download in the file system. | [optional] 
+**harbor_version** | **String** | The build version of Harbor. | [optional] 
+**registry_storage_provider_name** | **String** | The storage provider's name of Harbor registry | [optional] 
+**read_only** | **BOOLEAN** | The flag to indicate whether Harbor is in readonly mode. | [optional] 
+**notification_enable** | **BOOLEAN** | The flag to indicate whether notification mechanism is enabled on Harbor instance. | [optional] 
+**authproxy_settings** | [**AuthproxySetting**](AuthproxySetting.md) | The setting of auth proxy this is only available when Harbor relies on authproxy for authentication. | [optional] 
+
+

data/docs/HealthApi.md

@@ -0,0 +1,63 @@
+# Harbor2Client::HealthApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_health**](HealthApi.md#get_health) | **GET** /health | Check the status of Harbor components
+
+
+# **get_health**
+> OverallHealthStatus get_health(opts)
+
+Check the status of Harbor components
+
+Check the status of Harbor 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::HealthApi.new
+
+opts = { 
+  x_request_id: 'x_request_id_example' # String | An unique ID for the request
+}
+
+begin
+  #Check the status of Harbor components
+  result = api_instance.get_health(opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling HealthApi->get_health: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **x_request_id** | **String**| An unique ID for the request | [optional] 
+
+### Return type
+
+[**OverallHealthStatus**](OverallHealthStatus.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ImmutableApi.md

@@ -0,0 +1,261 @@
+# Harbor2Client::ImmutableApi
+
+All URIs are relative to *http://localhost/api/v2.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_immu_rule**](ImmutableApi.md#create_immu_rule) | **POST** /projects/{project_name_or_id}/immutabletagrules | Add an immutable tag rule to current project
+[**delete_immu_rule**](ImmutableApi.md#delete_immu_rule) | **DELETE** /projects/{project_name_or_id}/immutabletagrules/{immutable_rule_id} | Delete the immutable tag rule.
+[**list_immu_rules**](ImmutableApi.md#list_immu_rules) | **GET** /projects/{project_name_or_id}/immutabletagrules | List all immutable tag rules of current project
+[**update_immu_rule**](ImmutableApi.md#update_immu_rule) | **PUT** /projects/{project_name_or_id}/immutabletagrules/{immutable_rule_id} | Update the immutable tag rule or enable or disable the rule
+
+
+# **create_immu_rule**
+> create_immu_rule(project_name_or_idimmutable_rule, opts)
+
+Add an immutable tag rule to current project
+
+This endpoint add an immutable tag rule to the 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::ImmutableApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+immutable_rule = Harbor2Client::ImmutableRule.new # ImmutableRule | 
+
+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
+  #Add an immutable tag rule to current project
+  api_instance.create_immu_rule(project_name_or_idimmutable_rule, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ImmutableApi->create_immu_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **immutable_rule** | [**ImmutableRule**](ImmutableRule.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
+
+
+
+# **delete_immu_rule**
+> delete_immu_rule(project_name_or_idimmutable_rule_id, opts)
+
+Delete the immutable tag rule.
+
+### 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::ImmutableApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+immutable_rule_id = 789 # Integer | The ID of the immutable rule
+
+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 the immutable tag rule.
+  api_instance.delete_immu_rule(project_name_or_idimmutable_rule_id, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ImmutableApi->delete_immu_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **immutable_rule_id** | **Integer**| The ID of the immutable rule | 
+ **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
+
+
+
+# **list_immu_rules**
+> Array<ImmutableRule> list_immu_rules(project_name_or_id, opts)
+
+List all immutable tag rules of current project
+
+This endpoint returns the immutable tag rules of a 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::ImmutableApi.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
+  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
+  #List all immutable tag rules of current project
+  result = api_instance.list_immu_rules(project_name_or_id, opts)
+  p result
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ImmutableApi->list_immu_rules: #{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]
+ **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
+
+[**Array<ImmutableRule>**](ImmutableRule.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_immu_rule**
+> update_immu_rule(project_name_or_idimmutable_rule_idimmutable_rule, opts)
+
+Update the immutable tag rule or enable or disable the rule
+
+### 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::ImmutableApi.new
+
+project_name_or_id = 'project_name_or_id_example' # String | The name or id of the project
+
+immutable_rule_id = 789 # Integer | The ID of the immutable rule
+
+immutable_rule = Harbor2Client::ImmutableRule.new # ImmutableRule | 
+
+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 the immutable tag rule or enable or disable the rule
+  api_instance.update_immu_rule(project_name_or_idimmutable_rule_idimmutable_rule, opts)
+rescue Harbor2Client::ApiError => e
+  puts "Exception when calling ImmutableApi->update_immu_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_name_or_id** | **String**| The name or id of the project | 
+ **immutable_rule_id** | **Integer**| The ID of the immutable rule | 
+ **immutable_rule** | [**ImmutableRule**](ImmutableRule.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
+
+
+