pulp_file_client 3.55.2 → 3.55.3

data/docs/UsersRolesApi.md

@@ -1,263 +0,0 @@
-# PulpFileClient::UsersRolesApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**users_roles_create**](UsersRolesApi.md#users_roles_create) | **POST** {auth_user_href}roles/ | Create an user role
-[**users_roles_delete**](UsersRolesApi.md#users_roles_delete) | **DELETE** {auth_users_user_role_href} | Delete an user role
-[**users_roles_list**](UsersRolesApi.md#users_roles_list) | **GET** {auth_user_href}roles/ | List user roles
-[**users_roles_read**](UsersRolesApi.md#users_roles_read) | **GET** {auth_users_user_role_href} | Inspect an user role
-
-
-
-## users_roles_create
-
-> UserRoleResponse users_roles_create(auth_user_href, user_role)
-
-Create an user role
-
-ViewSet for UserRole.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_file_client'
-# setup authorization
-PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpFileClient::UsersRolesApi.new
-auth_user_href = 'auth_user_href_example' # String | 
-user_role = PulpFileClient::UserRole.new # UserRole | 
-
-begin
-  #Create an user role
-  result = api_instance.users_roles_create(auth_user_href, user_role)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->users_roles_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
- **user_role** | [**UserRole**](UserRole.md)|  | 
-
-### Return type
-
-[**UserRoleResponse**](UserRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## users_roles_delete
-
-> users_roles_delete(auth_users_user_role_href)
-
-Delete an user role
-
-ViewSet for UserRole.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_file_client'
-# setup authorization
-PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpFileClient::UsersRolesApi.new
-auth_users_user_role_href = 'auth_users_user_role_href_example' # String | 
-
-begin
-  #Delete an user role
-  api_instance.users_roles_delete(auth_users_user_role_href)
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->users_roles_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_users_user_role_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## users_roles_list
-
-> PaginatedUserRoleResponseList users_roles_list(auth_user_href, opts)
-
-List user roles
-
-ViewSet for UserRole.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_file_client'
-# setup authorization
-PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpFileClient::UsersRolesApi.new
-auth_user_href = 'auth_user_href_example' # String | 
-opts = {
-  content_object: 'content_object_example', # String | content_object
-  domain: 'domain_example', # String | Foreign Key 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  * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (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 | 
-  role: 'role_example', # String | 
-  role__contains: 'role__contains_example', # String | 
-  role__icontains: 'role__icontains_example', # String | 
-  role__in: ['role__in_example'], # Array<String> | Multiple values may be separated by commas.
-  role__startswith: 'role__startswith_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 user roles
-  result = api_instance.users_roles_list(auth_user_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->users_roles_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
- **content_object** | **String**| content_object | [optional] 
- **domain** | [**String**](.md)| Foreign Key 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  * &#x60;role&#x60; - Role * &#x60;-role&#x60; - Role (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (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] 
- **role** | **String**|  | [optional] 
- **role__contains** | **String**|  | [optional] 
- **role__icontains** | **String**|  | [optional] 
- **role__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **role__startswith** | **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
-
-[**PaginatedUserRoleResponseList**](PaginatedUserRoleResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## users_roles_read
-
-> UserRoleResponse users_roles_read(auth_users_user_role_href, opts)
-
-Inspect an user role
-
-ViewSet for UserRole.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_file_client'
-# setup authorization
-PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpFileClient::UsersRolesApi.new
-auth_users_user_role_href = 'auth_users_user_role_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 an user role
-  result = api_instance.users_roles_read(auth_users_user_role_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->users_roles_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_users_user_role_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
-
-[**UserRoleResponse**](UserRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/VersionResponse.md

@@ -1,25 +0,0 @@
-# PulpFileClient::VersionResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**component** | **String** | Name of a versioned component of Pulp | 
-**version** | **String** | Version of the component (e.g. 3.0.0) | 
-**package** | **String** | Python package name providing the component | 
-**_module** | **String** | Python module name of the component | 
-**domain_compatible** | **Boolean** | Domain feature compatibility of component | 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::VersionResponse.new(component: null,
-                                 version: null,
-                                 package: null,
-                                 _module: null,
-                                 domain_compatible: null)
-```
-
-

data/docs/WorkerResponse.md

@@ -1,29 +0,0 @@
-# PulpFileClient::WorkerResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**name** | **String** | The name of the worker. | [optional] [readonly] 
-**last_heartbeat** | **DateTime** | Timestamp of the last time the worker talked to the service. | [optional] [readonly] 
-**versions** | **Hash<String, String>** | Versions of the components installed. | [optional] [readonly] 
-**current_task** | **String** | The task this worker is currently executing, or empty if the worker is not currently assigned to a task. | [optional] [readonly] 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::WorkerResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 last_heartbeat: null,
-                                 versions: null,
-                                 current_task: null)
-```
-
-

data/docs/WorkersApi.md

@@ -1,172 +0,0 @@
-# PulpFileClient::WorkersApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**workers_list**](WorkersApi.md#workers_list) | **GET** /pulp/api/v3/workers/ | List workers
-[**workers_read**](WorkersApi.md#workers_read) | **GET** {worker_href} | Inspect a worker
-
-
-
-## workers_list
-
-> PaginatedWorkerResponseList workers_list(opts)
-
-List workers
-
-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_file_client'
-# setup authorization
-PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpFileClient::WorkersApi.new
-opts = {
-  last_heartbeat: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_heartbeat matches value
-  last_heartbeat__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_heartbeat is greater than value
-  last_heartbeat__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_heartbeat is greater than or equal to value
-  last_heartbeat__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_heartbeat is less than value
-  last_heartbeat__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where last_heartbeat is less than or equal to value
-  last_heartbeat__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where last_heartbeat is between two comma separated values
-  limit: 56, # Integer | Number of results to return per page.
-  missing: true, # Boolean | 
-  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.
-  online: true, # Boolean | 
-  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) * `name` - Name * `-name` - Name (descending) * `last_heartbeat` - Last heartbeat * `-last_heartbeat` - Last heartbeat (descending) * `versions` - Versions * `-versions` - Versions (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 workers
-  result = api_instance.workers_list(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling WorkersApi->workers_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **last_heartbeat** | **DateTime**| Filter results where last_heartbeat matches value | [optional] 
- **last_heartbeat__gt** | **DateTime**| Filter results where last_heartbeat is greater than value | [optional] 
- **last_heartbeat__gte** | **DateTime**| Filter results where last_heartbeat is greater than or equal to value | [optional] 
- **last_heartbeat__lt** | **DateTime**| Filter results where last_heartbeat is less than value | [optional] 
- **last_heartbeat__lte** | **DateTime**| Filter results where last_heartbeat is less than or equal to value | [optional] 
- **last_heartbeat__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where last_heartbeat is between two comma separated values | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **missing** | **Boolean**|  | [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] 
- **online** | **Boolean**|  | [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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;last_heartbeat&#x60; - Last heartbeat * &#x60;-last_heartbeat&#x60; - Last heartbeat (descending) * &#x60;versions&#x60; - Versions * &#x60;-versions&#x60; - Versions (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
-
-[**PaginatedWorkerResponseList**](PaginatedWorkerResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## workers_read
-
-> WorkerResponse workers_read(worker_href, opts)
-
-Inspect a worker
-
-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_file_client'
-# setup authorization
-PulpFileClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpFileClient::WorkersApi.new
-worker_href = 'worker_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 worker
-  result = api_instance.workers_read(worker_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling WorkersApi->workers_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **worker_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
-
-[**WorkerResponse**](WorkerResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-