pulp_rpm_client 3.18.21 → 3.19.0.dev1675307375

data/docs/ExportersFilesystemApi.md

@@ -1,366 +0,0 @@
-# PulpRpmClient::ExportersFilesystemApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersFilesystemApi.md#create) | **POST** /pulp/api/v3/exporters/core/filesystem/ | Create a filesystem exporter
-[**delete**](ExportersFilesystemApi.md#delete) | **DELETE** {filesystem_exporter_href} | Delete a filesystem exporter
-[**list**](ExportersFilesystemApi.md#list) | **GET** /pulp/api/v3/exporters/core/filesystem/ | List filesystem exporters
-[**partial_update**](ExportersFilesystemApi.md#partial_update) | **PATCH** {filesystem_exporter_href} | Update a filesystem exporter
-[**read**](ExportersFilesystemApi.md#read) | **GET** {filesystem_exporter_href} | Inspect a filesystem exporter
-[**update**](ExportersFilesystemApi.md#update) | **PUT** {filesystem_exporter_href} | Update a filesystem exporter
-
-
-
-## create
-
-> FilesystemExporterResponse create(filesystem_exporter)
-
-Create a filesystem exporter
-
-Endpoint for managing FilesystemExporters.
-
-### 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::ExportersFilesystemApi.new
-filesystem_exporter = PulpRpmClient::FilesystemExporter.new # FilesystemExporter | 
-
-begin
-  #Create a filesystem exporter
-  result = api_instance.create(filesystem_exporter)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_exporter** | [**FilesystemExporter**](FilesystemExporter.md)|  | 
-
-### Return type
-
-[**FilesystemExporterResponse**](FilesystemExporterResponse.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(filesystem_exporter_href)
-
-Delete a filesystem 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::ExportersFilesystemApi.new
-filesystem_exporter_href = 'filesystem_exporter_href_example' # String | 
-
-begin
-  #Delete a filesystem exporter
-  result = api_instance.delete(filesystem_exporter_href)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_exporter_href** | **String**|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list
-
-> PaginatedFilesystemExporterResponseList list(opts)
-
-List filesystem exporters
-
-Endpoint for managing FilesystemExporters.
-
-### 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::ExportersFilesystemApi.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) * `method` - Method * `-method` - Method (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 filesystem exporters
-  result = api_instance.list(opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemApi->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;method&#x60; - Method * &#x60;-method&#x60; - Method (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
-
-[**PaginatedFilesystemExporterResponseList**](PaginatedFilesystemExporterResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## partial_update
-
-> AsyncOperationResponse partial_update(filesystem_exporter_href, patched_filesystem_exporter)
-
-Update a filesystem 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::ExportersFilesystemApi.new
-filesystem_exporter_href = 'filesystem_exporter_href_example' # String | 
-patched_filesystem_exporter = PulpRpmClient::PatchedFilesystemExporter.new # PatchedFilesystemExporter | 
-
-begin
-  #Update a filesystem exporter
-  result = api_instance.partial_update(filesystem_exporter_href, patched_filesystem_exporter)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_exporter_href** | **String**|  | 
- **patched_filesystem_exporter** | [**PatchedFilesystemExporter**](PatchedFilesystemExporter.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
-
-> FilesystemExporterResponse read(filesystem_exporter_href, opts)
-
-Inspect a filesystem exporter
-
-Endpoint for managing FilesystemExporters.
-
-### 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::ExportersFilesystemApi.new
-filesystem_exporter_href = 'filesystem_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 filesystem exporter
-  result = api_instance.read(filesystem_exporter_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_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
-
-[**FilesystemExporterResponse**](FilesystemExporterResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> AsyncOperationResponse update(filesystem_exporter_href, filesystem_exporter)
-
-Update a filesystem 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::ExportersFilesystemApi.new
-filesystem_exporter_href = 'filesystem_exporter_href_example' # String | 
-filesystem_exporter = PulpRpmClient::FilesystemExporter.new # FilesystemExporter | 
-
-begin
-  #Update a filesystem exporter
-  result = api_instance.update(filesystem_exporter_href, filesystem_exporter)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_exporter_href** | **String**|  | 
- **filesystem_exporter** | [**FilesystemExporter**](FilesystemExporter.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/ExportersFilesystemExportsApi.md

@@ -1,241 +0,0 @@
-# PulpRpmClient::ExportersFilesystemExportsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ExportersFilesystemExportsApi.md#create) | **POST** {filesystem_exporter_href}exports/ | Create a filesystem export
-[**delete**](ExportersFilesystemExportsApi.md#delete) | **DELETE** {filesystem_filesystem_export_href} | Delete a filesystem export
-[**list**](ExportersFilesystemExportsApi.md#list) | **GET** {filesystem_exporter_href}exports/ | List filesystem exports
-[**read**](ExportersFilesystemExportsApi.md#read) | **GET** {filesystem_filesystem_export_href} | Inspect a filesystem export
-
-
-
-## create
-
-> AsyncOperationResponse create(filesystem_exporter_href, filesystem_export)
-
-Create a filesystem export
-
-Trigger an asynchronous task to export files to the filesystem
-
-### 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::ExportersFilesystemExportsApi.new
-filesystem_exporter_href = 'filesystem_exporter_href_example' # String | 
-filesystem_export = PulpRpmClient::FilesystemExport.new # FilesystemExport | 
-
-begin
-  #Create a filesystem export
-  result = api_instance.create(filesystem_exporter_href, filesystem_export)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_exporter_href** | **String**|  | 
- **filesystem_export** | [**FilesystemExport**](FilesystemExport.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(filesystem_filesystem_export_href)
-
-Delete a filesystem export
-
-Endpoint for managing FilesystemExports.
-
-### 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::ExportersFilesystemExportsApi.new
-filesystem_filesystem_export_href = 'filesystem_filesystem_export_href_example' # String | 
-
-begin
-  #Delete a filesystem export
-  api_instance.delete(filesystem_filesystem_export_href)
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_filesystem_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
-
-> PaginatedFilesystemExportResponseList list(filesystem_exporter_href, opts)
-
-List filesystem exports
-
-Endpoint for managing FilesystemExports.
-
-### 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::ExportersFilesystemExportsApi.new
-filesystem_exporter_href = 'filesystem_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 filesystem exports
-  result = api_instance.list(filesystem_exporter_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_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
-
-[**PaginatedFilesystemExportResponseList**](PaginatedFilesystemExportResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## read
-
-> FilesystemExportResponse read(filesystem_filesystem_export_href, opts)
-
-Inspect a filesystem export
-
-Endpoint for managing FilesystemExports.
-
-### 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::ExportersFilesystemExportsApi.new
-filesystem_filesystem_export_href = 'filesystem_filesystem_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 filesystem export
-  result = api_instance.read(filesystem_filesystem_export_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ExportersFilesystemExportsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filesystem_filesystem_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
-
-[**FilesystemExportResponse**](FilesystemExportResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-