pulpcore_client 3.20.0 → 3.21.0

data/docs/ContentguardsApi.md

@@ -4,127 +4,17 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](ContentguardsApi.md#create) | **POST** /pulp/api/v3/contentguards/ | Create a content guard
-[**delete**](ContentguardsApi.md#delete) | **DELETE** {content_guard_href} | Delete a content guard
 [**list**](ContentguardsApi.md#list) | **GET** /pulp/api/v3/contentguards/ | List content guards
-[**partial_update**](ContentguardsApi.md#partial_update) | **PATCH** {content_guard_href} | Update a content guard
-[**read**](ContentguardsApi.md#read) | **GET** {content_guard_href} | Inspect a content guard
-[**update**](ContentguardsApi.md#update) | **PUT** {content_guard_href} | Update a content guard
 
 
 
-## create
-
-> ContentGuardResponse create(content_guard)
-
-Create a content guard
-
-A viewset for contentguards.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::ContentguardsApi.new
-content_guard = PulpcoreClient::ContentGuard.new # ContentGuard | 
-
-begin
-  #Create a content guard
-  result = api_instance.create(content_guard)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ContentguardsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content_guard** | [**ContentGuard**](ContentGuard.md)|  | 
-
-### Return type
-
-[**ContentGuardResponse**](ContentGuardResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## delete
-
-> delete(content_guard_href)
-
-Delete a content guard
-
-A viewset for contentguards.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::ContentguardsApi.new
-content_guard_href = 'content_guard_href_example' # String | 
-
-begin
-  #Delete a content guard
-  api_instance.delete(content_guard_href)
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ContentguardsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **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
-
-
 ## list
 
 > PaginatedContentGuardResponseList list(opts)
 
 List content guards
 
-A viewset for contentguards.
+Endpoint to list all contentguards.
 
 ### Example
 
@@ -190,172 +80,3 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## partial_update
-
-> ContentGuardResponse partial_update(content_guard_href, patched_content_guard)
-
-Update a content guard
-
-A viewset for contentguards.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::ContentguardsApi.new
-content_guard_href = 'content_guard_href_example' # String | 
-patched_content_guard = PulpcoreClient::PatchedContentGuard.new # PatchedContentGuard | 
-
-begin
-  #Update a content guard
-  result = api_instance.partial_update(content_guard_href, patched_content_guard)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ContentguardsApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content_guard_href** | **String**|  | 
- **patched_content_guard** | [**PatchedContentGuard**](PatchedContentGuard.md)|  | 
-
-### Return type
-
-[**ContentGuardResponse**](ContentGuardResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## read
-
-> ContentGuardResponse read(content_guard_href, opts)
-
-Inspect a content guard
-
-A viewset for contentguards.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::ContentguardsApi.new
-content_guard_href = 'content_guard_href_example' # String | 
-opts = {
-  fields: 'fields_example', # String | A list of fields to include in the response.
-  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
-}
-
-begin
-  #Inspect a content guard
-  result = api_instance.read(content_guard_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ContentguardsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content_guard_href** | **String**|  | 
- **fields** | **String**| A list of fields to include in the response. | [optional] 
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-[**ContentGuardResponse**](ContentGuardResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> ContentGuardResponse update(content_guard_href, content_guard)
-
-Update a content guard
-
-A viewset for contentguards.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::ContentguardsApi.new
-content_guard_href = 'content_guard_href_example' # String | 
-content_guard = PulpcoreClient::ContentGuard.new # ContentGuard | 
-
-begin
-  #Update a content guard
-  result = api_instance.update(content_guard_href, content_guard)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ContentguardsApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content_guard_href** | **String**|  | 
- **content_guard** | [**ContentGuard**](ContentGuard.md)|  | 
-
-### Return type
-
-[**ContentGuardResponse**](ContentGuardResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-

data/docs/DistributionsApi.md

@@ -4,128 +4,17 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](DistributionsApi.md#create) | **POST** /pulp/api/v3/distributions/ | Create a distribution
-[**delete**](DistributionsApi.md#delete) | **DELETE** {distribution_href} | Delete a distribution
 [**list**](DistributionsApi.md#list) | **GET** /pulp/api/v3/distributions/ | List distributions
-[**partial_update**](DistributionsApi.md#partial_update) | **PATCH** {distribution_href} | Update a distribution
-[**read**](DistributionsApi.md#read) | **GET** {distribution_href} | Inspect a distribution
-[**update**](DistributionsApi.md#update) | **PUT** {distribution_href} | Update a distribution
 
 
 
-## create
-
-> AsyncOperationResponse create(distribution)
-
-Create a distribution
-
-Trigger an asynchronous create task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::DistributionsApi.new
-distribution = PulpcoreClient::Distribution.new # Distribution | 
-
-begin
-  #Create a distribution
-  result = api_instance.create(distribution)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling DistributionsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distribution** | [**Distribution**](Distribution.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## delete
-
-> AsyncOperationResponse delete(distribution_href)
-
-Delete a distribution
-
-Trigger an asynchronous delete task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::DistributionsApi.new
-distribution_href = 'distribution_href_example' # String | 
-
-begin
-  #Delete a distribution
-  result = api_instance.delete(distribution_href)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling DistributionsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distribution_href** | **String**|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## list
 
 > PaginatedDistributionResponseList list(opts)
 
 List distributions
 
-Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
+A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
 
 ### Example
 
@@ -154,6 +43,7 @@ opts = {
   offset: 56, # Integer | The initial index from which to return the results.
   ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  with_content: 'with_content_example', # String | Filter distributions based on the content served by them
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
 }
@@ -185,6 +75,7 @@ Name | Type | Description  | Notes
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
  **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_label_select** | **String**| Filter labels by search string | [optional] 
+ **with_content** | **String**| Filter distributions based on the content served by them | [optional] 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 
@@ -201,172 +92,3 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## partial_update
-
-> AsyncOperationResponse partial_update(distribution_href, patched_distribution)
-
-Update a distribution
-
-Trigger an asynchronous partial update task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::DistributionsApi.new
-distribution_href = 'distribution_href_example' # String | 
-patched_distribution = PulpcoreClient::PatchedDistribution.new # PatchedDistribution | 
-
-begin
-  #Update a distribution
-  result = api_instance.partial_update(distribution_href, patched_distribution)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling DistributionsApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distribution_href** | **String**|  | 
- **patched_distribution** | [**PatchedDistribution**](PatchedDistribution.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## read
-
-> DistributionResponse read(distribution_href, opts)
-
-Inspect a distribution
-
-Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::DistributionsApi.new
-distribution_href = 'distribution_href_example' # String | 
-opts = {
-  fields: 'fields_example', # String | A list of fields to include in the response.
-  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
-}
-
-begin
-  #Inspect a distribution
-  result = api_instance.read(distribution_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling DistributionsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distribution_href** | **String**|  | 
- **fields** | **String**| A list of fields to include in the response. | [optional] 
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-[**DistributionResponse**](DistributionResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> AsyncOperationResponse update(distribution_href, distribution)
-
-Update a distribution
-
-Trigger an asynchronous update task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpcoreClient::DistributionsApi.new
-distribution_href = 'distribution_href_example' # String | 
-distribution = PulpcoreClient::Distribution.new # Distribution | 
-
-begin
-  #Update a distribution
-  result = api_instance.update(distribution_href, distribution)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling DistributionsApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distribution_href** | **String**|  | 
- **distribution** | [**Distribution**](Distribution.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-