pulpcore_client 3.20.0 → 3.21.0

data/docs/ImportersApi.md

@@ -1,361 +0,0 @@
-# PulpcoreClient::ImportersApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ImportersApi.md#create) | **POST** /pulp/api/v3/importers/ | Create an importer
-[**delete**](ImportersApi.md#delete) | **DELETE** {importer_href} | Delete an importer
-[**list**](ImportersApi.md#list) | **GET** /pulp/api/v3/importers/ | List importers
-[**partial_update**](ImportersApi.md#partial_update) | **PATCH** {importer_href} | Update an importer
-[**read**](ImportersApi.md#read) | **GET** {importer_href} | Inspect an importer
-[**update**](ImportersApi.md#update) | **PUT** {importer_href} | Update an importer
-
-
-
-## create
-
-> ImporterResponse create(importer)
-
-Create an importer
-
-ViewSet for Importers.
-
-### 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::ImportersApi.new
-importer = PulpcoreClient::Importer.new # Importer | 
-
-begin
-  #Create an importer
-  result = api_instance.create(importer)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer** | [**Importer**](Importer.md)|  | 
-
-### Return type
-
-[**ImporterResponse**](ImporterResponse.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(importer_href)
-
-Delete an importer
-
-ViewSet for Importers.
-
-### 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::ImportersApi.new
-importer_href = 'importer_href_example' # String | 
-
-begin
-  #Delete an importer
-  api_instance.delete(importer_href)
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## list
-
-> PaginatedImporterResponseList list(opts)
-
-List importers
-
-ViewSet for Importers.
-
-### 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::ImportersApi.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 importers
-  result = api_instance.list(opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersApi->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
-
-[**PaginatedImporterResponseList**](PaginatedImporterResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## partial_update
-
-> ImporterResponse partial_update(importer_href, patched_importer)
-
-Update an importer
-
-ViewSet for Importers.
-
-### 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::ImportersApi.new
-importer_href = 'importer_href_example' # String | 
-patched_importer = PulpcoreClient::PatchedImporter.new # PatchedImporter | 
-
-begin
-  #Update an importer
-  result = api_instance.partial_update(importer_href, patched_importer)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer_href** | **String**|  | 
- **patched_importer** | [**PatchedImporter**](PatchedImporter.md)|  | 
-
-### Return type
-
-[**ImporterResponse**](ImporterResponse.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
-
-> ImporterResponse read(importer_href, opts)
-
-Inspect an importer
-
-ViewSet for Importers.
-
-### 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::ImportersApi.new
-importer_href = 'importer_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 importer
-  result = api_instance.read(importer_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer_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
-
-[**ImporterResponse**](ImporterResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> ImporterResponse update(importer_href, importer)
-
-Update an importer
-
-ViewSet for Importers.
-
-### 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::ImportersApi.new
-importer_href = 'importer_href_example' # String | 
-importer = PulpcoreClient::Importer.new # Importer | 
-
-begin
-  #Update an importer
-  result = api_instance.update(importer_href, importer)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer_href** | **String**|  | 
- **importer** | [**Importer**](Importer.md)|  | 
-
-### Return type
-
-[**ImporterResponse**](ImporterResponse.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/ImportersImportsApi.md

@@ -1,241 +0,0 @@
-# PulpcoreClient::ImportersImportsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ImportersImportsApi.md#create) | **POST** {importer_href}imports/ | Create an import
-[**delete**](ImportersImportsApi.md#delete) | **DELETE** {importers_import_href} | Delete an import
-[**list**](ImportersImportsApi.md#list) | **GET** {importer_href}imports/ | List imports
-[**read**](ImportersImportsApi.md#read) | **GET** {importers_import_href} | Inspect an import
-
-
-
-## create
-
-> ImportResponse create(importer_href, import)
-
-Create an import
-
-ViewSet for viewing imports from an Importer.
-
-### 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::ImportersImportsApi.new
-importer_href = 'importer_href_example' # String | 
-import = PulpcoreClient::Import.new # Import | 
-
-begin
-  #Create an import
-  result = api_instance.create(importer_href, import)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersImportsApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer_href** | **String**|  | 
- **import** | [**Import**](Import.md)|  | 
-
-### Return type
-
-[**ImportResponse**](ImportResponse.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(importers_import_href)
-
-Delete an import
-
-ViewSet for viewing imports from an Importer.
-
-### 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::ImportersImportsApi.new
-importers_import_href = 'importers_import_href_example' # String | 
-
-begin
-  #Delete an import
-  api_instance.delete(importers_import_href)
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersImportsApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importers_import_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## list
-
-> PaginatedImportResponseList list(importer_href, opts)
-
-List imports
-
-ViewSet for viewing imports from an Importer.
-
-### 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::ImportersImportsApi.new
-importer_href = 'importer_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', # 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 imports
-  result = api_instance.list(importer_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersImportsApi->list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importer_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** | **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
-
-[**PaginatedImportResponseList**](PaginatedImportResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## read
-
-> ImportResponse read(importers_import_href, opts)
-
-Inspect an import
-
-ViewSet for viewing imports from an Importer.
-
-### 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::ImportersImportsApi.new
-importers_import_href = 'importers_import_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 import
-  result = api_instance.read(importers_import_href, opts)
-  p result
-rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling ImportersImportsApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **importers_import_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
-
-[**ImportResponse**](ImportResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/MultipleArtifactContent.md

@@ -1,17 +0,0 @@
-# PulpcoreClient::MultipleArtifactContent
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**artifacts** | [**Object**](.md) | A dict mapping relative paths inside the Content to the correspondingArtifact URLs. E.g.: {'relative/path': '/artifacts/1/' | 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::MultipleArtifactContent.new(artifacts: null)
-```
-
-

data/docs/PaginatedAlternateContentSourceResponseList.md

@@ -1,23 +0,0 @@
-# PulpcoreClient::PaginatedAlternateContentSourceResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<AlternateContentSourceResponse>**](AlternateContentSourceResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::PaginatedAlternateContentSourceResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
-```
-
-

data/docs/PaginatedExportResponseList.md

@@ -1,23 +0,0 @@
-# PulpcoreClient::PaginatedExportResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<ExportResponse>**](ExportResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::PaginatedExportResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
-```
-
-

data/docs/PaginatedExporterResponseList.md

@@ -1,23 +0,0 @@
-# PulpcoreClient::PaginatedExporterResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<ExporterResponse>**](ExporterResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::PaginatedExporterResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
-```
-
-

data/docs/PaginatedImporterResponseList.md

@@ -1,23 +0,0 @@
-# PulpcoreClient::PaginatedImporterResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<ImporterResponse>**](ImporterResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpcoreClient'
-
-instance = PulpcoreClient::PaginatedImporterResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
-```
-
-