pulpcore_client 3.20.0 → 3.21.0

data/docs/AcsApi.md

@@ -1,417 +0,0 @@
-# PulpcoreClient::AcsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](AcsApi.md#create) | **POST** /pulp/api/v3/acs/ | Create an alternate content source
-[**delete**](AcsApi.md#delete) | **DELETE** {alternate_content_source_href} | Delete an alternate content source
-[**list**](AcsApi.md#list) | **GET** /pulp/api/v3/acs/ | List acs
-[**partial_update**](AcsApi.md#partial_update) | **PATCH** {alternate_content_source_href} | Update an alternate content source
-[**read**](AcsApi.md#read) | **GET** {alternate_content_source_href} | Inspect an alternate content source
-[**refresh**](AcsApi.md#refresh) | **POST** {alternate_content_source_href}refresh/ | 
-[**update**](AcsApi.md#update) | **PUT** {alternate_content_source_href} | Update an alternate content source
-
-
-
-## create
-
-> AlternateContentSourceResponse create(alternate_content_source)
-
-Create an alternate content source
-
-A class for ACS viewset.
-
-### 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::AcsApi.new
-alternate_content_source = PulpcoreClient::AlternateContentSource.new # AlternateContentSource | 
-
-begin
-  #Create an alternate content source
-  result = api_instance.create(alternate_content_source)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **alternate_content_source** | [**AlternateContentSource**](AlternateContentSource.md)|  | 
-
-### Return type
-
-[**AlternateContentSourceResponse**](AlternateContentSourceResponse.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(alternate_content_source_href)
-
-Delete an alternate content source
-
-Trigger an asynchronous delete ACS 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::AcsApi.new
-alternate_content_source_href = 'alternate_content_source_href_example' # String | 
-
-begin
-  #Delete an alternate content source
-  result = api_instance.delete(alternate_content_source_href)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **alternate_content_source_href** | **String**|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list
-
-> PaginatedAlternateContentSourceResponseList list(opts)
-
-List acs
-
-A class for ACS viewset.
-
-### 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::AcsApi.new
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  name: 'name_example', # String | 
-  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__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
-  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
-  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
-  #List acs
-  result = api_instance.list(opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **name** | **String**|  | [optional] 
- **name__contains** | **String**| Filter results where name contains value | [optional] 
- **name__icontains** | **String**| Filter results where name contains value | [optional] 
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [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 | [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] 
-
-### Return type
-
-[**PaginatedAlternateContentSourceResponseList**](PaginatedAlternateContentSourceResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## partial_update
-
-> AsyncOperationResponse partial_update(alternate_content_source_href, patched_alternate_content_source)
-
-Update an alternate content source
-
-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::AcsApi.new
-alternate_content_source_href = 'alternate_content_source_href_example' # String | 
-patched_alternate_content_source = PulpcoreClient::PatchedAlternateContentSource.new # PatchedAlternateContentSource | 
-
-begin
-  #Update an alternate content source
-  result = api_instance.partial_update(alternate_content_source_href, patched_alternate_content_source)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **alternate_content_source_href** | **String**|  | 
- **patched_alternate_content_source** | [**PatchedAlternateContentSource**](PatchedAlternateContentSource.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
-
-> AlternateContentSourceResponse read(alternate_content_source_href, opts)
-
-Inspect an alternate content source
-
-A class for ACS viewset.
-
-### 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::AcsApi.new
-alternate_content_source_href = 'alternate_content_source_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 an alternate content source
-  result = api_instance.read(alternate_content_source_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **alternate_content_source_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
-
-[**AlternateContentSourceResponse**](AlternateContentSourceResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## refresh
-
-> AlternateContentSourceResponse refresh(alternate_content_source_href, alternate_content_source)
-
-
-
-A class for ACS viewset.
-
-### 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::AcsApi.new
-alternate_content_source_href = 'alternate_content_source_href_example' # String | 
-alternate_content_source = PulpcoreClient::AlternateContentSource.new # AlternateContentSource | 
-
-begin
-  result = api_instance.refresh(alternate_content_source_href, alternate_content_source)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->refresh: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **alternate_content_source_href** | **String**|  | 
- **alternate_content_source** | [**AlternateContentSource**](AlternateContentSource.md)|  | 
-
-### Return type
-
-[**AlternateContentSourceResponse**](AlternateContentSourceResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## update
-
-> AsyncOperationResponse update(alternate_content_source_href, alternate_content_source)
-
-Update an alternate content source
-
-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::AcsApi.new
-alternate_content_source_href = 'alternate_content_source_href_example' # String | 
-alternate_content_source = PulpcoreClient::AlternateContentSource.new # AlternateContentSource | 
-
-begin
-  #Update an alternate content source
-  result = api_instance.update(alternate_content_source_href, alternate_content_source)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling AcsApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **alternate_content_source_href** | **String**|  | 
- **alternate_content_source** | [**AlternateContentSource**](AlternateContentSource.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
-

data/docs/AlternateContentSource.md

@@ -1,23 +0,0 @@
-# PulpcoreClient::AlternateContentSource
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of Alternate Content Source. | 
-**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional] 
-**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] 
-**remote** | **String** | The remote to provide alternate content source. | 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::AlternateContentSource.new(name: null,
-                                 last_refreshed: null,
-                                 paths: null,
-                                 remote: null)
-```
-
-

data/docs/AlternateContentSourceResponse.md

@@ -1,27 +0,0 @@
-# PulpcoreClient::AlternateContentSourceResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**name** | **String** | Name of Alternate Content Source. | 
-**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional] 
-**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] 
-**remote** | **String** | The remote to provide alternate content source. | 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::AlternateContentSourceResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 last_refreshed: null,
-                                 paths: null,
-                                 remote: null)
-```
-
-

data/docs/ContentGuard.md

@@ -1,19 +0,0 @@
-# PulpcoreClient::ContentGuard
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The unique name. | 
-**description** | **String** | An optional description. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::ContentGuard.new(name: null,
-                                 description: null)
-```
-
-

data/docs/Distribution.md

@@ -1,25 +0,0 @@
-# PulpcoreClient::Distribution
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | 
-**content_guard** | **String** | An optional content-guard. | [optional] 
-**pulp_labels** | [**Object**](.md) |  | [optional] 
-**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
-**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::Distribution.new(base_path: null,
-                                 content_guard: null,
-                                 pulp_labels: null,
-                                 name: null,
-                                 repository: null)
-```
-
-

data/docs/Export.md

@@ -1,17 +0,0 @@
-# PulpcoreClient::Export
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task** | **String** | A URI of the task that ran the Export. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::Export.new(task: null)
-```
-
-

data/docs/ExportResponse.md

@@ -1,25 +0,0 @@
-# PulpcoreClient::ExportResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**task** | **String** | A URI of the task that ran the Export. | [optional] 
-**exported_resources** | **Array<String>** | Resources that were exported. | [optional] [readonly] 
-**params** | [**Object**](.md) | Any additional parameters that were used to create the export. | [optional] [readonly] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::ExportResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 task: null,
-                                 exported_resources: null,
-                                 params: null)
-```
-
-

data/docs/Exporter.md

@@ -1,17 +0,0 @@
-# PulpcoreClient::Exporter
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Unique name of the file system exporter. | 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::Exporter.new(name: null)
-```
-
-

data/docs/ExporterResponse.md

@@ -1,21 +0,0 @@
-# PulpcoreClient::ExporterResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**name** | **String** | Unique name of the file system exporter. | 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::ExporterResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null)
-```
-
-