pulpcore_client 3.5.0 → 3.6.0

data/docs/PatchedAccessPolicy.md

@@ -0,0 +1,21 @@
+# PulpcoreClient::PatchedAccessPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects. | [optional] 
+**statements** | **Array<Object>** | List of policy statements defining the policy. | [optional] 
+**viewset_name** | **String** | The name of ViewSet this AccessPolicy authorizes. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PatchedAccessPolicy.new(permissions_assignment: null,
+                                 statements: null,
+                                 viewset_name: null)
+```
+
+

data/docs/PatchedGroup.md

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

data/docs/PatchedPulpExporter.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PatchedPulpExporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the file system exporter. | [optional] 
+**path** | **String** | File system directory to store exported tar.gzs. | [optional] 
+**repositories** | **Array<String>** |  | [optional] 
+**last_export** | **String** | Last attempted export for this PulpExporter | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PatchedPulpExporter.new(name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PatchedPulpImporter.md

@@ -0,0 +1,19 @@
+# PulpcoreClient::PatchedPulpImporter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Unique name of the Importer. | [optional] 
+**repo_mapping** | [**Object**](.md) | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PatchedPulpImporter.new(name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/{TaskCancel.md → PatchedTaskCancel.md}

@@ -1,17 +1,17 @@
-# PulpcoreClient::TaskCancel
+# PulpcoreClient::PatchedTaskCancel
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**state** | **String** | The desired state of the task. Only 'canceled' is accepted. | 
+**state** | **String** | The desired state of the task. Only 'canceled' is accepted. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::TaskCancel.new(state: null)
+instance = PulpcoreClient::PatchedTaskCancel.new(state: null)
 ```
 
 

data/docs/PermissionResponse.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PermissionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **Object** |  | [optional] [readonly] 
+**id** | **Object** |  | [optional] [readonly] 
+**permission** | **String** |  | [optional] [readonly] 
+**obj** | **String** | Content object. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PermissionResponse.new(pulp_href: null,
+                                 id: null,
+                                 permission: null,
+                                 obj: null)
+```
+
+

data/docs/{ProgressReport.md → ProgressReportResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::ProgressReport
+# PulpcoreClient::ProgressReportResponse
 
 ## Properties
 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::ProgressReport.new(message: null,
+instance = PulpcoreClient::ProgressReportResponse.new(message: null,
                                  code: null,
                                  state: null,
                                  total: null,

data/docs/PulpExport.md

@@ -4,24 +4,24 @@
 
 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<Object>** | Resources that were exported. | [optional] [readonly] 
-**params** | [**Object**](.md) | Any additional parameters that were used to create the export. | [optional] [readonly] 
-**output_file_info** | [**Object**](.md) | Dictionary of filename: sha256hash entries for export-output-file(s) | [optional] [readonly] 
+**full** | **Boolean** | Do a Full (true) or Incremental (false) export. | [optional] [default to true]
+**dry_run** | **Boolean** | Generate report on what would be exported and disk-space required. | [optional] [default to false]
+**versions** | **Array<String>** | List of explicit repo-version hrefs to export (replaces current_version). | [optional] 
+**chunk_size** | **String** | Chunk export-tarfile into pieces of chunk_size bytes.Recognizes units of B/KB/MB/GB/TB. | [optional] 
+**start_versions** | **Array<String>** | List of explicit last-exported-repo-version hrefs (replaces last_export). | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::PulpExport.new(pulp_href: null,
-                                 pulp_created: null,
-                                 task: null,
-                                 exported_resources: null,
-                                 params: null,
-                                 output_file_info: null)
+instance = PulpcoreClient::PulpExport.new(task: null,
+                                 full: null,
+                                 dry_run: null,
+                                 versions: null,
+                                 chunk_size: null,
+                                 start_versions: null)
 ```
 
 

data/docs/PulpExportResponse.md

