pulp_rpm_client 3.18.21 → 3.19.0.dev1675221420

data/docs/ExportersPulpApi.md

@@ -1,366 +0,0 @@
-# PulpRpmClient::ExportersPulpApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersPulpApi.md#create) | **POST** /pulp/api/v3/exporters/core/pulp/ | Create a pulp exporter
-[**delete**](ExportersPulpApi.md#delete) | **DELETE** {pulp_exporter_href} | Delete a pulp exporter
-[**list**](ExportersPulpApi.md#list) | **GET** /pulp/api/v3/exporters/core/pulp/ | List pulp exporters
-[**partial_update**](ExportersPulpApi.md#partial_update) | **PATCH** {pulp_exporter_href} | Update a pulp exporter
-[**read**](ExportersPulpApi.md#read) | **GET** {pulp_exporter_href} | Inspect a pulp exporter
-[**update**](ExportersPulpApi.md#update) | **PUT** {pulp_exporter_href} | Update a pulp exporter
-
-
-
-## create
-
-> PulpExporterResponse create(pulp_exporter)
-
-Create a pulp exporter
-
-ViewSet for viewing PulpExporters.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpApi.new
-pulp_exporter = PulpRpmClient::PulpExporter.new # PulpExporter | 
-
-begin
-  #Create a pulp exporter
-  result = api_instance.create(pulp_exporter)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter** | [**PulpExporter**](PulpExporter.md)|  | 
-
-### Return type
-
-[**PulpExporterResponse**](PulpExporterResponse.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(pulp_exporter_href)
-
-Delete a pulp exporter
-
-Trigger an asynchronous delete task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpApi.new
-pulp_exporter_href = 'pulp_exporter_href_example' # String | 
-
-begin
-  #Delete a pulp exporter
-  result = api_instance.delete(pulp_exporter_href)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list
-
-> PaginatedPulpExporterResponseList list(opts)
-
-List pulp exporters
-
-ViewSet for viewing PulpExporters.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpApi.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__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  * `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) * `path` - Path * `-path` - Path (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.
-  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 pulp exporters
-  result = api_instance.list(opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->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__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  * &#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;path&#x60; - Path * &#x60;-path&#x60; - Path (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] 
- **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
-
-[**PaginatedPulpExporterResponseList**](PaginatedPulpExporterResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## partial_update
-
-> AsyncOperationResponse partial_update(pulp_exporter_href, patched_pulp_exporter)
-
-Update a pulp exporter
-
-Trigger an asynchronous partial update task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpApi.new
-pulp_exporter_href = 'pulp_exporter_href_example' # String | 
-patched_pulp_exporter = PulpRpmClient::PatchedPulpExporter.new # PatchedPulpExporter | 
-
-begin
-  #Update a pulp exporter
-  result = api_instance.partial_update(pulp_exporter_href, patched_pulp_exporter)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
- **patched_pulp_exporter** | [**PatchedPulpExporter**](PatchedPulpExporter.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
-
-> PulpExporterResponse read(pulp_exporter_href, opts)
-
-Inspect a pulp exporter
-
-ViewSet for viewing PulpExporters.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpApi.new
-pulp_exporter_href = 'pulp_exporter_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 pulp exporter
-  result = api_instance.read(pulp_exporter_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_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
-
-[**PulpExporterResponse**](PulpExporterResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> AsyncOperationResponse update(pulp_exporter_href, pulp_exporter)
-
-Update a pulp exporter
-
-Trigger an asynchronous update task
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpApi.new
-pulp_exporter_href = 'pulp_exporter_href_example' # String | 
-pulp_exporter = PulpRpmClient::PulpExporter.new # PulpExporter | 
-
-begin
-  #Update a pulp exporter
-  result = api_instance.update(pulp_exporter_href, pulp_exporter)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
- **pulp_exporter** | [**PulpExporter**](PulpExporter.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/ExportersPulpExportsApi.md

@@ -1,241 +0,0 @@
-# PulpRpmClient::ExportersPulpExportsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersPulpExportsApi.md#create) | **POST** {pulp_exporter_href}exports/ | Create a pulp export
-[**delete**](ExportersPulpExportsApi.md#delete) | **DELETE** {pulp_pulp_export_href} | Delete a pulp export
-[**list**](ExportersPulpExportsApi.md#list) | **GET** {pulp_exporter_href}exports/ | List pulp exports
-[**read**](ExportersPulpExportsApi.md#read) | **GET** {pulp_pulp_export_href} | Inspect a pulp export
-
-
-
-## create
-
-> AsyncOperationResponse create(pulp_exporter_href, pulp_export)
-
-Create a pulp export
-
-Trigger an asynchronous task to export a set of repositories
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpExportsApi.new
-pulp_exporter_href = 'pulp_exporter_href_example' # String | 
-pulp_export = PulpRpmClient::PulpExport.new # PulpExport | 
-
-begin
-  #Create a pulp export
-  result = api_instance.create(pulp_exporter_href, pulp_export)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpExportsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
- **pulp_export** | [**PulpExport**](PulpExport.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
-
-> delete(pulp_pulp_export_href)
-
-Delete a pulp export
-
-ViewSet for viewing exports from a PulpExporter.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpExportsApi.new
-pulp_pulp_export_href = 'pulp_pulp_export_href_example' # String | 
-
-begin
-  #Delete a pulp export
-  api_instance.delete(pulp_pulp_export_href)
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpExportsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_pulp_export_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## list
-
-> PaginatedPulpExportResponseList list(pulp_exporter_href, opts)
-
-List pulp exports
-
-ViewSet for viewing exports from a PulpExporter.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpExportsApi.new
-pulp_exporter_href = 'pulp_exporter_href_example' # String | 
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  offset: 56, # Integer | The initial index from which to return the results.
-  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 pulp exports
-  result = api_instance.list(pulp_exporter_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpExportsApi->list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_exporter_href** | **String**|  | 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [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
-
-[**PaginatedPulpExportResponseList**](PaginatedPulpExportResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## read
-
-> PulpExportResponse read(pulp_pulp_export_href, opts)
-
-Inspect a pulp export
-
-ViewSet for viewing exports from a PulpExporter.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::ExportersPulpExportsApi.new
-pulp_pulp_export_href = 'pulp_pulp_export_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 pulp export
-  result = api_instance.read(pulp_pulp_export_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersPulpExportsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **pulp_pulp_export_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
-
-[**PulpExportResponse**](PulpExportResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/FilesystemExport.md

@@ -1,23 +0,0 @@
-# PulpRpmClient::FilesystemExport
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task** | **String** | A URI of the task that ran the Export. | [optional] 
-**publication** | **String** | A URI of the publication to be exported. | [optional] 
-**repository_version** | **String** | A URI of the repository version export. | [optional] 
-**start_repository_version** | **String** | The URI of the last-exported-repo-version. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::FilesystemExport.new(task: null,
-                                 publication: null,
-                                 repository_version: null,
-                                 start_repository_version: null)
-```
-
-

data/docs/FilesystemExportResponse.md

@@ -1,25 +0,0 @@
-# PulpRpmClient::FilesystemExportResponse
-
-## 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 'PulpRpmClient'
-
-instance = PulpRpmClient::FilesystemExportResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 task: null,
-                                 exported_resources: null,
-                                 params: null)
-```
-
-

data/docs/FilesystemExporter.md

@@ -1,21 +0,0 @@
-# PulpRpmClient::FilesystemExporter
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Unique name of the file system exporter. | 
-**path** | **String** | File system location to export to. | 
-**method** | [**MethodEnum**](MethodEnum.md) | Method of exporting  * `write` - Export by writing * `hardlink` - Export by hardlinking * `symlink` - Export by symlinking | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::FilesystemExporter.new(name: null,
-                                 path: null,
-                                 method: null)
-```
-
-

data/docs/FilesystemExporterResponse.md

@@ -1,25 +0,0 @@
-# PulpRpmClient::FilesystemExporterResponse
-
-## 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. | 
-**path** | **String** | File system location to export to. | 
-**method** | [**MethodEnum**](MethodEnum.md) | Method of exporting  * `write` - Export by writing * `hardlink` - Export by hardlinking * `symlink` - Export by symlinking | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::FilesystemExporterResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 path: null,
-                                 method: null)
-```
-
-