pulp_container_client 2.20.2 → 2.21.0

data/docs/ImportersPulpApi.md

@@ -0,0 +1,375 @@
+# PulpContainerClient::ImportersPulpApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**importers_core_pulp_create**](ImportersPulpApi.md#importers_core_pulp_create) | **POST** /pulp/api/v3/importers/core/pulp/ | Create a pulp importer
+[**importers_core_pulp_delete**](ImportersPulpApi.md#importers_core_pulp_delete) | **DELETE** {pulp_importer_href} | Delete a pulp importer
+[**importers_core_pulp_list**](ImportersPulpApi.md#importers_core_pulp_list) | **GET** /pulp/api/v3/importers/core/pulp/ | List pulp importers
+[**importers_core_pulp_partial_update**](ImportersPulpApi.md#importers_core_pulp_partial_update) | **PATCH** {pulp_importer_href} | Update a pulp importer
+[**importers_core_pulp_read**](ImportersPulpApi.md#importers_core_pulp_read) | **GET** {pulp_importer_href} | Inspect a pulp importer
+[**importers_core_pulp_update**](ImportersPulpApi.md#importers_core_pulp_update) | **PUT** {pulp_importer_href} | Update a pulp importer
+
+
+
+## importers_core_pulp_create
+
+> PulpImporterResponse importers_core_pulp_create(pulp_importer)
+
+Create a pulp importer
+
+ViewSet for PulpImporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpApi.new
+pulp_importer = PulpContainerClient::PulpImporter.new # PulpImporter | 
+
+begin
+  #Create a pulp importer
+  result = api_instance.importers_core_pulp_create(pulp_importer)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->importers_core_pulp_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer** | [**PulpImporter**](PulpImporter.md)|  | 
+
+### Return type
+
+[**PulpImporterResponse**](PulpImporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## importers_core_pulp_delete
+
+> importers_core_pulp_delete(pulp_importer_href)
+
+Delete a pulp importer
+
+ViewSet for PulpImporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | 
+
+begin
+  #Delete a pulp importer
+  api_instance.importers_core_pulp_delete(pulp_importer_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->importers_core_pulp_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## importers_core_pulp_list
+
+> PaginatedPulpImporterResponseList importers_core_pulp_list(opts)
+
+List pulp importers
+
+ViewSet for PulpImporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpApi.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__iexact: 'name__iexact_example', # String | Filter results where name matches value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
+  name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
+  name__regex: 'name__regex_example', # String | Filter results where name matches regex value
+  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) * `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.
+  q: 'q_example', # String | 
+  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 importers
+  result = api_instance.importers_core_pulp_list(opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->importers_core_pulp_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__iexact** | **String**| Filter results where name matches value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__iregex** | **String**| Filter results where name matches regex value | [optional] 
+ **name__istartswith** | **String**| Filter results where name starts with value | [optional] 
+ **name__regex** | **String**| Filter results where name matches regex value | [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;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] 
+ **q** | **String**|  | [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
+
+[**PaginatedPulpImporterResponseList**](PaginatedPulpImporterResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## importers_core_pulp_partial_update
+
+> PulpImporterResponse importers_core_pulp_partial_update(pulp_importer_href, patched_pulp_importer)
+
+Update a pulp importer
+
+ViewSet for PulpImporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | 
+patched_pulp_importer = PulpContainerClient::PatchedPulpImporter.new # PatchedPulpImporter | 
+
+begin
+  #Update a pulp importer
+  result = api_instance.importers_core_pulp_partial_update(pulp_importer_href, patched_pulp_importer)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->importers_core_pulp_partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**|  | 
+ **patched_pulp_importer** | [**PatchedPulpImporter**](PatchedPulpImporter.md)|  | 
+
+### Return type
+
+[**PulpImporterResponse**](PulpImporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## importers_core_pulp_read
+
+> PulpImporterResponse importers_core_pulp_read(pulp_importer_href, opts)
+
+Inspect a pulp importer
+
+ViewSet for PulpImporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_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 importer
+  result = api_instance.importers_core_pulp_read(pulp_importer_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->importers_core_pulp_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_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
+
+[**PulpImporterResponse**](PulpImporterResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## importers_core_pulp_update
+
+> PulpImporterResponse importers_core_pulp_update(pulp_importer_href, pulp_importer)
+
+Update a pulp importer
+
+ViewSet for PulpImporters.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | 
+pulp_importer = PulpContainerClient::PulpImporter.new # PulpImporter | 
+
+begin
+  #Update a pulp importer
+  result = api_instance.importers_core_pulp_update(pulp_importer_href, pulp_importer)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpApi->importers_core_pulp_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**|  | 
+ **pulp_importer** | [**PulpImporter**](PulpImporter.md)|  | 
+
+### Return type
+
+[**PulpImporterResponse**](PulpImporterResponse.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/ImportersPulpImportCheckApi.md

@@ -0,0 +1,62 @@
+# PulpContainerClient::ImportersPulpImportCheckApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pulp_import_check_post**](ImportersPulpImportCheckApi.md#pulp_import_check_post) | **POST** /pulp/api/v3/importers/core/pulp/import-check/ | Validate the parameters to be used for a PulpImport call
+
+
+
+## pulp_import_check_post
+
+> PulpImportCheckResponse pulp_import_check_post(pulp_import_check)
+
+Validate the parameters to be used for a PulpImport call
+
+Evaluates validity of proposed PulpImport parameters 'toc', 'path', and 'repo_mapping'.  * Checks that toc, path are in ALLOWED_IMPORT_PATHS * if ALLOWED:   * Checks that toc, path exist and are readable   * If toc specified, checks that containing dir is writeable * Checks that repo_mapping is valid JSON
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpImportCheckApi.new
+pulp_import_check = PulpContainerClient::PulpImportCheck.new # PulpImportCheck | 
+
+begin
+  #Validate the parameters to be used for a PulpImport call
+  result = api_instance.pulp_import_check_post(pulp_import_check)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpImportCheckApi->pulp_import_check_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_import_check** | [**PulpImportCheck**](PulpImportCheck.md)|  | 
+
+### Return type
+
+[**PulpImportCheckResponse**](PulpImportCheckResponse.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/ImportersPulpImportsApi.md

@@ -0,0 +1,241 @@
+# PulpContainerClient::ImportersPulpImportsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**importers_core_pulp_imports_create**](ImportersPulpImportsApi.md#importers_core_pulp_imports_create) | **POST** {pulp_importer_href}imports/ | Create a pulp import
+[**importers_core_pulp_imports_delete**](ImportersPulpImportsApi.md#importers_core_pulp_imports_delete) | **DELETE** {pulp_pulp_import_href} | Delete a pulp import
+[**importers_core_pulp_imports_list**](ImportersPulpImportsApi.md#importers_core_pulp_imports_list) | **GET** {pulp_importer_href}imports/ | List pulp imports
+[**importers_core_pulp_imports_read**](ImportersPulpImportsApi.md#importers_core_pulp_imports_read) | **GET** {pulp_pulp_import_href} | Inspect a pulp import
+
+
+
+## importers_core_pulp_imports_create
+
+> TaskGroupOperationResponse importers_core_pulp_imports_create(pulp_importer_href, pulp_import)
+
+Create a pulp import
+
+Trigger an asynchronous task to import a Pulp export.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpImportsApi.new
+pulp_importer_href = 'pulp_importer_href_example' # String | 
+pulp_import = PulpContainerClient::PulpImport.new # PulpImport | 
+
+begin
+  #Create a pulp import
+  result = api_instance.importers_core_pulp_imports_create(pulp_importer_href, pulp_import)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpImportsApi->importers_core_pulp_imports_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_importer_href** | **String**|  | 
+ **pulp_import** | [**PulpImport**](PulpImport.md)|  | 
+
+### Return type
+
+[**TaskGroupOperationResponse**](TaskGroupOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## importers_core_pulp_imports_delete
+
+> importers_core_pulp_imports_delete(pulp_pulp_import_href)
+
+Delete a pulp import
+
+ViewSet for PulpImports.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpImportsApi.new
+pulp_pulp_import_href = 'pulp_pulp_import_href_example' # String | 
+
+begin
+  #Delete a pulp import
+  api_instance.importers_core_pulp_imports_delete(pulp_pulp_import_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpImportsApi->importers_core_pulp_imports_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_pulp_import_href** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## importers_core_pulp_imports_list
+
+> PaginatedImportResponseList importers_core_pulp_imports_list(pulp_importer_href, opts)
+
+List pulp imports
+
+ViewSet for PulpImports.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpImportsApi.new
+pulp_importer_href = 'pulp_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'], # 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 imports
+  result = api_instance.importers_core_pulp_imports_list(pulp_importer_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpImportsApi->importers_core_pulp_imports_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_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** | [**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
+
+[**PaginatedImportResponseList**](PaginatedImportResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## importers_core_pulp_imports_read
+
+> ImportResponse importers_core_pulp_imports_read(pulp_pulp_import_href, opts)
+
+Inspect a pulp import
+
+ViewSet for PulpImports.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::ImportersPulpImportsApi.new
+pulp_pulp_import_href = 'pulp_pulp_import_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 import
+  result = api_instance.importers_core_pulp_imports_read(pulp_pulp_import_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling ImportersPulpImportsApi->importers_core_pulp_imports_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pulp_pulp_import_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
+
+[**ImportResponse**](ImportResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+