@@ -0,0 +1,27 @@
+# PulpcoreClient::PulpExportResponse
+
+## 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<Object>** | Resources that were exported. | [optional] [readonly] 
+**params** | [**Object**](.md) | Any additional parameters that were used to create the export. | [optional] [readonly] 
+**output_file_info** | [**Object**](.md) | Dictionary of filename: sha256hash entries for export-output-file(s) | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpExportResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 exported_resources: null,
+                                 params: null,
+                                 output_file_info: null)
+```
+
+

data/docs/PulpExporter.md

@@ -4,8 +4,6 @@
 
 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 directory to store exported tar.gzs. | 
 **repositories** | **Array<String>** |  | 
@@ -16,9 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::PulpExporter.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
+instance = PulpcoreClient::PulpExporter.new(name: null,
                                  path: null,
                                  repositories: null,
                                  last_export: null)

data/docs/PulpExporterResponse.md

@@ -0,0 +1,27 @@
+# PulpcoreClient::PulpExporterResponse
+
+## 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 directory to store exported tar.gzs. | 
+**repositories** | **Array<String>** |  | 
+**last_export** | **String** | Last attempted export for this PulpExporter | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpExporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 path: null,
+                                 repositories: null,
+                                 last_export: null)
+```
+
+

data/docs/PulpImport.md

@@ -4,14 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**path** | **String** | Path to export that will be imported. | 
+**path** | **String** | Path to export that will be imported. | [optional] 
+**toc** | **String** | Path to a table-of-contents file describing chunks to be validated, reassembled, and imported. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::PulpImport.new(path: null)
+instance = PulpcoreClient::PulpImport.new(path: null,
+                                 toc: null)
 ```
 
 

data/docs/PulpImporter.md

@@ -4,19 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
 **name** | **String** | Unique name of the Importer. | 
-**repo_mapping** | **Hash<String, String>** | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
+**repo_mapping** | [**Object**](.md) | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::PulpImporter.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
+instance = PulpcoreClient::PulpImporter.new(name: null,
                                  repo_mapping: null)
 ```
 

data/docs/PulpImporterResponse.md

@@ -0,0 +1,23 @@
+# PulpcoreClient::PulpImporterResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**name** | **String** | Unique name of the Importer. | 
+**repo_mapping** | [**Object**](.md) | Mapping of repo names in an export file to the repo names in Pulp. For example, if the export has a repo named 'foo' and the repo to import content into was 'bar', the mapping would be \"{'foo': 'bar'}\". | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::PulpImporterResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 name: null,
+                                 repo_mapping: null)
+```
+
+

data/docs/{RedisConnection.md → RedisConnectionResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::RedisConnection
+# PulpcoreClient::RedisConnectionResponse
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::RedisConnection.new(connected: null)
+instance = PulpcoreClient::RedisConnectionResponse.new(connected: null)
 ```
 
 

