pulp_container_client 2.20.3 → 2.21.0

data/docs/ContentguardsHeaderApi.md

@@ -0,0 +1,607 @@
+# PulpContainerClient::ContentguardsHeaderApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**contentguards_core_header_add_role**](ContentguardsHeaderApi.md#contentguards_core_header_add_role) | **POST** {header_content_guard_href}add_role/ | Add a role
+[**contentguards_core_header_create**](ContentguardsHeaderApi.md#contentguards_core_header_create) | **POST** /pulp/api/v3/contentguards/core/header/ | Create a header content guard
+[**contentguards_core_header_delete**](ContentguardsHeaderApi.md#contentguards_core_header_delete) | **DELETE** {header_content_guard_href} | Delete a header content guard
+[**contentguards_core_header_list**](ContentguardsHeaderApi.md#contentguards_core_header_list) | **GET** /pulp/api/v3/contentguards/core/header/ | List header content guards
+[**contentguards_core_header_list_roles**](ContentguardsHeaderApi.md#contentguards_core_header_list_roles) | **GET** {header_content_guard_href}list_roles/ | List roles
+[**contentguards_core_header_my_permissions**](ContentguardsHeaderApi.md#contentguards_core_header_my_permissions) | **GET** {header_content_guard_href}my_permissions/ | List user permissions
+[**contentguards_core_header_partial_update**](ContentguardsHeaderApi.md#contentguards_core_header_partial_update) | **PATCH** {header_content_guard_href} | Update a header content guard
+[**contentguards_core_header_read**](ContentguardsHeaderApi.md#contentguards_core_header_read) | **GET** {header_content_guard_href} | Inspect a header content guard
+[**contentguards_core_header_remove_role**](ContentguardsHeaderApi.md#contentguards_core_header_remove_role) | **POST** {header_content_guard_href}remove_role/ | Remove a role
+[**contentguards_core_header_update**](ContentguardsHeaderApi.md#contentguards_core_header_update) | **PUT** {header_content_guard_href} | Update a header content guard
+
+
+
+## contentguards_core_header_add_role
+
+> NestedRoleResponse contentguards_core_header_add_role(header_content_guard_href, nested_role)
+
+Add a role
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+nested_role = PulpContainerClient::NestedRole.new # NestedRole | 
+
+begin
+  #Add a role
+  result = api_instance.contentguards_core_header_add_role(header_content_guard_href, nested_role)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## contentguards_core_header_create
+
+> HeaderContentGuardResponse contentguards_core_header_create(header_content_guard)
+
+Create a header content guard
+
+Content guard to protect the content app using a specific header.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard = PulpContainerClient::HeaderContentGuard.new # HeaderContentGuard | 
+
+begin
+  #Create a header content guard
+  result = api_instance.contentguards_core_header_create(header_content_guard)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard** | [**HeaderContentGuard**](HeaderContentGuard.md)|  | 
+
+### Return type
+
+[**HeaderContentGuardResponse**](HeaderContentGuardResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## contentguards_core_header_delete
+
+> contentguards_core_header_delete(header_content_guard_href)
+
+Delete a header content guard
+
+Content guard to protect the content app using a specific header.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+
+begin
+  #Delete a header content guard
+  api_instance.contentguards_core_header_delete(header_content_guard_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## contentguards_core_header_list
+
+> PaginatedHeaderContentGuardResponseList contentguards_core_header_list(opts)
+
+List header content guards
+
+Content guard to protect the content app using a specific header.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__iexact: 'name__iexact_example', # String | Filter results where name matches value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
+  name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
+  name__regex: 'name__regex_example', # String | Filter results where name matches regex value
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  q: 'q_example', # String | 
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List header content guards
+  result = api_instance.contentguards_core_header_list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__iexact** | **String**| Filter results where name matches value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__iregex** | **String**| Filter results where name matches regex value | [optional] 
+ **name__istartswith** | **String**| Filter results where name starts with value | [optional] 
+ **name__regex** | **String**| Filter results where name matches regex value | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **q** | **String**|  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedHeaderContentGuardResponseList**](PaginatedHeaderContentGuardResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contentguards_core_header_list_roles
+
+> ObjectRolesResponse contentguards_core_header_list_roles(header_content_guard_href, opts)
+
+List roles
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List roles
+  result = api_instance.contentguards_core_header_list_roles(header_content_guard_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contentguards_core_header_my_permissions
+
+> MyPermissionsResponse contentguards_core_header_my_permissions(header_content_guard_href, opts)
+
+List user permissions
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List user permissions
+  result = api_instance.contentguards_core_header_my_permissions(header_content_guard_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contentguards_core_header_partial_update
+
+> HeaderContentGuardResponse contentguards_core_header_partial_update(header_content_guard_href, patched_header_content_guard)
+
+Update a header content guard
+
+Content guard to protect the content app using a specific header.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+patched_header_content_guard = PulpContainerClient::PatchedHeaderContentGuard.new # PatchedHeaderContentGuard | 
+
+begin
+  #Update a header content guard
+  result = api_instance.contentguards_core_header_partial_update(header_content_guard_href, patched_header_content_guard)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **patched_header_content_guard** | [**PatchedHeaderContentGuard**](PatchedHeaderContentGuard.md)|  | 
+
+### Return type
+
+[**HeaderContentGuardResponse**](HeaderContentGuardResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## contentguards_core_header_read
+
+> HeaderContentGuardResponse contentguards_core_header_read(header_content_guard_href, opts)
+
+Inspect a header content guard
+
+Content guard to protect the content app using a specific header.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a header content guard
+  result = api_instance.contentguards_core_header_read(header_content_guard_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**HeaderContentGuardResponse**](HeaderContentGuardResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## contentguards_core_header_remove_role
+
+> NestedRoleResponse contentguards_core_header_remove_role(header_content_guard_href, nested_role)
+
+Remove a role
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+nested_role = PulpContainerClient::NestedRole.new # NestedRole | 
+
+begin
+  #Remove a role
+  result = api_instance.contentguards_core_header_remove_role(header_content_guard_href, nested_role)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## contentguards_core_header_update
+
+> HeaderContentGuardResponse contentguards_core_header_update(header_content_guard_href, header_content_guard)
+
+Update a header content guard
+
+Content guard to protect the content app using a specific header.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ContentguardsHeaderApi.new
+header_content_guard_href = 'header_content_guard_href_example' # String | 
+header_content_guard = PulpContainerClient::HeaderContentGuard.new # HeaderContentGuard | 
+
+begin
+  #Update a header content guard
+  result = api_instance.contentguards_core_header_update(header_content_guard_href, header_content_guard)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ContentguardsHeaderApi->contentguards_core_header_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **header_content_guard_href** | **String**|  | 
+ **header_content_guard** | [**HeaderContentGuard**](HeaderContentGuard.md)|  | 
+
+### Return type
+
+[**HeaderContentGuardResponse**](HeaderContentGuardResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+