pulp_container_client 2.14.16 → 2.15.0

data/docs/PaginatedRoleResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedRoleResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<RoleResponse>**](RoleResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedRoleResponseList.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/PaginatedSigningServiceResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedSigningServiceResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<SigningServiceResponse>**](SigningServiceResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedSigningServiceResponseList.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/PaginatedTaskGroupResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedTaskGroupResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<TaskGroupResponse>**](TaskGroupResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedTaskGroupResponseList.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/PaginatedTaskResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedTaskResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<TaskResponse>**](TaskResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedTaskResponseList.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/PaginatedTaskScheduleResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedTaskScheduleResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<TaskScheduleResponse>**](TaskScheduleResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedTaskScheduleResponseList.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/PaginatedUploadResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedUploadResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<UploadResponse>**](UploadResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedUploadResponseList.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/PaginatedUserResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedUserResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<UserResponse>**](UserResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedUserResponseList.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/PaginatedUserRoleResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedUserRoleResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<UserRoleResponse>**](UserRoleResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedUserRoleResponseList.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/PaginatedWorkerResponseList.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PaginatedWorkerResponseList
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<WorkerResponse>**](WorkerResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PaginatedWorkerResponseList.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/PatchedAccessPolicy.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PatchedAccessPolicy
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**permissions_assignment** | **Array<Object>** | List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead. | [optional] 
-**creation_hooks** | **Array<Object>** | List of callables that may associate user roles for new objects. | [optional] 
-**statements** | **Array<Object>** | List of policy statements defining the policy. | [optional] 
-**queryset_scoping** | [**Object**](.md) | A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedAccessPolicy.new(permissions_assignment: null,
-                                 creation_hooks: null,
-                                 statements: null,
-                                 queryset_scoping: null)
-```
-
-

data/docs/PatchedContentRedirectContentGuard.md

@@ -1,19 +0,0 @@
-# PulpContainerClient::PatchedContentRedirectContentGuard
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The unique name. | [optional] 
-**description** | **String** | An optional description. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedContentRedirectContentGuard.new(name: null,
-                                 description: null)
-```
-
-

data/docs/PatchedFilesystemExporter.md

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

data/docs/PatchedGroup.md

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

data/docs/PatchedPulpExporter.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::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 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedPulpExporter.new(name: null,
-                                 path: null,
-                                 repositories: null,
-                                 last_export: null)
-```
-
-

data/docs/PatchedPulpImporter.md

@@ -1,19 +0,0 @@
-# PulpContainerClient::PatchedPulpImporter
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Unique name of the Importer. | [optional] 
-**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] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedPulpImporter.new(name: null,
-                                 repo_mapping: null)
-```
-
-

data/docs/PatchedRBACContentGuard.md

@@ -1,19 +0,0 @@
-# PulpContainerClient::PatchedRBACContentGuard
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The unique name. | [optional] 
-**description** | **String** | An optional description. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedRBACContentGuard.new(name: null,
-                                 description: null)
-```
-
-

data/docs/PatchedRole.md

@@ -1,21 +0,0 @@
-# PulpContainerClient::PatchedRole
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of this role. | [optional] 
-**description** | **String** | An optional description. | [optional] 
-**permissions** | **Array<String>** | List of permissions defining the role. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedRole.new(name: null,
-                                 description: null,
-                                 permissions: null)
-```
-
-

data/docs/PatchedTaskCancel.md

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

data/docs/PatchedUser.md

@@ -1,29 +0,0 @@
-# PulpContainerClient::PatchedUser
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | [optional] 
-**password** | **String** | Users password. Set to ``null`` to disable password authentication. | [optional] 
-**first_name** | **String** | First name | [optional] 
-**last_name** | **String** | Last name | [optional] 
-**email** | **String** | Email address | [optional] 
-**is_staff** | **Boolean** | Designates whether the user can log into this admin site. | [optional] [default to false]
-**is_active** | **Boolean** | Designates whether this user should be treated as active. | [optional] [default to true]
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PatchedUser.new(username: null,
-                                 password: null,
-                                 first_name: null,
-                                 last_name: null,
-                                 email: null,
-                                 is_staff: null,
-                                 is_active: null)
-```
-
-

data/docs/Policy762Enum.md

@@ -1,16 +0,0 @@
-# PulpContainerClient::Policy762Enum
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::Policy762Enum.new()
-```
-
-

data/docs/ProgressReportResponse.md

@@ -1,27 +0,0 @@
-# PulpContainerClient::ProgressReportResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **String** | The message shown to the user for the progress report. | [optional] [readonly] 
-**code** | **String** | Identifies the type of progress report'. | [optional] [readonly] 
-**state** | **String** | The current state of the progress report. The possible values are: 'waiting', 'skipped', 'running', 'completed', 'failed', 'canceled' and 'canceling'. The default is 'waiting'. | [optional] [readonly] 
-**total** | **Integer** | The total count of items. | [optional] [readonly] 
-**done** | **Integer** | The count of items already processed. Defaults to 0. | [optional] [readonly] 
-**suffix** | **String** | The suffix to be shown with the progress report. | [optional] [readonly] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::ProgressReportResponse.new(message: null,
-                                 code: null,
-                                 state: null,
-                                 total: null,
-                                 done: null,
-                                 suffix: null)
-```
-
-

data/docs/PublicationResponse.md

@@ -1,23 +0,0 @@
-# PulpContainerClient::PublicationResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**repository_version** | **String** |  | [optional] 
-**repository** | **String** | A URI of the repository to be published. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PublicationResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 repository_version: null,
-                                 repository: null)
-```
-
-

data/docs/PublicationsApi.md

@@ -1,92 +0,0 @@
-# PulpContainerClient::PublicationsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**publications_list**](PublicationsApi.md#publications_list) | **GET** /pulp/api/v3/publications/ | List publications
-
-
-
-## publications_list
-
-> PaginatedPublicationResponseList publications_list(opts)
-
-List publications
-
-A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
-
-### 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::PublicationsApi.new
-opts = {
-  content: 'content_example', # String | Content Unit referenced by HREF
-  content__in: 'content__in_example', # String | Content Unit referenced by HREF
-  limit: 56, # Integer | Number of results to return per page.
-  offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering
-  pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created matches value
-  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
-  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
-  pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
-  pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
-  pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
-  repository: 'repository_example', # String | Repository referenced by HREF
-  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
-  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 publications
-  result = api_instance.publications_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling PublicationsApi->publications_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content** | **String**| Content Unit referenced by HREF | [optional] 
- **content__in** | **String**| Content Unit referenced by HREF | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
- **pulp_created** | **DateTime**| Filter results where pulp_created matches value | [optional] 
- **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
- **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
- **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
- **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
- **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] 
- **repository** | **String**| Repository referenced by HREF | [optional] 
- **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [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
-
-[**PaginatedPublicationResponseList**](PaginatedPublicationResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/PulpExport.md

@@ -1,27 +0,0 @@
-# PulpContainerClient::PulpExport
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task** | **String** | A URI of the task that ran the Export. | [optional] 
-**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. A chunk has a maximum size of 1TB. | [optional] 
-**start_versions** | **Array<String>** | List of explicit last-exported-repo-version hrefs (replaces last_export). | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PulpExport.new(task: null,
-                                 full: null,
-                                 dry_run: null,
-                                 versions: null,
-                                 chunk_size: null,
-                                 start_versions: null)
-```
-
-

data/docs/PulpExportResponse.md

@@ -1,29 +0,0 @@
-# PulpContainerClient::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<String>** | 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] 
-**toc_info** | [**Object**](.md) | Filename and sha256-checksum of table-of-contents for this export | [optional] [readonly] 
-
-## Code Sample
-
-```ruby
-require 'PulpContainerClient'
-
-instance = PulpContainerClient::PulpExportResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 task: null,
-                                 exported_resources: null,
-                                 params: null,
-                                 output_file_info: null,
-                                 toc_info: null)
-```
-
-