data/docs/{SigningService.md → SigningServiceResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::SigningService
+# PulpcoreClient::SigningServiceResponse
 
 ## Properties
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::SigningService.new(pulp_href: null,
+instance = PulpcoreClient::SigningServiceResponse.new(pulp_href: null,
                                  pulp_created: null,
                                  name: null,
                                  script: null)

data/docs/SigningServicesApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 ## list
 
-> InlineResponse2005 list(opts)
+> InlineResponse2009 list(opts)
 
 List signing services
 
@@ -24,17 +24,17 @@ A ViewSet that supports browsing of existing signing services.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::SigningServicesApi.new
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
-  name: 'name_example', # String | 
   limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | name
   offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering 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.
 }
@@ -53,20 +53,20 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
- **name** | **String**|  | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| name | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering 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
 
-[**InlineResponse2005**](InlineResponse2005.md)
+[**InlineResponse2009**](InlineResponse2009.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -76,7 +76,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> SigningService read(signing_service_href, opts)
+> SigningServiceResponse read(signing_service_href, opts)
 
 Inspect a signing service
 
@@ -89,13 +89,13 @@ A ViewSet that supports browsing of existing signing services.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::SigningServicesApi.new
-signing_service_href = 'signing_service_href_example' # String | URI of Signing Service. e.g.: /pulp/api/v3/signing-services/1/
+signing_service_href = 'signing_service_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.
@@ -115,17 +115,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **signing_service_href** | **String**| URI of Signing Service. e.g.: /pulp/api/v3/signing-services/1/ | 
+ **signing_service_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
 
-[**SigningService**](SigningService.md)
+[**SigningServiceResponse**](SigningServiceResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/StatusApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**status_read**](StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
+[**read**](StatusApi.md#read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
 
 
 
-## status_read
+## read
 
-> Status status_read(opts)
+> StatusResponse read
 
 Inspect status of Pulp
 
@@ -21,43 +21,29 @@ Returns app information including the version of pulpcore and loaded pulp plugin
 ```ruby
 # load the gem
 require 'pulpcore_client'
-# setup authorization
-PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
 
 api_instance = PulpcoreClient::StatusApi.new
-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 status of Pulp
-  result = api_instance.status_read(opts)
+  result = api_instance.read
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling StatusApi->status_read: #{e}"
+  puts "Exception when calling StatusApi->read: #{e}"
 end
 ```
 
 ### Parameters
 
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **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] 
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**Status**](Status.md)
+[**StatusResponse**](StatusResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+No authorization required
 
 ### HTTP request headers
 

data/docs/StatusResponse.md

@@ -0,0 +1,27 @@
+# PulpcoreClient::StatusResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**versions** | [**Array<VersionResponse>**](VersionResponse.md) | Version information of Pulp components | 
+**online_workers** | [**Array<WorkerResponse>**](WorkerResponse.md) | List of online workers known to the application. An online worker is actively heartbeating and can respond to new work | 
+**online_content_apps** | [**Array<ContentAppStatusResponse>**](ContentAppStatusResponse.md) | List of online content apps known to the application. An online content app is actively heartbeating and can serve data to clients | 
+**database_connection** | [**DatabaseConnectionResponse**](DatabaseConnectionResponse.md) | Database connection information | 
+**redis_connection** | [**RedisConnectionResponse**](RedisConnectionResponse.md) | Redis connection information | 
+**storage** | [**StorageResponse**](StorageResponse.md) | Storage information | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::StatusResponse.new(versions: null,
+                                 online_workers: null,
+                                 online_content_apps: null,
+                                 database_connection: null,
+                                 redis_connection: null,
+                                 storage: null)
+```
+
+

data/docs/{Storage.md → StorageResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::Storage
+# PulpcoreClient::StorageResponse
 
 ## Properties
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::Storage.new(total: null,
+instance = PulpcoreClient::StorageResponse.new(total: null,
                                  used: null,
                                  free: null)
 ```

data/docs/{TaskGroup.md → TaskGroupResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::TaskGroup
+# PulpcoreClient::TaskGroupResponse
 
 ## Properties
 
@@ -13,14 +13,14 @@ Name | Type | Description | Notes
 **completed** | **Integer** | Number of tasks in the 'completed' state | [optional] [readonly] 
 **canceled** | **Integer** | Number of tasks in the 'canceled' state | [optional] [readonly] 
 **failed** | **Integer** | Number of tasks in the 'failed' state | [optional] [readonly] 
-**group_progress_reports** | [**Array<GroupProgressReport>**](GroupProgressReport.md) |  | [optional] [readonly] 
+**group_progress_reports** | [**Array<GroupProgressReportResponse>**](GroupProgressReportResponse.md) |  | [optional] [readonly] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::TaskGroup.new(pulp_href: null,
+instance = PulpcoreClient::TaskGroupResponse.new(pulp_href: null,
                                  description: null,
                                  all_tasks_dispatched: null,
                                  waiting: null,